HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PointRasterizeFrustum.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: MPL-2.0
3 
4 /// @author Dan Bailey, Rick Hankins
5 ///
6 /// @file PointRasterizeFrustum.h
7 ///
8 /// @brief Volume rasterization of VDB Points using velocity and camera motion-blur
9 
10 #ifndef OPENVDB_POINTS_POINT_RASTERIZE_FRUSTUM_HAS_BEEN_INCLUDED
11 #define OPENVDB_POINTS_POINT_RASTERIZE_FRUSTUM_HAS_BEEN_INCLUDED
12 
13 #include <openvdb/math/Ray.h>
14 #include <openvdb/math/DDA.h>
17 #include <openvdb/tools/GridTransformer.h> // for tools::resampleToMatch()
21 
22 namespace openvdb {
24 namespace OPENVDB_VERSION_NAME {
25 namespace points {
26 
27 
28 /// @brief How to composite points into a volume.
29 enum class RasterMode
30 {
31  ACCUMULATE = 0,
32  MAXIMUM,
33  AVERAGE
34 };
35 
36 
37 /// @brief A camera class that provides an interface for camera motion blur when rasterizing
39 {
40 public:
41  explicit RasterCamera(const math::Transform& transform);
42 
43  bool isStatic() const;
44 
45  void clear();
46  void appendTransform(const math::Transform&, float weight = 1.0f);
47 
48  size_t size() const;
49 
50  void simplify();
51 
52  bool hasWeight(Index i) const;
53  float weight(Index i) const;
54 
55  const math::Transform& transform(Index i) const;
56  const math::Transform& firstTransform() const;
57  const math::Transform& lastTransform() const;
58 
59  void setShutter(float start, float end);
60  float shutterStart() const;
61  float shutterEnd() const;
62 
63 private:
64  std::deque<math::Transform> mTransforms;
65  std::deque<float> mWeights;
66  // default to 180 degree film shutter
67  float mShutterStart = -0.25f,
68  mShutterEnd = 0.25f;
69 }; // class RasterCamera
70 
71 
72 /// @brief A group of shared settings to be used in the Volume Rasterizer
73 /// @param scaleByVoxelVolume scale particle contributions by the volume of the receiving voxel
74 /// @param velocityAttribute the name of the velocity attribute
75 /// @param velocityMotionBlur bake the point velocities into the volume
76 /// @param clipToFrustum if enabled and the transform is a frustum transform, eliminate
77 /// points whose position does not lie within the frustum
78 /// @param clipBBox an optional world-space bounding box to clip the points
79 /// during rasterization
80 /// @param clipMask an optional mask, each point samples the mask using a
81 /// nearest-neighbor sampling and is only rasterized if active
82 /// @param invertMask if mask is provided, only rasterize if sample is inactive
83 /// @param framesPerSecond the global value for frames / second for computing motion blur
84 /// @param threaded if enabled, use threading to accelerate rasterization
85 /// @note rasterization can clip can using any combination of bounding box, mask and frustum
87 {
88  FrustumRasterizerSettings() = delete;
89 
90  explicit FrustumRasterizerSettings(const math::Transform& _transform)
91  : transform(new math::Transform(_transform))
92  , camera(_transform) { }
93 
96  bool scaleByVoxelVolume = false,
97  useRadius = false,
101  threaded = true;
102  float threshold = 1e-6f,
103  radiusScale = 1.0f,
106  radiusAttribute = "pscale";
107  int motionSamples = 2;
108 }; // struct FrustumRasterizerSettings
109 
110 
112 {
114 
115  FrustumRasterizerMask() = default;
116 
117  explicit FrustumRasterizerMask(
118  const math::Transform& transform,
119  const MaskGrid* mask = nullptr,
120  const BBoxd& bbox = BBoxd(),
121  const bool clipToFrustum = true,
122  const bool invert = false);
123 
124  operator bool() const;
125 
127 
128  bool valid(const Coord& ijk, AccessorT* acc) const;
129 
130  const CoordBBox& clipBBox() const;
131 
132 private:
133  MaskGrid::Ptr mMask;
134  CoordBBox mClipBBox;
135  bool mInvert = false;
136 }; // struct FrustumRasterizerMask
137 
138 
139 namespace point_rasterize_internal {
140 
141 template <typename PointDataGridT>
143 
144 } // namespace point_rasterize_internal
145 
146 
147 /// @brief Efficient rasterization of one or more VDB Points grids into a linear
148 /// or frustum volume with the option to bake in camera or geometry motion blur.
149 ///
150 /// @details The camera transform can be provided using a RasterCamera object to
151 /// offer linear camera motion blur and geometry motion blur is computed from reading
152 /// a velocity attribute on the points. Sub-sampled camera motion blur is planned.
153 ///
154 /// @note For maximum memory efficiency, the data can optionally be streamed from
155 /// disk where the input VDB point grids are collapsed as they are read.
156 ///
157 /// @note The total contribution for each point is spread across all the voxels being
158 /// rasterized into and weighted by the total volume represented by each voxel. In an
159 /// example use case where a point is moving away from a camera that is used to
160 /// generate a frustum volume being rasterized into, each successive voxel is larger in
161 /// size.
162 template<typename PointDataGridT>
164 {
165 public:
166  using GridPtr = typename PointDataGridT::Ptr;
167  using GridConstPtr = typename PointDataGridT::ConstPtr;
169 
170  /// @brief main constructor
171  /// @param settings the shared settings for rasterizing, see class for more details
172  /// @param interrupt a pointer adhering to the util::NullInterrupter interface
173  explicit FrustumRasterizer(
174  const FrustumRasterizerSettings& settings,
176  util::NullInterrupter* interrupt = nullptr);
177 
178  /// @brief Append a PointDataGrid to the rasterizer (but don't rasterize yet).
179  /// @param points the PointDataGrid
181 
182  /// @brief Append a PointDataGrid to the rasterizer (but don't rasterize yet).
183  /// @param points the non-const PointDataGrid
184  /// @param stream if true, will destructively collapse attributes while
185  /// accessing so as to minimize the memory footprint.
186  void addPoints(GridPtr& points, bool stream = false);
187 
188  /// @brief Clear all PointDataGrids in the rasterizer.
189  void clear();
190 
191  /// @brief Return number of PointDataGrids in the rasterizer.
192  size_t size() const;
193 
194  /// @brief Return memory usage of the rasterizer.
195  size_t memUsage() const;
196 
197  template <typename FilterT = points::NullFilter>
200  bool reduceMemory = false, float scale = 1.0f, const FilterT& filter = FilterT());
201 
202  template <typename FilterT = points::NullFilter>
205  bool reduceMemory = false, float scale = 1.0f, const FilterT& filter = FilterT());
206 
207  template <typename FilterT = points::NullFilter>
210  bool reduceMemory = false, float scale = 1.0f, const FilterT& filter = FilterT());
211 
212  template <typename GridT, typename AttributeT, typename FilterT = points::NullFilter>
213  typename GridT::Ptr
215  bool reduceMemory = false, float scale = 1.0f, const FilterT& filter = FilterT());
216 
217  template <typename GridT, typename FilterT = points::NullFilter>
218  typename GridT::Ptr
219  rasterizeMask(bool reduceMemory = false, const FilterT& filter = FilterT());
220 
221 private:
222  template <typename AttributeT, typename GridT, typename FilterT>
223  void
224  performRasterization(
225  GridT& grid, RasterMode mode, const openvdb::Name& attribute,
226  bool reduceMemory, float scale, const FilterT& filter);
227 
228 private:
229  FrustumRasterizerSettings mSettings;
230  FrustumRasterizerMask mMask;
231 
232  util::NullInterrupter* mInterrupter;
233  std::vector<GridToRasterize> mPointGrids;
234 }; // class FrustumRasterizer
235 
236 
237 /// @brief A struct that stores all include/exclude attribute names as strings
238 /// and is internally converted into the resolved MultiGroupFilter
240 {
241  std::vector<Name> includeNames;
242  std::vector<Name> excludeNames;
243 }; // class RasterGroups
244 
245 
246 } // namespace points
247 } // namespace OPENVDB_VERSION_NAME
248 } // namespace openvdb
249 
251 
252 #endif // OPENVDB_POINTS_POINT_RASTERIZE_FRUSTUM_HAS_BEEN_INCLUDED
Efficient rasterization of one or more VDB Points grids into a linear or frustum volume with the opti...
Definition: ImfName.h:30
GLenum GLenum GLenum GLenum GLenum scale
Definition: glew.h:14163
SharedPtr< GridBase > Ptr
Definition: Grid.h:80
RasterMode
How to composite points into a volume.
GLboolean invert
Definition: glcorearb.h:549
GLuint start
Definition: glcorearb.h:475
GLuint GLuint stream
Definition: glcorearb.h:1832
size_t size() const
Return number of PointDataGrids in the rasterizer.
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:207
FrustumRasterizer(const FrustumRasterizerSettings &settings, const FrustumRasterizerMask &mask=FrustumRasterizerMask(), util::NullInterrupter *interrupt=nullptr)
main constructor
FloatGrid::Ptr rasterizeUniformDensity(RasterMode mode=RasterMode::MAXIMUM, bool reduceMemory=false, float scale=1.0f, const FilterT &filter=FilterT())
GLuint GLuint GLfloat weight
Definition: glew.h:13892
GLuint GLenum GLenum transform
Definition: glew.h:15055
GridBase::Ptr rasterizeAttribute(const Name &attribute, RasterMode mode=RasterMode::ACCUMULATE, bool reduceMemory=false, float scale=1.0f, const FilterT &filter=FilterT())
A struct that stores all include/exclude attribute names as strings and is internally converted into ...
bool valid(const Coord &ijk, AccessorT *acc) const
void appendTransform(const math::Transform &, float weight=1.0f)
Methods for counting points in VDB Point grids.
GLint GLuint mask
Definition: glcorearb.h:124
size_t memUsage() const
Return memory usage of the rasterizer.
GLuint GLuint end
Definition: glcorearb.h:475
RasterCamera(const math::Transform &transform)
void addPoints(GridConstPtr &points)
Append a PointDataGrid to the rasterizer (but don't rasterize yet).
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: glcorearb.h:1297
SharedPtr< const Tree > ConstPtr
Definition: Tree.h:181
Container class that associates a tree with a transform and metadata.
Definition: Grid.h:28
GridT::Ptr rasterizeMask(bool reduceMemory=false, const FilterT &filter=FilterT())
GLenum mode
Definition: glcorearb.h:99
GLuint GLdouble GLdouble GLint GLint const GLdouble * points
Definition: glew.h:3460
A group of shared settings to be used in the Volume Rasterizer.
const math::Transform & firstTransform() const
math::BBox< Vec3d > BBoxd
Definition: Types.h:84
OIIO_API bool attribute(string_view name, TypeDesc type, const void *val)
GLfloat f
Definition: glcorearb.h:1926
Digital Differential Analyzers specialized for VDB.
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:119
Attribute-owned data structure for points. Point attributes are stored in leaf nodes and ordered by v...
const math::Transform & transform(Index i) const
A Ray class.
void clear()
Clear all PointDataGrids in the rasterizer.
const math::Transform & lastTransform() const
A camera class that provides an interface for camera motion blur when rasterizing.
FloatGrid::Ptr rasterizeDensity(const openvdb::Name &attribute, RasterMode mode=RasterMode::MAXIMUM, bool reduceMemory=false, float scale=1.0f, const FilterT &filter=FilterT())