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 USDIMAGING_CAMERA_ADAPTER_H
25 #define USDIMAGING_CAMERA_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/usdImaging/usdImaging/primAdapter.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdPrim;
37 
43 public:
45 
48  {}
49 
50  USDIMAGING_API
52 
53  USDIMAGING_API
54  SdfPath Populate(UsdPrim const& prim,
55  UsdImagingIndexProxy* index,
57  instancerContext = NULL) override;
58 
59  USDIMAGING_API
60  bool IsSupported(UsdImagingIndexProxy const* index) const override;
61 
62  // ---------------------------------------------------------------------- //
64  // ---------------------------------------------------------------------- //
65 
67  USDIMAGING_API
68  void TrackVariability(UsdPrim const& prim,
69  SdfPath const& cachePath,
70  HdDirtyBits* timeVaryingBits,
72  instancerContext = NULL) const override;
73 
74 
76  USDIMAGING_API
77  void UpdateForTime(UsdPrim const& prim,
78  SdfPath const& cachePath,
79  UsdTimeCode time,
80  HdDirtyBits requestedBits,
82  instancerContext = NULL) const override;
83 
84  // ---------------------------------------------------------------------- //
86  // ---------------------------------------------------------------------- //
87 
88  USDIMAGING_API
89  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
90  SdfPath const& cachePath,
91  TfToken const& propertyName) override;
92 
93  USDIMAGING_API
94  void MarkDirty(UsdPrim const& prim,
95  SdfPath const& cachePath,
96  HdDirtyBits dirty,
97  UsdImagingIndexProxy* index) override;
98 
99  USDIMAGING_API
100  void MarkTransformDirty(UsdPrim const& prim,
101  SdfPath const& cachePath,
102  UsdImagingIndexProxy* index) override;
103 
104  USDIMAGING_API
105  void MarkWindowPolicyDirty(UsdPrim const& prim,
106  SdfPath const& cachePath,
107  UsdImagingIndexProxy* index) override;
108 
109 protected:
110  void _RemovePrim(SdfPath const& cachePath,
111  UsdImagingIndexProxy* index) override;
112 
113 };
114 
115 
116 PXR_NAMESPACE_CLOSE_SCOPE
117 
118 #endif // USDIMAGING_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:89
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
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.
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:131
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
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.