volume.h
1 //
2 // Copyright 2019 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_IMAGING_HD_ST_VOLUME_H
25 #define PXR_IMAGING_HD_ST_VOLUME_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/volume.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class HdStDrawItem;
35 
38 class HdStVolume final : public HdVolume {
39 public:
40  HDST_API
41  HdStVolume(SdfPath const& id);
42  HDST_API
43  ~HdStVolume() override;
44 
45  HDST_API
46  HdDirtyBits GetInitialDirtyBitsMask() const override;
47 
48  HDST_API
49  void UpdateRenderTag(HdSceneDelegate *delegate,
50  HdRenderParam *renderParam) override;
51 
52  HDST_API
53  void Sync(HdSceneDelegate* delegate,
54  HdRenderParam* renderParam,
55  HdDirtyBits* dirtyBits,
56  TfToken const &reprToken) override;
57 
58  HDST_API
59  void Finalize(HdRenderParam *renderParam) override;
60 
62  HDST_API
63  static const float defaultStepSize;
64 
66  HDST_API
67  static const float defaultStepSizeLighting;
68 
71  HDST_API
72  static const float defaultMaxTextureMemoryPerField;
73 
74 protected:
75  void _InitRepr(TfToken const &reprToken,
76  HdDirtyBits* dirtyBits) override;
77 
78  HdDirtyBits _PropagateDirtyBits(HdDirtyBits bits) const override;
79 
80  void _UpdateRepr(HdSceneDelegate *sceneDelegate,
81  HdRenderParam *renderParam,
82  TfToken const &reprToken,
83  HdDirtyBits *dirtyBitsState);
84 
85 private:
86  void _UpdateDrawItem(HdSceneDelegate *sceneDelegate,
87  HdRenderParam *renderParam,
88  HdStDrawItem *drawItem,
89  HdDirtyBits *dirtyBits);
90 
91  enum DrawingCoord {
92  InstancePrimvar = HdDrawingCoord::CustomSlotsBegin
93  };
94 
95  HdReprSharedPtr _volumeRepr;
96 };
97 
98 PXR_NAMESPACE_CLOSE_SCOPE
99 
100 #endif //PXR_IMAGING_HD_ST_VOLUME_H
HDST_API void Finalize(HdRenderParam *renderParam) override
Finalizes object resources.
static HDST_API const float defaultStepSize
Default step size used for raymarching.
Definition: volume.h:63
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
void _InitRepr(TfToken const &reprToken, HdDirtyBits *dirtyBits) override
Initialize the given representation of this Rprim.
Hd schema for a renderable volume primitive.
Definition: volume.h:42
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Adapter class providing data exchange with the client scene graph.
Represents a Volume Prim.
Definition: volume.h:38
static HDST_API const float defaultMaxTextureMemoryPerField
Default memory limit for a field texture (in Mb) if not overridden by field prim with textureMemory.
Definition: volume.h:72
HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
Returns the set of dirty bits that should be added to the change tracker for this prim,...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
HdDirtyBits _PropagateDirtyBits(HdDirtyBits bits) const override
This callback from Rprim gives the prim an opportunity to set additional dirty bits based on those al...
HDST_API void Sync(HdSceneDelegate *delegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits, TfToken const &reprToken) override
Pull invalidated scene data and prepare/update the renderable representation.
static HDST_API const float defaultStepSizeLighting
Default step size used for raymarching for lighting computation.
Definition: volume.h:67