HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
volume.h
Go to the documentation of this file.
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 
33 
34 class HdStDrawItem;
35 
36 /// Represents a Volume Prim.
37 ///
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 Sync(HdSceneDelegate* delegate,
50  HdRenderParam* renderParam,
51  HdDirtyBits* dirtyBits,
52  TfToken const &reprToken) override;
53 
54  HDST_API
55  void Finalize(HdRenderParam *renderParam) override;
56 
57  /// Default step size used for raymarching
58  static const float defaultStepSize;
59 
60  /// Default step size used for raymarching for lighting computation
61  static const float defaultStepSizeLighting;
62 
63  /// Default memory limit for a field texture (in Mb) if not
64  /// overridden by field prim with textureMemory.
65  static const float defaultMaxTextureMemoryPerField;
66 
67 protected:
68  void _InitRepr(TfToken const &reprToken,
69  HdDirtyBits* dirtyBits) override;
70 
71  HdDirtyBits _PropagateDirtyBits(HdDirtyBits bits) const override;
72 
73  void _UpdateRepr(HdSceneDelegate *sceneDelegate,
74  HdRenderParam *renderParam,
75  TfToken const &reprToken,
76  HdDirtyBits *dirtyBitsState);
77 
78 private:
79  void _UpdateDrawItem(HdSceneDelegate *sceneDelegate,
80  HdRenderParam *renderParam,
81  HdStDrawItem *drawItem,
82  HdDirtyBits *dirtyBits);
83 
84  HdReprSharedPtr _volumeRepr;
85 };
86 
88 
89 #endif //PXR_IMAGING_HD_ST_VOLUME_H
HDST_API void Sync(HdSceneDelegate *delegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits, TfToken const &reprToken) override
HDST_API HdStVolume(SdfPath const &id)
uint32_t HdDirtyBits
Definition: types.h:127
HdDirtyBits _PropagateDirtyBits(HdDirtyBits bits) const override
std::shared_ptr< HdRepr > HdReprSharedPtr
Definition: rprim.h:52
static const float defaultStepSize
Default step size used for raymarching.
Definition: volume.h:58
Definition: token.h:87
HDST_API ~HdStVolume() override
void _UpdateRepr(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, TfToken const &reprToken, HdDirtyBits *dirtyBitsState)
Definition: path.h:288
static const float defaultStepSizeLighting
Default step size used for raymarching for lighting computation.
Definition: volume.h:61
static const float defaultMaxTextureMemoryPerField
Definition: volume.h:65
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
void _InitRepr(TfToken const &reprToken, HdDirtyBits *dirtyBits) override
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
HDST_API void Finalize(HdRenderParam *renderParam) override