HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
freeCameraSceneDelegate.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HDX_FREE_CAMERA_SCENE_DELEGATE_H
25 #define PXR_IMAGING_HDX_FREE_CAMERA_SCENE_DELEGATE_H
26 
27 #include "pxr/pxr.h"
28 
29 #include "pxr/imaging/hdx/api.h"
30 
32 #include "pxr/base/gf/camera.h"
34 
36 
37 /// \class HdxFreeCameraSceneDelegate
38 ///
39 /// A simple scene delegate adding a camera prim to the given
40 /// render index.
41 ///
43 {
44 public:
45  /// Constructs delegate and adds camera to render index if
46  /// cameras are supported by render delegate.
47  HDX_API
49  SdfPath const &delegateId);
50 
51  HDX_API
52  ~HdxFreeCameraSceneDelegate() override;
53 
54  /// Path of added camera (in render index). Empty if cameras are not
55  /// supported by render delegate.
56  const SdfPath &GetCameraId() const {
57  return _cameraId;
58  }
59 
60  /// Set state of camera from GfCamera.
61  HDX_API
62  void SetCamera(const GfCamera &camera);
63  /// Set window policy of camera.
64  HDX_API
66 
67  /// For transition, set camera state from OpenGL-style
68  /// view and projection matrix. GfCamera is preferred.
69  HDX_API
70  void SetMatrices(GfMatrix4d const &viewMatrix,
71  GfMatrix4d const &projMatrix);
72 
73  /// For transition, set clip planes for camera. GfCamera is preferred.
74  HDX_API
75  void SetClipPlanes(std::vector<GfVec4f> const &clipPlanes);
76 
77  // HdSceneDelegate interface
78  HDX_API
79  GfMatrix4d GetTransform(SdfPath const &id) override;
80  HDX_API
82  TfToken const &key) override;
83 
84 private:
85  // Mark camera dirty in render index.
86  void _MarkDirty(HdDirtyBits bits);
87 
88  // Path of camera in render index.
89  const SdfPath _cameraId;
90 
91  // State of camera
92  GfCamera _camera;
93  // Window policy of camera.
95 };
96 
98 
99 #endif // PXR_IMAGING_HDX_FREE_CAMERA_SCENE_DELEGATE_H
HDX_API ~HdxFreeCameraSceneDelegate() override
const SdfPath & GetCameraId() const
hboost::math::policies::policy< hboost::math::policies::domain_error< hboost::math::policies::ignore_error >, hboost::math::policies::pole_error< hboost::math::policies::ignore_error >, hboost::math::policies::overflow_error< hboost::math::policies::ignore_error >, hboost::math::policies::underflow_error< hboost::math::policies::ignore_error >, hboost::math::policies::denorm_error< hboost::math::policies::ignore_error >, hboost::math::policies::rounding_error< hboost::math::policies::ignore_error >, hboost::math::policies::evaluation_error< hboost::math::policies::ignore_error >, hboost::math::policies::indeterminate_result_error< hboost::math::policies::ignore_error > > policy
Definition: SYS_MathCbrt.h:35
Object-based representation of a camera.
Definition: camera.h:49
uint32_t HdDirtyBits
Definition: types.h:158
#define HDX_API
Definition: api.h:40
Definition: token.h:87
HDX_API void SetClipPlanes(std::vector< GfVec4f > const &clipPlanes)
For transition, set clip planes for camera. GfCamera is preferred.
HDX_API void SetCamera(const GfCamera &camera)
Set state of camera from GfCamera.
HDX_API GfMatrix4d GetTransform(SdfPath const &id) override
Returns the object space transform, including all parent transforms.
Definition: path.h:290
HDX_API void SetMatrices(GfMatrix4d const &viewMatrix, GfMatrix4d const &projMatrix)
HDX_API VtValue GetCameraParamValue(SdfPath const &id, TfToken const &key) override
CameraUtilConformWindowPolicy
Definition: conformWindow.h:44
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
HDX_API void SetWindowPolicy(CameraUtilConformWindowPolicy policy)
Set window policy of camera.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: value.h:166
HDX_API HdxFreeCameraSceneDelegate(HdRenderIndex *renderIndex, SdfPath const &delegateId)