HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdImaging/meshAdapter.h
28 
29 #include "pxr/pxr.h"
33 
35 
36 
37 class HdSubdivTags;
38 class PxOsdSubdivTags;
39 
40 /// \class UsdImagingMeshAdapter
41 ///
42 /// Delegate support for UsdGeomMesh.
43 ///
45 {
46 public:
48 
51  {}
53  ~UsdImagingMeshAdapter() override;
54 
55  // ---------------------------------------------------------------------- //
56  /// \name Scene Index Support
57  // ---------------------------------------------------------------------- //
58 
61 
63  TfToken GetImagingSubprimType(TfToken const& subprim) override;
64 
66  HdContainerDataSourceHandle GetImagingSubprimData(
67  TfToken const& subprim,
68  UsdPrim const& prim,
69  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
70 
71  // ---------------------------------------------------------------------- //
72  /// \name Initialization
73  // ---------------------------------------------------------------------- //
74 
77  UsdPrim const& prim,
79  UsdImagingInstancerContext const* instancerContext = nullptr) override;
80 
82  bool IsSupported(UsdImagingIndexProxy const* index) const override;
83 
84  // ---------------------------------------------------------------------- //
85  /// \name Parallel Setup and Resolve
86  // ---------------------------------------------------------------------- //
87 
88  /// Thread Safe.
90  void TrackVariability(UsdPrim const& prim,
91  SdfPath const& cachePath,
92  HdDirtyBits* timeVaryingBits,
94  instancerContext = nullptr) const override;
95 
96 
97  /// Thread Safe.
99  void UpdateForTime(UsdPrim const& prim,
100  SdfPath const& cachePath,
102  HdDirtyBits requestedBits,
104  instancerContext = nullptr) const override;
105 
106  // ---------------------------------------------------------------------- //
107  /// \name Change Processing
108  // ---------------------------------------------------------------------- //
109 
112  SdfPath const& cachePath,
113  TfToken const& propertyName) override;
114 
115  // ---------------------------------------------------------------------- //
116  /// \name Data access
117  // ---------------------------------------------------------------------- //
118 
120  PxOsdSubdivTags GetSubdivTags(UsdPrim const& usdPrim,
121  SdfPath const& cachePath,
122  UsdTimeCode time) const override;
123 
125  VtValue GetTopology(UsdPrim const& prim,
126  SdfPath const& cachePath,
127  UsdTimeCode time) const override;
128 
130  VtValue Get(UsdPrim const& prim,
131  SdfPath const& cachePath,
132  TfToken const& key,
134  VtIntArray *outIndices) const override;
135 
136 protected:
138  bool _IsBuiltinPrimvar(TfToken const& primvarName) const override;
139 };
140 
141 
143 
144 #endif // PXR_USD_IMAGING_USD_IMAGING_MESH_ADAPTER_H
USDIMAGING_API PxOsdSubdivTags GetSubdivTags(UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
Get the subdiv tags for this prim.
#define USDIMAGING_API
Definition: api.h:40
USDIMAGING_API bool _IsBuiltinPrimvar(TfToken const &primvarName) const override
GT_API const UT_StringHolder time
uint32_t HdDirtyBits
Definition: types.h:158
USDIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData(TfToken const &subprim, UsdPrim const &prim, const UsdImagingDataSourceStageGlobals &stageGlobals) override
USDIMAGING_API TfToken GetImagingSubprimType(TfToken const &subprim) override
Definition: token.h:87
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
Definition: path.h:290
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
USDIMAGING_API ~UsdImagingMeshAdapter() override
GLuint index
Definition: glcorearb.h:786
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
Definition: value.h:166
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
USDIMAGING_API TfTokenVector GetImagingSubprims() override