All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
volumeAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2018 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_VOLUME_ADAPTER_H
8#define PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
9
11
12#include "pxr/pxr.h"
14#include "pxr/usdImaging/usdImaging/api.h"
17
18PXR_NAMESPACE_OPEN_SCOPE
19
25public:
27
30 {}
32
33 // ---------------------------------------------------------------------- //
35 // ---------------------------------------------------------------------- //
36
37 USDIMAGING_API
38 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
39
40 USDIMAGING_API
41 TfToken GetImagingSubprimType(
42 UsdPrim const& prim,
43 TfToken const& subprim) override;
44
45 USDIMAGING_API
46 HdContainerDataSourceHandle GetImagingSubprimData(
47 UsdPrim const& prim,
48 TfToken const& subprim,
49 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
50
51 USDIMAGING_API
52 HdDataSourceLocatorSet InvalidateImagingSubprim(
53 UsdPrim const& prim,
54 TfToken const& subprim,
55 TfTokenVector const& properties,
56 UsdImagingPropertyInvalidationType invalidationType) override;
57
58 // ---------------------------------------------------------------------- //
60 // ---------------------------------------------------------------------- //
61
62 USDIMAGING_API
63 virtual SdfPath Populate(UsdPrim const& prim,
66 instancerContext = NULL) override;
67
68 USDIMAGING_API
69 virtual bool IsSupported(UsdImagingIndexProxy const* index) const override;
70
71 // ---------------------------------------------------------------------- //
73 // ---------------------------------------------------------------------- //
75 USDIMAGING_API
76 virtual void TrackVariability(UsdPrim const& prim,
77 SdfPath const& cachePath,
78 HdDirtyBits* timeVaryingBits,
80 instancerContext = NULL) const override;
81
83 USDIMAGING_API
84 virtual void UpdateForTime(UsdPrim const& prim,
85 SdfPath const& cachePath,
86 UsdTimeCode time,
87 HdDirtyBits requestedBits,
89 instancerContext = NULL) const override;
90
91 USDIMAGING_API
92 virtual HdVolumeFieldDescriptorVector
93 GetVolumeFieldDescriptors(UsdPrim const& usdPrim, SdfPath const &id,
94 UsdTimeCode time) const override;
95
96private:
97 bool _GatherVolumeData(UsdPrim const& prim,
98 UsdVolVolume::FieldMap *fieldMap) const;
99};
100
101PXR_NAMESPACE_CLOSE_SCOPE
102
103#endif // PXR_USD_IMAGING_USD_IMAGING_VOLUME_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
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 UsdVolVolume.
Definition: volumeAdapter.h:24
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
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
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