HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdImaging/volumeAdapter.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/volume.h"
34 
36 
37 /// \class UsdImagingVolumeAdapter
38 ///
39 /// Delegate support for UsdVolVolume.
40 ///
42 public:
44 
47  {}
48  virtual ~UsdImagingVolumeAdapter();
49 
50  virtual SdfPath Populate(UsdPrim const& prim,
53  instancerContext = NULL) override;
54 
55  virtual bool IsSupported(UsdImagingIndexProxy const* index) const override;
56 
57  // ---------------------------------------------------------------------- //
58  /// \name Parallel Setup and Resolve
59  // ---------------------------------------------------------------------- //
60  /// Thread Safe.
61  virtual void TrackVariability(UsdPrim const& prim,
62  SdfPath const& cachePath,
63  HdDirtyBits* timeVaryingBits,
65  instancerContext = NULL) const override;
66 
67  /// Thread Safe.
68  virtual void UpdateForTime(UsdPrim const& prim,
69  SdfPath const& cachePath,
71  HdDirtyBits requestedBits,
73  instancerContext = NULL) const override;
74 
76  GetVolumeFieldDescriptors(UsdPrim const& usdPrim, SdfPath const &id,
77  UsdTimeCode time) const override;
78 
79 private:
80  bool _GatherVolumeData(UsdPrim const& prim,
81  UsdVolVolume::FieldMap *fieldMap) const;
82 };
83 
85 
86 #endif // PXR_USD_IMAGING_USD_IMAGING_VOLUME_ADAPTER_H
virtual HdVolumeFieldDescriptorVector GetVolumeFieldDescriptors(UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const override
Thread Safe.
GT_API const UT_StringHolder time
GLuint index
Definition: glew.h:1814
UsdImagingGprimAdapter BaseAdapter
Definition: volumeAdapter.h:43
uint32_t HdDirtyBits
Definition: types.h:127
virtual ~UsdImagingVolumeAdapter()
virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
Definition: prim.h:132
Definition: path.h:288
std::vector< HdVolumeFieldDescriptor > HdVolumeFieldDescriptorVector
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
virtual void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
Thread Safe.
std::map< TfToken, SdfPath > FieldMap
Definition: volume.h:184
virtual bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.