tetMeshAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_IMAGING_USD_IMAGING_TET_MESH_ADAPTER_H
8 #define PXR_USD_IMAGING_USD_IMAGING_TET_MESH_ADAPTER_H
9 
11 
12 #include "pxr/pxr.h"
13 #include "pxr/usdImaging/usdImaging/api.h"
14 #include "pxr/usdImaging/usdImaging/primAdapter.h"
15 #include "pxr/usdImaging/usdImaging/gprimAdapter.h"
16 
17 PXR_NAMESPACE_OPEN_SCOPE
18 
19 
24 class UsdImagingTetMeshAdapter : public UsdImagingGprimAdapter
25 {
26 public:
27  using BaseAdapter = UsdImagingGprimAdapter;
28 
29  UsdImagingTetMeshAdapter()
30  : UsdImagingGprimAdapter()
31  {}
32 
33  USDIMAGING_API
34  ~UsdImagingTetMeshAdapter() override;
35 
36  // ---------------------------------------------------------------------- //
38  // ---------------------------------------------------------------------- //
39 
40  USDIMAGING_API
41  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
42 
43  USDIMAGING_API
44  TfToken GetImagingSubprimType(
45  UsdPrim const& prim,
46  TfToken const& subprim) override;
47 
48  USDIMAGING_API
49  HdContainerDataSourceHandle GetImagingSubprimData(
50  UsdPrim const& prim,
51  TfToken const& subprim,
52  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
53 
54  USDIMAGING_API
55  HdDataSourceLocatorSet InvalidateImagingSubprim(
56  UsdPrim const& prim,
57  TfToken const& subprim,
58  TfTokenVector const& properties,
59  UsdImagingPropertyInvalidationType invalidationType) override;
60 
61  // ---------------------------------------------------------------------- //
63  // ---------------------------------------------------------------------- //
64 
65  USDIMAGING_API
66  SdfPath Populate(
67  UsdPrim const& prim,
68  UsdImagingIndexProxy* index,
69  UsdImagingInstancerContext const* instancerContext = nullptr) override;
70 
71  USDIMAGING_API
72  bool IsSupported(UsdImagingIndexProxy const* index) const override;
73 
74  // ---------------------------------------------------------------------- //
76  // ---------------------------------------------------------------------- //
77 
79  USDIMAGING_API
80  void TrackVariability(UsdPrim const& prim,
81  SdfPath const& cachePath,
82  HdDirtyBits* timeVaryingBits,
83  UsdImagingInstancerContext const*
84  instancerContext = nullptr) const override;
85 
86  // ---------------------------------------------------------------------- //
88  // ---------------------------------------------------------------------- //
89 
90  USDIMAGING_API
91  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
92  SdfPath const& cachePath,
93  TfToken const& propertyName) override;
94 
95  // ---------------------------------------------------------------------- //
97  // ---------------------------------------------------------------------- //
98 
99  USDIMAGING_API
100  VtValue GetTopology(UsdPrim const& prim,
101  SdfPath const& cachePath,
102  UsdTimeCode time) const override;
103 
104 };
105 
106 PXR_NAMESPACE_CLOSE_SCOPE
107 
108 #endif // PXR_USD_IMAGING_USD_IMAGING_TET_MESH_ADAPTER_H
UsdImagingInstanceablePrimAdapter
An abstract adapter class for prims that are instanceable.
Definition: instanceablePrimAdapter.h:22
UsdImagingTetMeshAdapter::IsSupported
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
UsdImagingTetMeshAdapter
Delegate support for UsdGeomTetMesh.
Definition: tetMeshAdapter.h:24
UsdImagingIndexProxy
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:30
UsdImagingGprimAdapter
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:31
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
UsdImagingTetMeshAdapter::GetTopology
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Gets the topology object of a specific Usd prim.
UsdTimeCode
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:73
UsdImagingDataSourceStageGlobals
This class is used as a context object with global stage information, that gets passed down to dataso...
Definition: dataSourceStageGlobals.h:30
HdDataSourceLocatorSet
Represents a set of data source locators closed under descendancy.
Definition: dataSourceLocator.h:250
UsdPrim
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:116
TfTokenVector
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:489
SdfPath
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:280
UsdImagingTetMeshAdapter::Populate
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
UsdImagingInstancerContext
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Definition: instancerContext.h:27
UsdImagingTetMeshAdapter::ProcessPropertyChange
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 ...
VtValue
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:89
UsdImagingTetMeshAdapter::TrackVariability
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.