representedByAncestorPrimAdapter.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_REPRESENTED_BY_ANCESTOR_PRIM_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_REPRESENTED_BY_ANCESTOR_PRIM_ADAPTER_H
26 
28 
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
42 {
43 public:
44 
46 
49  {}
50 
51  // ---------------------------------------------------------------------- //
53  // ---------------------------------------------------------------------- //
54 
56 
57  // ---------------------------------------------------------------------- //
59  // ---------------------------------------------------------------------- //
60 
62  UsdPrim const& prim,
63  UsdImagingIndexProxy* index,
65  instancerContext = nullptr) override;
66 
68  UsdPrim const& prim,
69  SdfPath const& cachePath,
70  HdDirtyBits* timeVaryingBits,
71  UsdImagingInstancerContext const* instancerContext = nullptr)
72  const override
73  {}
74 
76  UsdPrim const& prim,
77  SdfPath const& cachePath,
78  UsdTimeCode time,
79  HdDirtyBits requestedBits,
80  UsdImagingInstancerContext const* instancerContext = nullptr)
81  const override
82  {}
83 
84  HdDirtyBits ProcessPropertyChange(
85  UsdPrim const& prim,
86  SdfPath const& cachePath,
87  TfToken const& propertyName) override;
88 
89  void MarkDirty(
90  UsdPrim const& prim,
91  SdfPath const& cachePath,
92  HdDirtyBits dirty,
93  UsdImagingIndexProxy* index) override
94  {}
95 
96 protected:
97  void _RemovePrim(
98  SdfPath const& cachePath,
99  UsdImagingIndexProxy* index) override
100  {}
101 
102 };
103 
104 PXR_NAMESPACE_CLOSE_SCOPE
105 
106 #endif // PXR_USD_IMAGING_USD_IMAGING_REPRESENTED_BY_ANCESTOR_PRIM_ADAPTER_H
Base class for all prim adapters which only want to indicate that an ancestor prim is responsible for...
SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
PopulationMode GetPopulationMode() override
Returns the prim's behavior with regard to population and invalidation.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
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 ...
void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
For the given prim, variability is detected and stored in timeVaryingBits.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:84
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:135
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Populates the cache for the given prim, time and requestedBits.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...