All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
planeAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2022 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_PLANE_ADAPTER_H
8#define PXR_USD_IMAGING_USD_IMAGING_PLANE_ADAPTER_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usdImaging/usdImaging/api.h"
15
16PXR_NAMESPACE_OPEN_SCOPE
17
18
19class UsdGeomPlane;
20
26public:
28
31 {}
32 USDIMAGING_API
34
35 // ---------------------------------------------------------------------- //
37 // ---------------------------------------------------------------------- //
38
39 USDIMAGING_API
40 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
41
42 USDIMAGING_API
43 TfToken GetImagingSubprimType(
44 UsdPrim const& prim,
45 TfToken const& subprim) override;
46
47 USDIMAGING_API
48 HdContainerDataSourceHandle GetImagingSubprimData(
49 UsdPrim const& prim,
50 TfToken const& subprim,
51 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
52
53 USDIMAGING_API
54 HdDataSourceLocatorSet InvalidateImagingSubprim(
55 UsdPrim const& prim,
56 TfToken const& subprim,
57 TfTokenVector const& properties,
58 UsdImagingPropertyInvalidationType invalidationType) override;
59
60 // ---------------------------------------------------------------------- //
62 // ---------------------------------------------------------------------- //
63
64 USDIMAGING_API
66 UsdPrim const& prim,
68 UsdImagingInstancerContext const* instancerContext = nullptr) override;
69
70 USDIMAGING_API
71 bool IsSupported(UsdImagingIndexProxy const* index) const override;
72
73 USDIMAGING_API
74 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
75 SdfPath const& cachePath,
76 TfToken const& propertyName) override;
77
78 // ---------------------------------------------------------------------- //
80 // ---------------------------------------------------------------------- //
81
83 USDIMAGING_API
85 UsdPrim const& prim,
86 SdfPath const& cachePath,
87 HdDirtyBits* timeVaryingBits,
88 UsdImagingInstancerContext const* instancerContext = nullptr)
89 const override;
90
91 // ---------------------------------------------------------------------- //
93 // ---------------------------------------------------------------------- //
94
95 USDIMAGING_API
97 SdfPath const& cachePath,
98 UsdTimeCode time) const override;
99
100 // Override the implemetation in GprimAdapter since we don't fetch the
101 // points attribute for implicit primitives.
102 USDIMAGING_API
104 UsdPrim const& prim,
105 UsdTimeCode time) const override;
106
107 // Used by the legacyEngine.
108 USDIMAGING_API
109 static VtValue GetMeshPoints(UsdPrim const& prim,
110 UsdTimeCode time);
111
112 // Used by the legacyEngine.
113 USDIMAGING_API
114 static VtValue GetMeshTopology();
115};
116
117
118PXR_NAMESPACE_CLOSE_SCOPE
119
120#endif // PXR_USD_IMAGING_USD_IMAGING_PLANE_ADAPTER_H
Represents a set of data source locators closed under descendancy.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Defines a primitive plane, centered at the origin, and is defined by a cardinal axis,...
Definition: plane.h:57
This class is used as a context object with global stage information, that gets passed down to dataso...
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:32
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:30
Delegate support for UsdGeomPlane.
Definition: planeAdapter.h:25
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
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 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.
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 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 ...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:67
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440