HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cameraAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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_USD_IMAGING_USD_IMAGING_CAMERA_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_CAMERA_ADAPTER_H
26 
27 /// \file usdImaging/cameraAdapter.h
28 
29 #include "pxr/pxr.h"
32 
34 
35 
36 class UsdPrim;
37 
38 /// \class UsdImagingCameraAdapter
39 ///
40 /// Delegate support for UsdGeomCamera.
41 ///
43 {
44 public:
46 
49  {}
50 
52  ~UsdImagingCameraAdapter() override;
53 
54  // ---------------------------------------------------------------------- //
55  /// \name Scene Index Support
56  // ---------------------------------------------------------------------- //
57 
59  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
60 
63  UsdPrim const& prim,
64  TfToken const& subprim) override;
65 
67  HdContainerDataSourceHandle GetImagingSubprimData(
68  UsdPrim const& prim,
69  TfToken const& subprim,
70  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
71 
74  UsdPrim const& prim,
75  TfToken const& subprim,
76  TfTokenVector const& properties,
77  UsdImagingPropertyInvalidationType invalidationType) override;
78 
79  // ---------------------------------------------------------------------- //
80  /// \name Initialization
81  // ---------------------------------------------------------------------- //
82 
84  SdfPath Populate(UsdPrim const& prim,
87  instancerContext = NULL) override;
88 
90  bool IsSupported(UsdImagingIndexProxy const* index) const override;
91 
92  // ---------------------------------------------------------------------- //
93  /// \name Parallel Setup and Resolve
94  // ---------------------------------------------------------------------- //
95 
96  /// Thread Safe.
98  void TrackVariability(UsdPrim const& prim,
99  SdfPath const& cachePath,
100  HdDirtyBits* timeVaryingBits,
102  instancerContext = NULL) const override;
103 
104 
105  /// Thread Safe.
107  void UpdateForTime(UsdPrim const& prim,
108  SdfPath const& cachePath,
110  HdDirtyBits requestedBits,
112  instancerContext = NULL) const override;
113 
114  // ---------------------------------------------------------------------- //
115  /// \name Change Processing
116  // ---------------------------------------------------------------------- //
117 
120  SdfPath const& cachePath,
121  TfToken const& propertyName) override;
122 
124  void MarkDirty(UsdPrim const& prim,
125  SdfPath const& cachePath,
126  HdDirtyBits dirty,
127  UsdImagingIndexProxy* index) override;
128 
130  void MarkTransformDirty(UsdPrim const& prim,
131  SdfPath const& cachePath,
132  UsdImagingIndexProxy* index) override;
133 
135  void MarkWindowPolicyDirty(UsdPrim const& prim,
136  SdfPath const& cachePath,
137  UsdImagingIndexProxy* index) override;
138 
139  // ---------------------------------------------------------------------- //
140  /// \name Data access
141  // ---------------------------------------------------------------------- //
142 
144  VtValue Get(UsdPrim const& prim,
145  SdfPath const& cachePath,
146  TfToken const& key,
148  VtIntArray *outIndices) const override;
149 
150 protected:
151  void _RemovePrim(SdfPath const& cachePath,
152  UsdImagingIndexProxy* index) override;
153 
154 };
155 
156 
158 
159 #endif // PXR_USD_IMAGING_USD_IMAGING_CAMERA_ADAPTER_H
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
#define USDIMAGING_API
Definition: api.h:40
GT_API const UT_StringHolder time
uint32_t HdDirtyBits
Definition: types.h:158
USDIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData(UsdPrim const &prim, TfToken const &subprim, const UsdImagingDataSourceStageGlobals &stageGlobals) override
USDIMAGING_API void MarkWindowPolicyDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
USDIMAGING_API TfToken GetImagingSubprimType(UsdPrim const &prim, TfToken const &subprim) override
USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Definition: token.h:87
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim(UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
Definition: prim.h:135
USDIMAGING_API ~UsdImagingCameraAdapter() override
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:291
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API void MarkDirty(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index) override
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
USDIMAGING_API TfTokenVector GetImagingSubprims(UsdPrim const &prim) override
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
GLuint index
Definition: glcorearb.h:786
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
void _RemovePrim(SdfPath const &cachePath, UsdImagingIndexProxy *index) override
Provides to paramName->UsdAttribute value mappings.
Definition: value.h:167
UsdImagingPropertyInvalidationType
Definition: types.h:34
USDIMAGING_API void MarkTransformDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override