meshAdapter.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_MESH_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_MESH_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
37 class HdSubdivTags;
38 class PxOsdSubdivTags;
39 
45 {
46 public:
48 
51  {}
52  USDIMAGING_API
53  ~UsdImagingMeshAdapter() override;
54 
55  // ---------------------------------------------------------------------- //
57  // ---------------------------------------------------------------------- //
58 
59  USDIMAGING_API
60  TfTokenVector GetImagingSubprims() override;
61 
62  USDIMAGING_API
63  TfToken GetImagingSubprimType(TfToken const& subprim) override;
64 
65  USDIMAGING_API
66  HdContainerDataSourceHandle GetImagingSubprimData(
67  TfToken const& subprim,
68  UsdPrim const& prim,
69  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
70 
71  // ---------------------------------------------------------------------- //
73  // ---------------------------------------------------------------------- //
74 
75  USDIMAGING_API
77  UsdPrim const& prim,
78  UsdImagingIndexProxy* index,
79  UsdImagingInstancerContext const* instancerContext = nullptr) override;
80 
81  USDIMAGING_API
82  bool IsSupported(UsdImagingIndexProxy const* index) const override;
83 
84  // ---------------------------------------------------------------------- //
86  // ---------------------------------------------------------------------- //
87 
89  USDIMAGING_API
90  void TrackVariability(UsdPrim const& prim,
91  SdfPath const& cachePath,
92  HdDirtyBits* timeVaryingBits,
94  instancerContext = nullptr) const override;
95 
96 
98  USDIMAGING_API
99  void UpdateForTime(UsdPrim const& prim,
100  SdfPath const& cachePath,
101  UsdTimeCode time,
102  HdDirtyBits requestedBits,
104  instancerContext = nullptr) const override;
105 
106  // ---------------------------------------------------------------------- //
108  // ---------------------------------------------------------------------- //
109 
110  USDIMAGING_API
111  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
112  SdfPath const& cachePath,
113  TfToken const& propertyName) override;
114 
115  // ---------------------------------------------------------------------- //
117  // ---------------------------------------------------------------------- //
118 
119  USDIMAGING_API
120  PxOsdSubdivTags GetSubdivTags(UsdPrim const& usdPrim,
121  SdfPath const& cachePath,
122  UsdTimeCode time) const override;
123 
124  USDIMAGING_API
125  VtValue GetTopology(UsdPrim const& prim,
126  SdfPath const& cachePath,
127  UsdTimeCode time) const override;
128 
129  USDIMAGING_API
130  VtValue Get(UsdPrim const& prim,
131  SdfPath const& cachePath,
132  TfToken const& key,
133  UsdTimeCode time,
134  VtIntArray *outIndices) const override;
135 
136 protected:
137  USDIMAGING_API
138  bool _IsBuiltinPrimvar(TfToken const& primvarName) const override;
139 };
140 
141 
142 PXR_NAMESPACE_CLOSE_SCOPE
143 
144 #endif // PXR_USD_IMAGING_USD_IMAGING_MESH_ADAPTER_H
Tags for non-hierarchial subdiv surfaces.
Definition: subdivTags.h:43
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Gets the topology object of a specific Usd prim.
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, 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
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
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
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
Delegate support for UsdGeomMesh.
Definition: meshAdapter.h:44
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...
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
USDIMAGING_API PxOsdSubdivTags GetSubdivTags(UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
Get the subdiv tags for this prim.
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 updated, or HdChangeTracker::AllDirty if the entire prim must ...