All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 HDST_VOLUME_H
25 #define HDST_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 #include "pxr/usd/sdf/path.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 class HdStDrawItem;
37 class HdStMaterial;
38 using HdStFieldResourceSharedPtr = boost::shared_ptr<class HdStFieldResource>;
39 using HdStShaderCodeSharedPtr = boost::shared_ptr<class HdStShaderCode>;
40 class HdSceneDelegate;
41 
44 class HdStVolume final : public HdVolume {
45 public:
46  HDST_API
47  HdStVolume(SdfPath const& id, SdfPath const& instancerId = SdfPath());
48  HDST_API
49  ~HdStVolume() override;
50 
51  HDST_API
52  HdDirtyBits GetInitialDirtyBitsMask() const override;
53 
54  HDST_API
55  void Sync(HdSceneDelegate* delegate,
56  HdRenderParam* renderParam,
57  HdDirtyBits* dirtyBits,
58  TfToken const &reprToken) override;
59 
61  static const float defaultStepSize;
62 
64  static const float defaultStepSizeLighting;
65 
66 protected:
67  void _InitRepr(TfToken const &reprToken,
68  HdDirtyBits* dirtyBits) override;
69 
70  HdDirtyBits _PropagateDirtyBits(HdDirtyBits bits) const override;
71 
72  void _UpdateRepr(HdSceneDelegate *sceneDelegate,
73  TfToken const &reprToken,
74  HdDirtyBits *dirtyBitsState);
75 
76 private:
77  using _NameToFieldResource = std::unordered_map<
78  TfToken, HdStFieldResourceSharedPtr, TfToken::HashFunctor>;
79 
80  const TfToken& _GetMaterialTag(const HdRenderIndex &renderIndex) const;
81 
82  void _UpdateDrawItem(HdSceneDelegate *sceneDelegate,
83  HdStDrawItem *drawItem,
84  HdDirtyBits *dirtyBits);
85 
86  _NameToFieldResource _ComputeNameToFieldResource(
87  HdSceneDelegate *sceneDelegate);
88 
89  static HdStShaderCodeSharedPtr
90  _ComputeMaterialShaderAndBBox(
91  HdSceneDelegate * const sceneDelegate,
92  const HdStMaterial * const material,
93  const HdStShaderCodeSharedPtr &volumeShader,
94  const _NameToFieldResource &nameToFieldResource,
95  GfBBox3d * localVolumeBBox);
96 
97  HdReprSharedPtr _volumeRepr;
98 };
99 
100 PXR_NAMESPACE_CLOSE_SCOPE
101 
102 #endif //HDST_VOLUME_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
Functor to use for hash maps from tokens to other things.
Definition: token.h:168
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:46
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
static const float defaultStepSizeLighting
Default step size used for raymarching for lighting computation.
Definition: volume.h:64
Adapter class providing data exchange with the client scene graph.
static const float defaultStepSize
Default step size used for raymarching.
Definition: volume.h:61
Represents a Volume Prim.
Definition: volume.h:44
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:287
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.
Basic type: arbitrarily oriented 3D bounding box.
Definition: bbox3d.h:84