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"
13 #include "pxr/usd/usdVol/volume.h"
14 #include "pxr/usdImaging/usdImaging/api.h"
15 #include "pxr/usdImaging/usdImaging/primAdapter.h"
16 #include "pxr/usdImaging/usdImaging/gprimAdapter.h"
17 
18 PXR_NAMESPACE_OPEN_SCOPE
19 
24 class UsdImagingVolumeAdapter : public UsdImagingGprimAdapter {
25 public:
26  typedef UsdImagingGprimAdapter BaseAdapter;
27 
28  UsdImagingVolumeAdapter()
29  : UsdImagingGprimAdapter()
30  {}
31  virtual ~UsdImagingVolumeAdapter();
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,
64  UsdImagingIndexProxy* index,
65  UsdImagingInstancerContext const*
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,
79  UsdImagingInstancerContext const*
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,
88  UsdImagingInstancerContext const*
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 
96 private:
97  bool _GatherVolumeData(UsdPrim const& prim,
98  UsdVolVolume::FieldMap *fieldMap) const;
99 };
100 
101 PXR_NAMESPACE_CLOSE_SCOPE
102 
103 #endif // PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
UsdImagingInstanceablePrimAdapter
An abstract adapter class for prims that are instanceable.
Definition: instanceablePrimAdapter.h:22
UsdImagingVolumeAdapter::Populate
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.
UsdImagingIndexProxy
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:30
UsdImagingVolumeAdapter
Delegate support for UsdVolVolume.
Definition: volumeAdapter.h:24
UsdImagingGprimAdapter
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:31
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
UsdImagingVolumeAdapter::IsSupported
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
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
UsdImagingInstancerContext
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Definition: instancerContext.h:27
UsdImagingVolumeAdapter::TrackVariability
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
UsdImagingVolumeAdapter::UpdateForTime
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.