generativeProceduralAdapter.h
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_PROC_IMAGING_GENERATIVE_PROCEDURAL_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_PROC_IMAGING_GENERATIVE_PROCEDURAL_ADAPTER_H
26 
28 #include "pxr/usd/usdProc/tokens.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 class UsdProcImagingGenerativeProceduralAdapter
33  : public UsdImagingPrimAdapter
34 {
35 public:
36  using BaseAdapter = UsdImagingPrimAdapter;
37  UsdProcImagingGenerativeProceduralAdapter()
39  {
40  /* Nothing */
41  }
42 
43  ~UsdProcImagingGenerativeProceduralAdapter() override = default;
44 
46  UsdPrim const& prim,
47  UsdImagingIndexProxy* index,
49  instancerContext = nullptr) override;
50 
51  bool IsSupported(UsdImagingIndexProxy const* index) const override;
52 
53  void UpdateForTime(
54  UsdPrim const& prim,
55  SdfPath const& cachePath,
56  UsdTimeCode time,
57  HdDirtyBits requestedBits,
59  instancerContext = nullptr) const override;
60 
61  VtValue Get(UsdPrim const& prim,
62  SdfPath const& cachePath,
63  TfToken const& key,
64  UsdTimeCode time,
65  VtIntArray *outIndices) const override;
66 
67  HdDirtyBits ProcessPropertyChange(
68  UsdPrim const& prim,
69  SdfPath const& cachePath,
70  TfToken const& propertyName) override;
71 
72 
73  USDIMAGING_API
74  virtual void MarkDirty(UsdPrim const& prim,
75  SdfPath const& cachePath,
76  HdDirtyBits dirty,
77  UsdImagingIndexProxy* index) override;
78 
79  USDIMAGING_API
80  virtual void MarkTransformDirty(UsdPrim const& prim,
81  SdfPath const& cachePath,
82  UsdImagingIndexProxy* index) override;
83 
84  USDIMAGING_API
85  virtual void MarkVisibilityDirty(UsdPrim const& prim,
86  SdfPath const& cachePath,
87  UsdImagingIndexProxy* index) override;
88 
89  USDIMAGING_API
90  void TrackVariability(UsdPrim const& prim,
91  SdfPath const& cachePath,
92  HdDirtyBits* timeVaryingBits,
94  instancerContext = nullptr) const override;
95 
96 protected:
97 
98  USDIMAGING_API
99  virtual void _RemovePrim(SdfPath const& cachePath,
100  UsdImagingIndexProxy* index) override;
101 };
102 
103 PXR_NAMESPACE_CLOSE_SCOPE
104 
105 #endif // PXR_USD_IMAGING_USD_PROC_IMAGING_GENERATIVE_PROCEDURAL_ADAPTER_H
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const =0
Populates the cache for the given prim, time and requestedBits.
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
Base class for all PrimAdapters.
Definition: primAdapter.h:67
virtual void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const =0
For the given prim, variability is detected and stored in timeVaryingBits.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
virtual HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)=0
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr)=0
Called to populate the RenderIndex for this UsdPrim.
virtual USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
virtual bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Definition: primAdapter.h:623
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166