cubeAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_CUBE_ADAPTER_H
8 #define PXR_USD_IMAGING_USD_IMAGING_CUBE_ADAPTER_H
9 
11 
12 #include "pxr/pxr.h"
13 #include "pxr/usdImaging/usdImaging/api.h"
16 
17 PXR_NAMESPACE_OPEN_SCOPE
18 
19 
20 class UsdGeomCube;
21 
27 {
28 public:
30 
33  {}
34  USDIMAGING_API
35  ~UsdImagingCubeAdapter() override;
36 
37  // ---------------------------------------------------------------------- //
39  // ---------------------------------------------------------------------- //
40 
41  USDIMAGING_API
42  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
43 
44  USDIMAGING_API
45  TfToken GetImagingSubprimType(
46  UsdPrim const& prim,
47  TfToken const& subprim) override;
48 
49  USDIMAGING_API
50  HdContainerDataSourceHandle GetImagingSubprimData(
51  UsdPrim const& prim,
52  TfToken const& subprim,
53  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
54 
55  USDIMAGING_API
56  HdDataSourceLocatorSet InvalidateImagingSubprim(
57  UsdPrim const& prim,
58  TfToken const& subprim,
59  TfTokenVector const& properties,
60  UsdImagingPropertyInvalidationType invalidationType) override;
61 
62  // ---------------------------------------------------------------------- //
64  // ---------------------------------------------------------------------- //
65 
66  USDIMAGING_API
68  UsdPrim const& prim,
69  UsdImagingIndexProxy* index,
70  UsdImagingInstancerContext const* instancerContext = nullptr) override;
71 
72  USDIMAGING_API
73  bool IsSupported(UsdImagingIndexProxy const* index) const override;
74 
75  USDIMAGING_API
76  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
77  SdfPath const& cachePath,
78  TfToken const& propertyName) override;
79 
80  // ---------------------------------------------------------------------- //
82  // ---------------------------------------------------------------------- //
83 
85  USDIMAGING_API
86  void TrackVariability(
87  UsdPrim const& prim,
88  SdfPath const& cachePath,
89  HdDirtyBits* timeVaryingBits,
90  UsdImagingInstancerContext const* instancerContext = nullptr)
91  const override;
92 
93  // ---------------------------------------------------------------------- //
95  // ---------------------------------------------------------------------- //
96 
97  USDIMAGING_API
98  VtValue GetTopology(UsdPrim const& prim,
99  SdfPath const& cachePath,
100  UsdTimeCode time) const override;
101 
102  // Override the implemetation in GprimAdapter since we don't fetch the
103  // points attribute for implicit primitives.
104  USDIMAGING_API
106  UsdPrim const& prim,
107  UsdTimeCode time) const override;
108 };
109 
110 
111 PXR_NAMESPACE_CLOSE_SCOPE
112 
113 #endif // PXR_USD_IMAGING_USD_IMAGING_CUBE_ADAPTER_H
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
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:30
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:31
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
USDIMAGING_API VtValue GetPoints(UsdPrim const &prim, UsdTimeCode time) const override
Give derived classes an opportunity to override how we get points for a prim.
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Gets the topology object of a specific Usd prim.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:73
This class is used as a context object with global stage information, that gets passed down to dataso...
Represents a set of data source locators closed under descendancy.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:116
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:489
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 ...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:280
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
Delegate support for UsdGeomCube.
Definition: cubeAdapter.h:26
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Defines a primitive rectilinear cube centered at the origin.
Definition: cube.h:43
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:89