gprimAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_GPRIM_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_GPRIM_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 #include "pxr/usd/usdGeom/xformCache.h"
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 
38 class UsdGeomGprim;
39 
49 {
50 public:
52 
55  {}
56 
57  USDIMAGING_API
58  ~UsdImagingGprimAdapter() override;
59 
60  // ---------------------------------------------------------------------- //
62  // ---------------------------------------------------------------------- //
63 
65  USDIMAGING_API
66  void TrackVariability(UsdPrim const& prim,
67  SdfPath const& cachePath,
68  HdDirtyBits* timeVaryingBits,
70  instancerContext = nullptr) const override;
71 
73  USDIMAGING_API
74  void UpdateForTime(UsdPrim const& prim,
75  SdfPath const& cachePath,
76  UsdTimeCode time,
77  HdDirtyBits requestedBits,
79  instancerContext = nullptr) const override;
80 
81  // ---------------------------------------------------------------------- //
83  // ---------------------------------------------------------------------- //
84 
85  USDIMAGING_API
86  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
87  SdfPath const& cachePath,
88  TfToken const& property) override;
89 
90  USDIMAGING_API
91  virtual void MarkDirty(UsdPrim const& prim,
92  SdfPath const& cachePath,
93  HdDirtyBits dirty,
94  UsdImagingIndexProxy* index) override;
95 
96  USDIMAGING_API
97  virtual void MarkRefineLevelDirty(UsdPrim const& prim,
98  SdfPath const& cachePath,
99  UsdImagingIndexProxy* index) override;
100 
101  USDIMAGING_API
102  virtual void MarkReprDirty(UsdPrim const& prim,
103  SdfPath const& cachePath,
104  UsdImagingIndexProxy* index) override;
105 
106  USDIMAGING_API
107  virtual void MarkCullStyleDirty(UsdPrim const& prim,
108  SdfPath const& cachePath,
109  UsdImagingIndexProxy* index) override;
110 
111  USDIMAGING_API
112  virtual void MarkRenderTagDirty(UsdPrim const& prim,
113  SdfPath const& cachePath,
114  UsdImagingIndexProxy* index) override;
115 
116  USDIMAGING_API
117  virtual void MarkTransformDirty(UsdPrim const& prim,
118  SdfPath const& cachePath,
119  UsdImagingIndexProxy* index) override;
120 
121  USDIMAGING_API
122  virtual void MarkVisibilityDirty(UsdPrim const& prim,
123  SdfPath const& cachePath,
124  UsdImagingIndexProxy* index) override;
125 
126  USDIMAGING_API
127  virtual void MarkMaterialDirty(UsdPrim const& prim,
128  SdfPath const& cachePath,
129  UsdImagingIndexProxy* index) override;
130 
131  USDIMAGING_API
132  virtual void MarkCollectionsDirty(UsdPrim const& prim,
133  SdfPath const& cachePath,
134  UsdImagingIndexProxy* index) override;
135 
136  // ---------------------------------------------------------------------- //
138  // ---------------------------------------------------------------------- //
141  USDIMAGING_API
142  virtual VtValue GetPoints(UsdPrim const& prim,
143  UsdTimeCode time) const;
144 
150  USDIMAGING_API
151  static bool GetColor(UsdPrim const& prim,
152  UsdTimeCode time,
153  TfToken *interpolation,
154  VtValue *color,
155  VtIntArray *indices);
156 
162  USDIMAGING_API
163  static bool GetOpacity(UsdPrim const& prim,
164  UsdTimeCode time,
165  TfToken *interpolation,
166  VtValue *opacity,
167  VtIntArray *indices);
168 
169  // Helper function: add a given type of rprim, potentially with instancer
170  // name mangling, and add any bound shader.
171  USDIMAGING_API
172  SdfPath _AddRprim(TfToken const& primType,
173  UsdPrim const& usdPrim,
174  UsdImagingIndexProxy* index,
175  SdfPath const& materialUsdPath,
176  UsdImagingInstancerContext const* instancerContext);
177 
178  // Helper function: map USD path to UsdImaging cache path,
179  // applying any name-encoding required by the instancerContext.
180  USDIMAGING_API
181  static SdfPath _ResolveCachePath(SdfPath const& usdPath,
182  UsdImagingInstancerContext const* instancerContext);
183 
186  USDIMAGING_API
187  GfRange3d GetExtent(UsdPrim const& prim,
188  SdfPath const& cachePath,
189  UsdTimeCode time) const override;
190 
192  USDIMAGING_API
193  bool GetDoubleSided(UsdPrim const& prim,
194  SdfPath const& cachePath,
195  UsdTimeCode time) const override;
196 
197  USDIMAGING_API
198  SdfPath GetMaterialId(UsdPrim const& prim,
199  SdfPath const& cachePath,
200  UsdTimeCode time) const override;
205  USDIMAGING_API
206  VtValue Get(UsdPrim const& prim,
207  SdfPath const& cachePath,
208  TfToken const& key,
209  UsdTimeCode time,
210  VtIntArray *outIndices) const override;
211 
212  // For implicit prims such as capsules, cones, cylinders and planes, the
213  // "spine" axis along or about which the surface is aligned may be
214  // specified. This utility method returns a basis matrix that transforms
215  // points generated using "Z" as the spine axis to the desired axis.
216  USDIMAGING_API
217  static GfMatrix4d GetImplicitBasis(TfToken const &spineAxis);
218 
219 protected:
220 
221  USDIMAGING_API
222  virtual void _RemovePrim(SdfPath const& cachePath,
223  UsdImagingIndexProxy* index) override;
224 
225  // Give derived classes an opportunity to block GprimAdapter processing
226  // of certain primvars.
227  USDIMAGING_API
228  virtual bool _IsBuiltinPrimvar(TfToken const& primvarName) const;
229 
230  // Utility for gathering the names of primvars used by the gprim's
231  // materials, used in primvar filtering.
232  USDIMAGING_API
233  virtual TfTokenVector _CollectMaterialPrimvars(
234  SdfPathVector const& materialUsdPaths,
235  UsdTimeCode time) const;
236 
240  USDIMAGING_API
241  virtual TfTokenVector const& _GetRprimPrimvarNames() const;
242 };
243 
244 
245 PXR_NAMESPACE_CLOSE_SCOPE
246 
247 #endif //PXR_USD_IMAGING_USD_IMAGING_GPRIM_ADAPTER_H
Basic type: 3-dimensional floating point range.
Definition: range3d.h:64
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:48
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
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 bool GetDoubleSided(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Reads double-sided from the given prim. If not authored, returns false.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
static USDIMAGING_API bool GetOpacity(UsdPrim const &prim, UsdTimeCode time, TfToken *interpolation, VtValue *opacity, VtIntArray *indices)
Returns opacity, Usd interpolation token, and optionally opacity indices for a given prim,...
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
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...
static USDIMAGING_API bool GetColor(UsdPrim const &prim, UsdTimeCode time, TfToken *interpolation, VtValue *color, VtIntArray *indices)
Returns color, Usd interpolation token, and optionally color indices for a given prim,...
Base class for all geometric primitives.
Definition: gprim.h:66
USDIMAGING_API GfRange3d GetExtent(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Reads the extent from the given prim.
virtual USDIMAGING_API VtValue GetPoints(UsdPrim const &prim, UsdTimeCode time) const
Give derived classes an opportunity to override how we get points for a prim.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
virtual USDIMAGING_API TfTokenVector const & _GetRprimPrimvarNames() const
Returns the primvar names known to be supported for the rprims this adapter produces.
virtual USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &property) override
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166