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 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdPrim;
37 
43 {
44 public:
46 
49  {}
50 
51  USDIMAGING_API
53 
54  // ---------------------------------------------------------------------- //
56  // ---------------------------------------------------------------------- //
57 
58  USDIMAGING_API
59  TfTokenVector GetImagingSubprims() override;
60 
61  USDIMAGING_API
62  TfToken GetImagingSubprimType(TfToken const& subprim) override;
63 
64  USDIMAGING_API
65  HdContainerDataSourceHandle GetImagingSubprimData(
66  TfToken const& subprim,
67  UsdPrim const& prim,
68  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
69 
70  USDIMAGING_API
71  HdDataSourceLocatorSet InvalidateImagingSubprim(
72  TfToken const& subprim,
73  TfTokenVector const& properties) override;
74 
75  // ---------------------------------------------------------------------- //
77  // ---------------------------------------------------------------------- //
78 
79  USDIMAGING_API
80  SdfPath Populate(UsdPrim const& prim,
81  UsdImagingIndexProxy* index,
83  instancerContext = NULL) override;
84 
85  USDIMAGING_API
86  bool IsSupported(UsdImagingIndexProxy const* index) const override;
87 
88  // ---------------------------------------------------------------------- //
90  // ---------------------------------------------------------------------- //
91 
93  USDIMAGING_API
94  void TrackVariability(UsdPrim const& prim,
95  SdfPath const& cachePath,
96  HdDirtyBits* timeVaryingBits,
98  instancerContext = NULL) const override;
99 
100 
102  USDIMAGING_API
103  void UpdateForTime(UsdPrim const& prim,
104  SdfPath const& cachePath,
105  UsdTimeCode time,
106  HdDirtyBits requestedBits,
108  instancerContext = NULL) const override;
109 
110  // ---------------------------------------------------------------------- //
112  // ---------------------------------------------------------------------- //
113 
114  USDIMAGING_API
115  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
116  SdfPath const& cachePath,
117  TfToken const& propertyName) override;
118 
119  USDIMAGING_API
120  void MarkDirty(UsdPrim const& prim,
121  SdfPath const& cachePath,
122  HdDirtyBits dirty,
123  UsdImagingIndexProxy* index) override;
124 
125  USDIMAGING_API
126  void MarkTransformDirty(UsdPrim const& prim,
127  SdfPath const& cachePath,
128  UsdImagingIndexProxy* index) override;
129 
130  USDIMAGING_API
131  void MarkWindowPolicyDirty(UsdPrim const& prim,
132  SdfPath const& cachePath,
133  UsdImagingIndexProxy* index) override;
134 
135  // ---------------------------------------------------------------------- //
137  // ---------------------------------------------------------------------- //
138 
139  USDIMAGING_API
140  VtValue Get(UsdPrim const& prim,
141  SdfPath const& cachePath,
142  TfToken const& key,
143  UsdTimeCode time,
144  VtIntArray *outIndices) const override;
145 
146 protected:
147  void _RemovePrim(SdfPath const& cachePath,
148  UsdImagingIndexProxy* index) override;
149 
150 };
151 
152 
153 PXR_NAMESPACE_CLOSE_SCOPE
154 
155 #endif // PXR_USD_IMAGING_USD_IMAGING_CAMERA_ADAPTER_H
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Delegate support for UsdGeomCamera.
Definition: cameraAdapter.h:42
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
This class is used as a context object with global stage information, that gets passed down to dataso...
Base class for all PrimAdapters.
Definition: primAdapter.h:67
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Represents a set of data source locators closed under descendancy.
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166