volumeAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/volume.h"
31 #include "pxr/usdImaging/usdImaging/api.h"
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
42 public:
44 
47  {}
48  virtual ~UsdImagingVolumeAdapter();
49 
50  // ---------------------------------------------------------------------- //
52  // ---------------------------------------------------------------------- //
53 
54  USDIMAGING_API
55  TfTokenVector GetImagingSubprims() override;
56 
57  USDIMAGING_API
58  TfToken GetImagingSubprimType(TfToken const& subprim) override;
59 
60  USDIMAGING_API
61  HdContainerDataSourceHandle GetImagingSubprimData(
62  TfToken const& subprim,
63  UsdPrim const& prim,
64  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
65 
66  USDIMAGING_API
67  HdDataSourceLocatorSet InvalidateImagingSubprim(
68  TfToken const& subprim,
69  TfTokenVector const& properties) override;
70 
71  // ---------------------------------------------------------------------- //
73  // ---------------------------------------------------------------------- //
74 
75  virtual SdfPath Populate(UsdPrim const& prim,
76  UsdImagingIndexProxy* index,
78  instancerContext = NULL) override;
79 
80  virtual bool IsSupported(UsdImagingIndexProxy const* index) const override;
81 
82  // ---------------------------------------------------------------------- //
84  // ---------------------------------------------------------------------- //
86  virtual void TrackVariability(UsdPrim const& prim,
87  SdfPath const& cachePath,
88  HdDirtyBits* timeVaryingBits,
90  instancerContext = NULL) const override;
91 
93  virtual void UpdateForTime(UsdPrim const& prim,
94  SdfPath const& cachePath,
95  UsdTimeCode time,
96  HdDirtyBits requestedBits,
98  instancerContext = NULL) const override;
99 
100  virtual HdVolumeFieldDescriptorVector
101  GetVolumeFieldDescriptors(UsdPrim const& usdPrim, SdfPath const &id,
102  UsdTimeCode time) const override;
103 
104 private:
105  bool _GatherVolumeData(UsdPrim const& prim,
106  UsdVolVolume::FieldMap *fieldMap) const;
107 };
108 
109 PXR_NAMESPACE_CLOSE_SCOPE
110 
111 #endif // PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
virtual bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Delegate support for UsdVolVolume.
Definition: volumeAdapter.h:41
virtual void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:48
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
This class is used as a context object with global stage information, that gets passed down to dataso...
Base class for all PrimAdapters.
Definition: primAdapter.h:67
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:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
Called to populate the RenderIndex for this UsdPrim.