renderSettingsAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2022 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_RENDER_SETTINGS_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_RENDER_SETTINGS_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
41 public:
43 
46  {}
47 
48  USDIMAGING_API
50 
51  // ---------------------------------------------------------------------- //
53  // ---------------------------------------------------------------------- //
54 
55  USDIMAGING_API
56  SdfPath Populate(UsdPrim const& prim,
57  UsdImagingIndexProxy* index,
59  instancerContext = nullptr) override;
60 
61  USDIMAGING_API
62  bool IsSupported(UsdImagingIndexProxy const* index) const override;
63 
64  // ---------------------------------------------------------------------- //
66  // ---------------------------------------------------------------------- //
67 
69  USDIMAGING_API
70  void TrackVariability(UsdPrim const& prim,
71  SdfPath const& cachePath,
72  HdDirtyBits* timeVaryingBits,
74  instancerContext = nullptr) const override;
75 
76 
78  USDIMAGING_API
79  void UpdateForTime(UsdPrim const& prim,
80  SdfPath const& cachePath,
81  UsdTimeCode time,
82  HdDirtyBits requestedBits,
84  instancerContext = nullptr) const override;
85 
86  // ---------------------------------------------------------------------- //
88  // ---------------------------------------------------------------------- //
89 
92  USDIMAGING_API
93  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
94  SdfPath const& cachePath,
95  TfToken const& propertyName) override;
96 
97  USDIMAGING_API
98  void MarkDirty(UsdPrim const& prim,
99  SdfPath const& cachePath,
100  HdDirtyBits dirty,
101  UsdImagingIndexProxy* index) override;
102 
103  // ---------------------------------------------------------------------- //
105  // ---------------------------------------------------------------------- //
106 
107  USDIMAGING_API
108  VtValue Get(UsdPrim const& prim,
109  SdfPath const& cachePath,
110  TfToken const& key,
111  UsdTimeCode time,
112  VtIntArray *outIndices) const override;
113 
114 protected:
115  USDIMAGING_API
116  void _RemovePrim(SdfPath const& cachePath,
117  UsdImagingIndexProxy* index) override;
118 
119 };
120 
121 
122 PXR_NAMESPACE_CLOSE_SCOPE
123 
124 #endif // PXR_USD_IMAGING_USD_IMAGING_RENDER_SETTINGS_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=nullptr) const override
Thread Safe.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Delegate support for UsdRenderSettings.
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
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
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...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) 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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be udpated, or HdChangeTracker::AllDirty if the entire prim must ...