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 
45  // ---------------------------------------------------------------------- //
47  // ---------------------------------------------------------------------- //
48 
49  USDIMAGING_API
50  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
51 
52  USDIMAGING_API
53  TfToken GetImagingSubprimType(UsdPrim const& prim, TfToken const& subprim)
54  override;
55 
56  USDIMAGING_API
57  HdContainerDataSourceHandle GetImagingSubprimData(
58  UsdPrim const& prim,
59  TfToken const& subprim,
60  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
61 
62  USDIMAGING_API
63  HdDataSourceLocatorSet InvalidateImagingSubprim(
64  UsdPrim const& prim,
65  TfToken const& subprim,
66  TfTokenVector const& properties) override;
67 
68  // ---------------------------------------------------------------------- //
70  // ---------------------------------------------------------------------- //
71 
72 
74  UsdPrim const& prim,
75  UsdImagingIndexProxy* index,
77  instancerContext = nullptr) override;
78 
79  bool IsSupported(UsdImagingIndexProxy const* index) const override;
80 
81  void UpdateForTime(
82  UsdPrim const& prim,
83  SdfPath const& cachePath,
84  UsdTimeCode time,
85  HdDirtyBits requestedBits,
87  instancerContext = nullptr) const override;
88 
89  VtValue Get(UsdPrim const& prim,
90  SdfPath const& cachePath,
91  TfToken const& key,
92  UsdTimeCode time,
93  VtIntArray *outIndices) const override;
94 
95  HdDirtyBits ProcessPropertyChange(
96  UsdPrim const& prim,
97  SdfPath const& cachePath,
98  TfToken const& propertyName) override;
99 
100 
101  USDIMAGING_API
102  virtual void MarkDirty(UsdPrim const& prim,
103  SdfPath const& cachePath,
104  HdDirtyBits dirty,
105  UsdImagingIndexProxy* index) override;
106 
107  USDIMAGING_API
108  virtual void MarkTransformDirty(UsdPrim const& prim,
109  SdfPath const& cachePath,
110  UsdImagingIndexProxy* index) override;
111 
112  USDIMAGING_API
113  virtual void MarkVisibilityDirty(UsdPrim const& prim,
114  SdfPath const& cachePath,
115  UsdImagingIndexProxy* index) override;
116 
117  USDIMAGING_API
118  void TrackVariability(UsdPrim const& prim,
119  SdfPath const& cachePath,
120  HdDirtyBits* timeVaryingBits,
122  instancerContext = nullptr) const override;
123 
124 protected:
125 
126  USDIMAGING_API
127  virtual void _RemovePrim(SdfPath const& cachePath,
128  UsdImagingIndexProxy* index) override;
129 
130 private:
131 
132  TfToken _GetHydraPrimType(UsdPrim const& prim);
133 
134 
135 };
136 
137 PXR_NAMESPACE_CLOSE_SCOPE
138 
139 #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
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
Represents a set of data source locators closed under descendancy.
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: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
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:668
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166