HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
LeafNodeBool.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: MPL-2.0
3 
4 #ifndef OPENVDB_TREE_LEAF_NODE_BOOL_HAS_BEEN_INCLUDED
5 #define OPENVDB_TREE_LEAF_NODE_BOOL_HAS_BEEN_INCLUDED
6 
7 #include <openvdb/Types.h>
8 #include <openvdb/io/Compression.h> // for io::readData(), etc.
9 #include <openvdb/math/Math.h> // for math::isZero()
10 #include <openvdb/util/NodeMasks.h>
11 #include "LeafNode.h"
12 #include "Iterator.h"
13 #include <iostream>
14 #include <sstream>
15 #include <string>
16 #include <type_traits>
17 #include <vector>
18 
19 
20 namespace openvdb {
22 namespace OPENVDB_VERSION_NAME {
23 namespace tree {
24 
25 /// @brief LeafNode specialization for values of type bool that stores both
26 /// the active states and the values of (2^Log2Dim)^3 voxels as bit masks
27 template<Index Log2Dim>
28 class LeafNode<bool, Log2Dim>
29 {
30 public:
32  using BuildType = bool;
33  using ValueType = bool;
37 
38  // These static declarations must be on separate lines to avoid VC9 compiler errors.
39  static const Index LOG2DIM = Log2Dim; // needed by parent nodes
40  static const Index TOTAL = Log2Dim; // needed by parent nodes
41  static const Index DIM = 1 << TOTAL; // dimension along one coordinate direction
42  static const Index NUM_VALUES = 1 << 3 * Log2Dim;
43  static const Index NUM_VOXELS = NUM_VALUES; // total number of voxels represented by this node
44  static const Index SIZE = NUM_VALUES;
45  static const Index LEVEL = 0; // level 0 = leaf
46 
47  /// @brief ValueConverter<T>::Type is the type of a LeafNode having the same
48  /// dimensions as this node but a different value type, T.
49  template<typename ValueType>
50  struct ValueConverter { using Type = LeafNode<ValueType, Log2Dim>; };
51 
52  /// @brief SameConfiguration<OtherNodeType>::value is @c true if and only if
53  /// OtherNodeType is the type of a LeafNode with the same dimensions as this node.
54  template<typename OtherNodeType>
55  struct SameConfiguration {
57  };
58 
59 
60  /// Default constructor
61  LeafNode();
62 
63  /// Constructor
64  /// @param xyz the coordinates of a voxel that lies within the node
65  /// @param value the initial value for all of this node's voxels
66  /// @param active the active state to which to initialize all voxels
67  explicit LeafNode(const Coord& xyz, bool value = false, bool active = false);
68 
69  /// "Partial creation" constructor used during file input
70  LeafNode(PartialCreate, const Coord& xyz, bool value = false, bool active = false);
71 
72  /// Deep copy constructor
73  LeafNode(const LeafNode&);
74 
75  /// Deep assignment operator
76  LeafNode& operator=(const LeafNode&) = default;
77 
78  /// Value conversion copy constructor
79  template<typename OtherValueType>
80  explicit LeafNode(const LeafNode<OtherValueType, Log2Dim>& other);
81 
82  /// Topology copy constructor
83  template<typename ValueType>
85 
86  //@{
87  /// @brief Topology copy constructor
88  /// @note This variant exists mainly to enable template instantiation.
89  template<typename ValueType>
90  LeafNode(const LeafNode<ValueType, Log2Dim>& other, bool offValue, bool onValue, TopologyCopy);
91  template<typename ValueType>
92  LeafNode(const LeafNode<ValueType, Log2Dim>& other, bool background, TopologyCopy);
93  //@}
94 
95  /// Destructor
96  ~LeafNode();
97 
98  //
99  // Statistics
100  //
101  /// Return log2 of the size of the buffer storage.
102  static Index log2dim() { return Log2Dim; }
103  /// Return the number of voxels in each dimension.
104  static Index dim() { return DIM; }
105  static Index size() { return SIZE; }
106  static Index numValues() { return SIZE; }
107  static Index getLevel() { return LEVEL; }
108  static void getNodeLog2Dims(std::vector<Index>& dims) { dims.push_back(Log2Dim); }
109  static Index getChildDim() { return 1; }
110 
111  static Index32 leafCount() { return 1; }
112  /// no-op
113  void nodeCount(std::vector<Index32> &) const {}
114  static Index32 nonLeafCount() { return 0; }
115 
116  /// Return the number of active voxels.
117  Index64 onVoxelCount() const { return mValueMask.countOn(); }
118  /// Return the number of inactive voxels.
119  Index64 offVoxelCount() const { return mValueMask.countOff(); }
120  Index64 onLeafVoxelCount() const { return onVoxelCount(); }
122  static Index64 onTileCount() { return 0; }
123  static Index64 offTileCount() { return 0; }
124 
125  /// Return @c true if this node has no active voxels.
126  bool isEmpty() const { return mValueMask.isOff(); }
127  /// Return @c true if this node only contains active voxels.
128  bool isDense() const { return mValueMask.isOn(); }
129  /// @brief Return @c true if memory for this node's buffer has been allocated.
130  /// @details Currently, boolean leaf nodes don't support partial creation,
131  /// so this always returns @c true.
132  bool isAllocated() const { return true; }
133  /// @brief Allocate memory for this node's buffer if it has not already been allocated.
134  /// @details Currently, boolean leaf nodes don't support partial creation,
135  /// so this has no effect.
136  bool allocate() { return true; }
137 
138  /// Return the memory in bytes occupied by this node.
139  Index64 memUsage() const;
140 
141  /// Expand the given bounding box so that it includes this leaf node's active voxels.
142  /// If visitVoxels is false this LeafNode will be approximated as dense, i.e. with all
143  /// voxels active. Else the individual active voxels are visited to produce a tight bbox.
144  void evalActiveBoundingBox(CoordBBox& bbox, bool visitVoxels = true) const;
145 
146  /// @brief Return the bounding box of this node, i.e., the full index space
147  /// spanned by this leaf node.
148  CoordBBox getNodeBoundingBox() const { return CoordBBox::createCube(mOrigin, DIM); }
149 
150  /// Set the grid index coordinates of this node's local origin.
151  void setOrigin(const Coord& origin) { mOrigin = origin; }
152  //@{
153  /// Return the grid index coordinates of this node's local origin.
154  const Coord& origin() const { return mOrigin; }
155  void getOrigin(Coord& origin) const { origin = mOrigin; }
156  void getOrigin(Int32& x, Int32& y, Int32& z) const { mOrigin.asXYZ(x, y, z); }
157  //@}
158 
159  /// Return the linear table offset of the given global or local coordinates.
160  static Index coordToOffset(const Coord& xyz);
161  /// @brief Return the local coordinates for a linear table offset,
162  /// where offset 0 has coordinates (0, 0, 0).
163  static Coord offsetToLocalCoord(Index n);
164  /// Return the global coordinates for a linear table offset.
165  Coord offsetToGlobalCoord(Index n) const;
166 
167  /// Return a string representation of this node.
168  std::string str() const;
169 
170  /// @brief Return @c true if the given node (which may have a different @c ValueType
171  /// than this node) has the same active value topology as this node.
172  template<typename OtherType, Index OtherLog2Dim>
173  bool hasSameTopology(const LeafNode<OtherType, OtherLog2Dim>* other) const;
174 
175  /// Check for buffer equivalence by value.
176  bool operator==(const LeafNode&) const;
177  bool operator!=(const LeafNode&) const;
178 
179  //
180  // Buffer management
181  //
182  /// @brief Exchange this node's data buffer with the given data buffer
183  /// without changing the active states of the values.
184  void swap(Buffer& other) { mBuffer.swap(other); }
185  const Buffer& buffer() const { return mBuffer; }
186  Buffer& buffer() { return mBuffer; }
187 
188  //
189  // I/O methods
190  //
191  /// Read in just the topology.
192  void readTopology(std::istream&, bool fromHalf = false);
193  /// Write out just the topology.
194  void writeTopology(std::ostream&, bool toHalf = false) const;
195 
196  /// Read in the topology and the origin.
197  void readBuffers(std::istream&, bool fromHalf = false);
198  void readBuffers(std::istream& is, const CoordBBox&, bool fromHalf = false);
199  /// Write out the topology and the origin.
200  void writeBuffers(std::ostream&, bool toHalf = false) const;
201 
202  //
203  // Accessor methods
204  //
205  /// Return the value of the voxel at the given coordinates.
206  const bool& getValue(const Coord& xyz) const;
207  /// Return the value of the voxel at the given offset.
208  const bool& getValue(Index offset) const;
209 
210  /// @brief Return @c true if the voxel at the given coordinates is active.
211  /// @param xyz the coordinates of the voxel to be probed
212  /// @param[out] val the value of the voxel at the given coordinates
213  bool probeValue(const Coord& xyz, bool& val) const;
214 
215  /// Return the level (0) at which leaf node values reside.
216  static Index getValueLevel(const Coord&) { return LEVEL; }
217 
218  /// Set the active state of the voxel at the given coordinates but don't change its value.
219  void setActiveState(const Coord& xyz, bool on);
220  /// Set the active state of the voxel at the given offset but don't change its value.
221  void setActiveState(Index offset, bool on) { assert(offset<SIZE); mValueMask.set(offset, on); }
222 
223  /// Set the value of the voxel at the given coordinates but don't change its active state.
224  void setValueOnly(const Coord& xyz, bool val);
225  /// Set the value of the voxel at the given offset but don't change its active state.
226  void setValueOnly(Index offset, bool val) { assert(offset<SIZE); mBuffer.setValue(offset,val); }
227 
228  /// Mark the voxel at the given coordinates as inactive but don't change its value.
229  void setValueOff(const Coord& xyz) { mValueMask.setOff(this->coordToOffset(xyz)); }
230  /// Mark the voxel at the given offset as inactive but don't change its value.
231  void setValueOff(Index offset) { assert(offset < SIZE); mValueMask.setOff(offset); }
232 
233  /// Set the value of the voxel at the given coordinates and mark the voxel as inactive.
234  void setValueOff(const Coord& xyz, bool val);
235  /// Set the value of the voxel at the given offset and mark the voxel as inactive.
236  void setValueOff(Index offset, bool val);
237 
238  /// Mark the voxel at the given coordinates as active but don't change its value.
239  void setValueOn(const Coord& xyz) { mValueMask.setOn(this->coordToOffset(xyz)); }
240  /// Mark the voxel at the given offset as active but don't change its value.
241  void setValueOn(Index offset) { assert(offset < SIZE); mValueMask.setOn(offset); }
242 
243  /// Set the value of the voxel at the given coordinates and mark the voxel as active.
244  void setValueOn(const Coord& xyz, bool val);
245  /// Set the value of the voxel at the given coordinates and mark the voxel as active.
246  void setValue(const Coord& xyz, bool val) { this->setValueOn(xyz, val); }
247  /// Set the value of the voxel at the given offset and mark the voxel as active.
248  void setValueOn(Index offset, bool val);
249 
250  /// @brief Apply a functor to the value of the voxel at the given offset
251  /// and mark the voxel as active.
252  template<typename ModifyOp>
253  void modifyValue(Index offset, const ModifyOp& op);
254  /// @brief Apply a functor to the value of the voxel at the given coordinates
255  /// and mark the voxel as active.
256  template<typename ModifyOp>
257  void modifyValue(const Coord& xyz, const ModifyOp& op);
258 
259  /// Apply a functor to the voxel at the given coordinates.
260  template<typename ModifyOp>
261  void modifyValueAndActiveState(const Coord& xyz, const ModifyOp& op);
262 
263  /// Mark all voxels as active but don't change their values.
264  void setValuesOn() { mValueMask.setOn(); }
265  /// Mark all voxels as inactive but don't change their values.
266  void setValuesOff() { mValueMask.setOff(); }
267 
268  /// Return @c true if the voxel at the given coordinates is active.
269  bool isValueOn(const Coord& xyz) const { return mValueMask.isOn(this->coordToOffset(xyz)); }
270  /// Return @c true if the voxel at the given offset is active.
271  bool isValueOn(Index offset) const { assert(offset < SIZE); return mValueMask.isOn(offset); }
272 
273  /// Return @c false since leaf nodes never contain tiles.
274  static bool hasActiveTiles() { return false; }
275 
276  /// Set all voxels that lie outside the given axis-aligned box to the background.
277  void clip(const CoordBBox&, bool background);
278 
279  /// Set all voxels within an axis-aligned box to the specified value and active state.
280  void fill(const CoordBBox& bbox, bool value, bool active = true);
281  /// Set all voxels within an axis-aligned box to the specified value and active state.
282  void denseFill(const CoordBBox& bbox, bool val, bool on = true) { this->fill(bbox, val, on); }
283 
284  /// Set all voxels to the specified value but don't change their active states.
285  void fill(const bool& value);
286  /// Set all voxels to the specified value and active state.
287  void fill(const bool& value, bool active);
288 
289  /// @brief Copy into a dense grid the values of the voxels that lie within
290  /// a given bounding box.
291  ///
292  /// @param bbox inclusive bounding box of the voxels to be copied into the dense grid
293  /// @param dense dense grid with a stride in @e z of one (see tools::Dense
294  /// in tools/Dense.h for the required API)
295  ///
296  /// @note @a bbox is assumed to be identical to or contained in the coordinate domains
297  /// of both the dense grid and this node, i.e., no bounds checking is performed.
298  /// @note Consider using tools::CopyToDense in tools/Dense.h
299  /// instead of calling this method directly.
300  template<typename DenseT>
301  void copyToDense(const CoordBBox& bbox, DenseT& dense) const;
302 
303  /// @brief Copy from a dense grid into this node the values of the voxels
304  /// that lie within a given bounding box.
305  /// @details Only values that are different (by more than the given tolerance)
306  /// from the background value will be active. Other values are inactive
307  /// and truncated to the background value.
308  ///
309  /// @param bbox inclusive bounding box of the voxels to be copied into this node
310  /// @param dense dense grid with a stride in @e z of one (see tools::Dense
311  /// in tools/Dense.h for the required API)
312  /// @param background background value of the tree that this node belongs to
313  /// @param tolerance tolerance within which a value equals the background value
314  ///
315  /// @note @a bbox is assumed to be identical to or contained in the coordinate domains
316  /// of both the dense grid and this node, i.e., no bounds checking is performed.
317  /// @note Consider using tools::CopyFromDense in tools/Dense.h
318  /// instead of calling this method directly.
319  template<typename DenseT>
320  void copyFromDense(const CoordBBox& bbox, const DenseT& dense, bool background, bool tolerance);
321 
322  /// @brief Return the value of the voxel at the given coordinates.
323  /// @note Used internally by ValueAccessor.
324  template<typename AccessorT>
325  const bool& getValueAndCache(const Coord& xyz, AccessorT&) const {return this->getValue(xyz);}
326 
327  /// @brief Return @c true if the voxel at the given coordinates is active.
328  /// @note Used internally by ValueAccessor.
329  template<typename AccessorT>
330  bool isValueOnAndCache(const Coord& xyz, AccessorT&) const { return this->isValueOn(xyz); }
331 
332  /// @brief Change the value of the voxel at the given coordinates and mark it as active.
333  /// @note Used internally by ValueAccessor.
334  template<typename AccessorT>
335  void setValueAndCache(const Coord& xyz, bool val, AccessorT&) { this->setValueOn(xyz, val); }
336 
337  /// @brief Change the value of the voxel at the given coordinates
338  /// but preserve its state.
339  /// @note Used internally by ValueAccessor.
340  template<typename AccessorT>
341  void setValueOnlyAndCache(const Coord& xyz, bool val, AccessorT&) {this->setValueOnly(xyz,val);}
342 
343  /// @brief Change the value of the voxel at the given coordinates and mark it as inactive.
344  /// @note Used internally by ValueAccessor.
345  template<typename AccessorT>
346  void setValueOffAndCache(const Coord& xyz, bool value, AccessorT&)
347  {
348  this->setValueOff(xyz, value);
349  }
350 
351  /// @brief Apply a functor to the value of the voxel at the given coordinates
352  /// and mark the voxel as active.
353  /// @note Used internally by ValueAccessor.
354  template<typename ModifyOp, typename AccessorT>
355  void modifyValueAndCache(const Coord& xyz, const ModifyOp& op, AccessorT&)
356  {
357  this->modifyValue(xyz, op);
358  }
359 
360  /// Apply a functor to the voxel at the given coordinates.
361  /// @note Used internally by ValueAccessor.
362  template<typename ModifyOp, typename AccessorT>
363  void modifyValueAndActiveStateAndCache(const Coord& xyz, const ModifyOp& op, AccessorT&)
364  {
365  this->modifyValueAndActiveState(xyz, op);
366  }
367 
368  /// @brief Set the active state of the voxel at the given coordinates
369  /// without changing its value.
370  /// @note Used internally by ValueAccessor.
371  template<typename AccessorT>
372  void setActiveStateAndCache(const Coord& xyz, bool on, AccessorT&)
373  {
374  this->setActiveState(xyz, on);
375  }
376 
377  /// @brief Return @c true if the voxel at the given coordinates is active
378  /// and return the voxel value in @a val.
379  /// @note Used internally by ValueAccessor.
380  template<typename AccessorT>
381  bool probeValueAndCache(const Coord& xyz, bool& val, AccessorT&) const
382  {
383  return this->probeValue(xyz, val);
384  }
385 
386  /// @brief Return the LEVEL (=0) at which leaf node values reside.
387  /// @note Used internally by ValueAccessor.
388  template<typename AccessorT>
389  static Index getValueLevelAndCache(const Coord&, AccessorT&) { return LEVEL; }
390 
391  /// @brief Return a const reference to the first entry in the buffer.
392  /// @note Since it's actually a reference to a static data member
393  /// it should not be converted to a non-const pointer!
394  const bool& getFirstValue() const { if (mValueMask.isOn(0)) return Buffer::sOn; else return Buffer::sOff; }
395  /// @brief Return a const reference to the last entry in the buffer.
396  /// @note Since it's actually a reference to a static data member
397  /// it should not be converted to a non-const pointer!
398  const bool& getLastValue() const { if (mValueMask.isOn(SIZE-1)) return Buffer::sOn; else return Buffer::sOff; }
399 
400  /// Return @c true if all of this node's voxels have the same active state
401  /// and are equal to within the given tolerance, and return the value in
402  /// @a constValue and the active state in @a state.
403  bool isConstant(bool& constValue, bool& state, bool tolerance = 0) const;
404 
405  /// @brief Computes the median value of all the active and inactive voxels in this node.
406  /// @return The median value.
407  ///
408  /// @details The median for boolean values is defined as the mode
409  /// of the values, i.e. the value that occurs most often.
410  bool medianAll() const;
411 
412  /// @brief Computes the median value of all the active voxels in this node.
413  /// @return The number of active voxels.
414  /// @param value Updated with the median value of all the active voxels.
415  ///
416  /// @details The median for boolean values is defined as the mode
417  /// of the values, i.e. the value that occurs most often.
418  Index medianOn(ValueType &value) const;
419 
420  /// @brief Computes the median value of all the inactive voxels in this node.
421  /// @return The number of inactive voxels.
422  /// @param value Updated with the median value of all the inactive voxels.
423  ///
424  /// @details The median for boolean values is defined as the mode
425  /// of the values, i.e. the value that occurs most often.
426  Index medianOff(ValueType &value) const;
427 
428  /// Return @c true if all of this node's values are inactive.
429  bool isInactive() const { return mValueMask.isOff(); }
430 
431  void resetBackground(bool oldBackground, bool newBackground);
432 
433  void negate() { mBuffer.mData.toggle(); }
434 
435  template<MergePolicy Policy>
436  void merge(const LeafNode& other, bool bg = false, bool otherBG = false);
437  template<MergePolicy Policy> void merge(bool tileValue, bool tileActive);
438 
439  /// @brief No-op
440  /// @details This function exists only to enable template instantiation.
441  void voxelizeActiveTiles(bool = true) {}
442 
443  /// @brief Union this node's set of active values with the active values
444  /// of the other node, whose @c ValueType may be different. So a
445  /// resulting voxel will be active if either of the original voxels
446  /// were active.
447  ///
448  /// @note This operation modifies only active states, not values.
449  template<typename OtherType>
450  void topologyUnion(const LeafNode<OtherType, Log2Dim>& other);
451 
452  /// @brief Intersect this node's set of active values with the active values
453  /// of the other node, whose @c ValueType may be different. So a
454  /// resulting voxel will be active only if both of the original voxels
455  /// were active.
456  ///
457  /// @details The last dummy argument is required to match the signature
458  /// for InternalNode::topologyIntersection.
459  ///
460  /// @note This operation modifies only active states, not
461  /// values. Also note that this operation can result in all voxels
462  /// being inactive so consider subsequnetly calling prune.
463  template<typename OtherType>
464  void topologyIntersection(const LeafNode<OtherType, Log2Dim>& other, const bool&);
465 
466  /// @brief Difference this node's set of active values with the active values
467  /// of the other node, whose @c ValueType may be different. So a
468  /// resulting voxel will be active only if the original voxel is
469  /// active in this LeafNode and inactive in the other LeafNode.
470  ///
471  /// @details The last dummy argument is required to match the signature
472  /// for InternalNode::topologyDifference.
473  ///
474  /// @note This operation modifies only active states, not values.
475  /// Also, because it can deactivate all of this node's voxels,
476  /// consider subsequently calling prune.
477  template<typename OtherType>
478  void topologyDifference(const LeafNode<OtherType, Log2Dim>& other, const bool&);
479 
480  template<typename CombineOp>
481  void combine(const LeafNode& other, CombineOp& op);
482  template<typename CombineOp>
483  void combine(bool, bool valueIsActive, CombineOp& op);
484 
485  template<typename CombineOp, typename OtherType /*= bool*/>
486  void combine2(const LeafNode& other, const OtherType&, bool valueIsActive, CombineOp&);
487  template<typename CombineOp, typename OtherNodeT /*= LeafNode*/>
488  void combine2(bool, const OtherNodeT& other, bool valueIsActive, CombineOp&);
489  template<typename CombineOp, typename OtherNodeT /*= LeafNode*/>
490  void combine2(const LeafNode& b0, const OtherNodeT& b1, CombineOp&);
491 
492  /// @brief Calls the templated functor BBoxOp with bounding box information.
493  /// An additional level argument is provided to the callback.
494  ///
495  /// @note The bounding boxes are guarenteed to be non-overlapping.
496  template<typename BBoxOp> void visitActiveBBox(BBoxOp&) const;
497 
498  template<typename VisitorOp> void visit(VisitorOp&);
499  template<typename VisitorOp> void visit(VisitorOp&) const;
500 
501  template<typename OtherLeafNodeType, typename VisitorOp>
502  void visit2Node(OtherLeafNodeType& other, VisitorOp&);
503  template<typename OtherLeafNodeType, typename VisitorOp>
504  void visit2Node(OtherLeafNodeType& other, VisitorOp&) const;
505  template<typename IterT, typename VisitorOp>
506  void visit2(IterT& otherIter, VisitorOp&, bool otherIsLHS = false);
507  template<typename IterT, typename VisitorOp>
508  void visit2(IterT& otherIter, VisitorOp&, bool otherIsLHS = false) const;
509 
510  //@{
511  /// This function exists only to enable template instantiation.
512  void prune(const ValueType& /*tolerance*/ = zeroVal<ValueType>()) {}
513  void addLeaf(LeafNode*) {}
514  template<typename AccessorT>
515  void addLeafAndCache(LeafNode*, AccessorT&) {}
516  template<typename NodeT>
517  NodeT* stealNode(const Coord&, const ValueType&, bool) { return nullptr; }
518  template<typename NodeT>
519  NodeT* probeNode(const Coord&) { return nullptr; }
520  template<typename NodeT>
521  const NodeT* probeConstNode(const Coord&) const { return nullptr; }
522  template<typename ArrayT> void getNodes(ArrayT&) const {}
523  template<typename ArrayT> void stealNodes(ArrayT&, const ValueType&, bool) {}
524  //@}
525 
526  void addTile(Index level, const Coord&, bool val, bool active);
527  void addTile(Index offset, bool val, bool active);
528  template<typename AccessorT>
529  void addTileAndCache(Index level, const Coord&, bool val, bool active, AccessorT&);
530 
531  //@{
532  /// @brief Return a pointer to this node.
533  LeafNode* touchLeaf(const Coord&) { return this; }
534  template<typename AccessorT>
535  LeafNode* touchLeafAndCache(const Coord&, AccessorT&) { return this; }
536  LeafNode* probeLeaf(const Coord&) { return this; }
537  template<typename AccessorT>
538  LeafNode* probeLeafAndCache(const Coord&, AccessorT&) { return this; }
539  template<typename NodeT, typename AccessorT>
540  NodeT* probeNodeAndCache(const Coord&, AccessorT&)
541  {
543  if (!(std::is_same<NodeT, LeafNode>::value)) return nullptr;
544  return reinterpret_cast<NodeT*>(this);
546  }
547  //@}
548  //@{
549  /// @brief Return a @const pointer to this node.
550  const LeafNode* probeLeaf(const Coord&) const { return this; }
551  template<typename AccessorT>
552  const LeafNode* probeLeafAndCache(const Coord&, AccessorT&) const { return this; }
553  const LeafNode* probeConstLeaf(const Coord&) const { return this; }
554  template<typename AccessorT>
555  const LeafNode* probeConstLeafAndCache(const Coord&, AccessorT&) const { return this; }
556  template<typename NodeT, typename AccessorT>
557  const NodeT* probeConstNodeAndCache(const Coord&, AccessorT&) const
558  {
560  if (!(std::is_same<NodeT, LeafNode>::value)) return nullptr;
561  return reinterpret_cast<const NodeT*>(this);
563  }
564  //@}
565 
566  //
567  // Iterators
568  //
569 protected:
573 
574  template<typename MaskIterT, typename NodeT, typename ValueT>
575  struct ValueIter:
576  // Derives from SparseIteratorBase, but can also be used as a dense iterator,
577  // if MaskIterT is a dense mask iterator type.
578  public SparseIteratorBase<MaskIterT, ValueIter<MaskIterT, NodeT, ValueT>, NodeT, ValueT>
579  {
581 
583  ValueIter(const MaskIterT& iter, NodeT* parent): BaseT(iter, parent) {}
584 
585  const bool& getItem(Index pos) const { return this->parent().getValue(pos); }
586  const bool& getValue() const { return this->getItem(this->pos()); }
587 
588  // Note: setItem() can't be called on const iterators.
589  void setItem(Index pos, bool value) const { this->parent().setValueOnly(pos, value); }
590  // Note: setValue() can't be called on const iterators.
591  void setValue(bool value) const { this->setItem(this->pos(), value); }
592 
593  // Note: modifyItem() can't be called on const iterators.
594  template<typename ModifyOp>
595  void modifyItem(Index n, const ModifyOp& op) const { this->parent().modifyValue(n, op); }
596  // Note: modifyValue() can't be called on const iterators.
597  template<typename ModifyOp>
598  void modifyValue(const ModifyOp& op) const { this->modifyItem(this->pos(), op); }
599  };
600 
601  /// Leaf nodes have no children, so their child iterators have no get/set accessors.
602  template<typename MaskIterT, typename NodeT>
603  struct ChildIter:
604  public SparseIteratorBase<MaskIterT, ChildIter<MaskIterT, NodeT>, NodeT, bool>
605  {
607  ChildIter(const MaskIterT& iter, NodeT* parent): SparseIteratorBase<
608  MaskIterT, ChildIter<MaskIterT, NodeT>, NodeT, bool>(iter, parent) {}
609  };
610 
611  template<typename NodeT, typename ValueT>
612  struct DenseIter: public DenseIteratorBase<
613  MaskDenseIter, DenseIter<NodeT, ValueT>, NodeT, /*ChildT=*/void, ValueT>
614  {
617 
619  DenseIter(const MaskDenseIter& iter, NodeT* parent): BaseT(iter, parent) {}
620 
621  bool getItem(Index pos, void*& child, NonConstValueT& value) const
622  {
623  value = this->parent().getValue(pos);
624  child = nullptr;
625  return false; // no child
626  }
627 
628  // Note: setItem() can't be called on const iterators.
629  //void setItem(Index pos, void* child) const {}
630 
631  // Note: unsetItem() can't be called on const iterators.
632  void unsetItem(Index pos, const ValueT& val) const {this->parent().setValueOnly(pos, val);}
633  };
634 
635 public:
636  using ValueOnIter = ValueIter<MaskOnIter, LeafNode, const bool>;
637  using ValueOnCIter = ValueIter<MaskOnIter, const LeafNode, const bool>;
638  using ValueOffIter = ValueIter<MaskOffIter, LeafNode, const bool>;
639  using ValueOffCIter = ValueIter<MaskOffIter, const LeafNode, const bool>;
640  using ValueAllIter = ValueIter<MaskDenseIter, LeafNode, const bool>;
641  using ValueAllCIter = ValueIter<MaskDenseIter, const LeafNode, const bool>;
642  using ChildOnIter = ChildIter<MaskOnIter, LeafNode>;
643  using ChildOnCIter = ChildIter<MaskOnIter, const LeafNode>;
644  using ChildOffIter = ChildIter<MaskOffIter, LeafNode>;
645  using ChildOffCIter = ChildIter<MaskOffIter, const LeafNode>;
646  using ChildAllIter = DenseIter<LeafNode, bool>;
647  using ChildAllCIter = DenseIter<const LeafNode, const bool>;
648 
649  ValueOnCIter cbeginValueOn() const { return ValueOnCIter(mValueMask.beginOn(), this); }
650  ValueOnCIter beginValueOn() const { return ValueOnCIter(mValueMask.beginOn(), this); }
651  ValueOnIter beginValueOn() { return ValueOnIter(mValueMask.beginOn(), this); }
652  ValueOffCIter cbeginValueOff() const { return ValueOffCIter(mValueMask.beginOff(), this); }
653  ValueOffCIter beginValueOff() const { return ValueOffCIter(mValueMask.beginOff(), this); }
654  ValueOffIter beginValueOff() { return ValueOffIter(mValueMask.beginOff(), this); }
655  ValueAllCIter cbeginValueAll() const { return ValueAllCIter(mValueMask.beginDense(), this); }
656  ValueAllCIter beginValueAll() const { return ValueAllCIter(mValueMask.beginDense(), this); }
657  ValueAllIter beginValueAll() { return ValueAllIter(mValueMask.beginDense(), this); }
658 
659  ValueOnCIter cendValueOn() const { return ValueOnCIter(mValueMask.endOn(), this); }
660  ValueOnCIter endValueOn() const { return ValueOnCIter(mValueMask.endOn(), this); }
661  ValueOnIter endValueOn() { return ValueOnIter(mValueMask.endOn(), this); }
662  ValueOffCIter cendValueOff() const { return ValueOffCIter(mValueMask.endOff(), this); }
663  ValueOffCIter endValueOff() const { return ValueOffCIter(mValueMask.endOff(), this); }
664  ValueOffIter endValueOff() { return ValueOffIter(mValueMask.endOff(), this); }
665  ValueAllCIter cendValueAll() const { return ValueAllCIter(mValueMask.endDense(), this); }
666  ValueAllCIter endValueAll() const { return ValueAllCIter(mValueMask.endDense(), this); }
667  ValueAllIter endValueAll() { return ValueAllIter(mValueMask.endDense(), this); }
668 
669  // Note that [c]beginChildOn() and [c]beginChildOff() actually return end iterators,
670  // because leaf nodes have no children.
671  ChildOnCIter cbeginChildOn() const { return ChildOnCIter(mValueMask.endOn(), this); }
672  ChildOnCIter beginChildOn() const { return ChildOnCIter(mValueMask.endOn(), this); }
673  ChildOnIter beginChildOn() { return ChildOnIter(mValueMask.endOn(), this); }
674  ChildOffCIter cbeginChildOff() const { return ChildOffCIter(mValueMask.endOff(), this); }
675  ChildOffCIter beginChildOff() const { return ChildOffCIter(mValueMask.endOff(), this); }
676  ChildOffIter beginChildOff() { return ChildOffIter(mValueMask.endOff(), this); }
677  ChildAllCIter cbeginChildAll() const { return ChildAllCIter(mValueMask.beginDense(), this); }
678  ChildAllCIter beginChildAll() const { return ChildAllCIter(mValueMask.beginDense(), this); }
679  ChildAllIter beginChildAll() { return ChildAllIter(mValueMask.beginDense(), this); }
680 
681  ChildOnCIter cendChildOn() const { return ChildOnCIter(mValueMask.endOn(), this); }
682  ChildOnCIter endChildOn() const { return ChildOnCIter(mValueMask.endOn(), this); }
683  ChildOnIter endChildOn() { return ChildOnIter(mValueMask.endOn(), this); }
684  ChildOffCIter cendChildOff() const { return ChildOffCIter(mValueMask.endOff(), this); }
685  ChildOffCIter endChildOff() const { return ChildOffCIter(mValueMask.endOff(), this); }
686  ChildOffIter endChildOff() { return ChildOffIter(mValueMask.endOff(), this); }
687  ChildAllCIter cendChildAll() const { return ChildAllCIter(mValueMask.endDense(), this); }
688  ChildAllCIter endChildAll() const { return ChildAllCIter(mValueMask.endDense(), this); }
689  ChildAllIter endChildAll() { return ChildAllIter(mValueMask.endDense(), this); }
690 
691  //
692  // Mask accessors
693  //
694  bool isValueMaskOn(Index n) const { return mValueMask.isOn(n); }
695  bool isValueMaskOn() const { return mValueMask.isOn(); }
696  bool isValueMaskOff(Index n) const { return mValueMask.isOff(n); }
697  bool isValueMaskOff() const { return mValueMask.isOff(); }
698  const NodeMaskType& getValueMask() const { return mValueMask; }
699  const NodeMaskType& valueMask() const { return mValueMask; }
700  NodeMaskType& getValueMask() { return mValueMask; }
701  void setValueMask(const NodeMaskType& mask) { mValueMask = mask; }
702  bool isChildMaskOn(Index) const { return false; } // leaf nodes have no children
703  bool isChildMaskOff(Index) const { return true; }
704  bool isChildMaskOff() const { return true; }
705 protected:
706  void setValueMask(Index n, bool on) { mValueMask.set(n, on); }
707  void setValueMaskOn(Index n) { mValueMask.setOn(n); }
708  void setValueMaskOff(Index n) { mValueMask.setOff(n); }
709 
710  /// Compute the origin of the leaf node that contains the voxel with the given coordinates.
711  static void evalNodeOrigin(Coord& xyz) { xyz &= ~(DIM - 1); }
712 
713  template<typename NodeT, typename VisitorOp, typename ChildAllIterT>
714  static inline void doVisit(NodeT&, VisitorOp&);
715 
716  template<typename NodeT, typename OtherNodeT, typename VisitorOp,
717  typename ChildAllIterT, typename OtherChildAllIterT>
718  static inline void doVisit2Node(NodeT& self, OtherNodeT& other, VisitorOp&);
719 
720  template<typename NodeT, typename VisitorOp,
721  typename ChildAllIterT, typename OtherChildAllIterT>
722  static inline void doVisit2(NodeT& self, OtherChildAllIterT&, VisitorOp&, bool otherIsLHS);
723 
724 
725  /// Bitmask that determines which voxels are active
727  /// Bitmask representing the values of voxels
729  /// Global grid index coordinates (x,y,z) of the local origin of this node
730  Coord mOrigin;
731 
732 private:
733  /// @brief During topology-only construction, access is needed
734  /// to protected/private members of other template instances.
735  template<typename, Index> friend class LeafNode;
736 
737  friend struct ValueIter<MaskOnIter, LeafNode, bool>;
738  friend struct ValueIter<MaskOffIter, LeafNode, bool>;
739  friend struct ValueIter<MaskDenseIter, LeafNode, bool>;
740  friend struct ValueIter<MaskOnIter, const LeafNode, bool>;
741  friend struct ValueIter<MaskOffIter, const LeafNode, bool>;
742  friend struct ValueIter<MaskDenseIter, const LeafNode, bool>;
743 
744  //@{
745  /// Allow iterators to call mask accessor methods (see below).
746  /// @todo Make mask accessors public?
750  //@}
751 
752 }; // class LeafNode<bool>
753 
754 
755 ////////////////////////////////////////
756 
757 
758 template<Index Log2Dim>
759 inline
761  : mOrigin(0, 0, 0)
762 {
763 }
764 
765 
766 template<Index Log2Dim>
767 inline
768 LeafNode<bool, Log2Dim>::LeafNode(const Coord& xyz, bool value, bool active)
769  : mValueMask(active)
770  , mBuffer(value)
771  , mOrigin(xyz & (~(DIM - 1)))
772 {
773 }
774 
775 
776 template<Index Log2Dim>
777 inline
778 LeafNode<bool, Log2Dim>::LeafNode(PartialCreate, const Coord& xyz, bool value, bool active)
779  : mValueMask(active)
780  , mBuffer(value)
781  , mOrigin(xyz & (~(DIM - 1)))
782 {
783  /// @todo For now, this is identical to the non-PartialCreate constructor.
784  /// Consider modifying the Buffer class to allow it to be constructed
785  /// without allocating a bitmask.
786 }
787 
788 
789 template<Index Log2Dim>
790 inline
792  : mValueMask(other.valueMask())
793  , mBuffer(other.mBuffer)
794  , mOrigin(other.mOrigin)
795 {
796 }
797 
798 
799 // Copy-construct from a leaf node with the same configuration but a different ValueType.
800 template<Index Log2Dim>
801 template<typename ValueT>
802 inline
804  : mValueMask(other.valueMask())
805  , mOrigin(other.origin())
806 {
807  struct Local {
808  /// @todo Consider using a value conversion functor passed as an argument instead.
809  static inline bool convertValue(const ValueT& val) { return bool(val); }
810  };
811 
812  for (Index i = 0; i < SIZE; ++i) {
813  mBuffer.setValue(i, Local::convertValue(other.mBuffer[i]));
814  }
815 }
816 
817 
818 template<Index Log2Dim>
819 template<typename ValueT>
820 inline
822  bool background, TopologyCopy)
823  : mValueMask(other.valueMask())
824  , mBuffer(background)
825  , mOrigin(other.origin())
826 {
827 }
828 
829 
830 template<Index Log2Dim>
831 template<typename ValueT>
832 inline
834  : mValueMask(other.valueMask())
835  , mBuffer(other.valueMask())// value = active state
836  , mOrigin(other.origin())
837 {
838 }
839 
840 
841 template<Index Log2Dim>
842 template<typename ValueT>
843 inline
845  bool offValue, bool onValue, TopologyCopy)
846  : mValueMask(other.valueMask())
847  , mBuffer(other.valueMask())
848  , mOrigin(other.origin())
849 {
850  if (offValue) { if (!onValue) mBuffer.mData.toggle(); else mBuffer.mData.setOn(); }
851 }
852 
853 
854 template<Index Log2Dim>
855 inline
857 {
858 }
859 
860 
861 ////////////////////////////////////////
862 
863 
864 template<Index Log2Dim>
865 inline Index64
867 {
868  // Use sizeof(*this) to capture alignment-related padding
869  return sizeof(*this);
870 }
871 
872 
873 template<Index Log2Dim>
874 inline void
875 LeafNode<bool, Log2Dim>::evalActiveBoundingBox(CoordBBox& bbox, bool visitVoxels) const
876 {
877  CoordBBox this_bbox = this->getNodeBoundingBox();
878  if (bbox.isInside(this_bbox)) return;//this LeafNode is already enclosed in the bbox
879  if (ValueOnCIter iter = this->cbeginValueOn()) {//any active values?
880  if (visitVoxels) {//use voxel granularity?
881  this_bbox.reset();
882  for(; iter; ++iter) this_bbox.expand(this->offsetToLocalCoord(iter.pos()));
883  this_bbox.translate(this->origin());
884  }
885  bbox.expand(this_bbox);
886  }
887 }
888 
889 
890 template<Index Log2Dim>
891 template<typename OtherType, Index OtherLog2Dim>
892 inline bool
894 {
895  assert(other);
896  return (Log2Dim == OtherLog2Dim && mValueMask == other->getValueMask());
897 }
898 
899 
900 template<Index Log2Dim>
901 inline std::string
903 {
904  std::ostringstream ostr;
905  ostr << "LeafNode @" << mOrigin << ": ";
906  for (Index32 n = 0; n < SIZE; ++n) ostr << (mValueMask.isOn(n) ? '#' : '.');
907  return ostr.str();
908 }
909 
910 
911 ////////////////////////////////////////
912 
913 
914 template<Index Log2Dim>
915 inline Index
917 {
918  assert ((xyz[0] & (DIM-1u)) < DIM && (xyz[1] & (DIM-1u)) < DIM && (xyz[2] & (DIM-1u)) < DIM);
919  return ((xyz[0] & (DIM-1u)) << 2*Log2Dim)
920  + ((xyz[1] & (DIM-1u)) << Log2Dim)
921  + (xyz[2] & (DIM-1u));
922 }
923 
924 
925 template<Index Log2Dim>
926 inline Coord
928 {
929  assert(n < (1 << 3*Log2Dim));
930  Coord xyz;
931  xyz.setX(n >> 2*Log2Dim);
932  n &= ((1 << 2*Log2Dim) - 1);
933  xyz.setY(n >> Log2Dim);
934  xyz.setZ(n & ((1 << Log2Dim) - 1));
935  return xyz;
936 }
937 
938 
939 template<Index Log2Dim>
940 inline Coord
942 {
943  return (this->offsetToLocalCoord(n) + this->origin());
944 }
945 
946 
947 ////////////////////////////////////////
948 
949 
950 template<Index Log2Dim>
951 inline void
952 LeafNode<bool, Log2Dim>::readTopology(std::istream& is, bool /*fromHalf*/)
953 {
954  mValueMask.load(is);
955 }
956 
957 
958 template<Index Log2Dim>
959 inline void
960 LeafNode<bool, Log2Dim>::writeTopology(std::ostream& os, bool /*toHalf*/) const
961 {
962  mValueMask.save(os);
963 }
964 
965 
966 template<Index Log2Dim>
967 inline void
968 LeafNode<bool, Log2Dim>::readBuffers(std::istream& is, const CoordBBox& clipBBox, bool fromHalf)
969 {
970  // Boolean LeafNodes don't currently implement lazy loading.
971  // Instead, load the full buffer, then clip it.
972 
973  this->readBuffers(is, fromHalf);
974 
975  // Get this tree's background value.
976  bool background = false;
977  if (const void* bgPtr = io::getGridBackgroundValuePtr(is)) {
978  background = *static_cast<const bool*>(bgPtr);
979  }
980  this->clip(clipBBox, background);
981 }
982 
983 
984 template<Index Log2Dim>
985 inline void
986 LeafNode<bool, Log2Dim>::readBuffers(std::istream& is, bool /*fromHalf*/)
987 {
988  // Read in the value mask.
989  mValueMask.load(is);
990  // Read in the origin.
991  is.read(reinterpret_cast<char*>(&mOrigin), sizeof(Coord::ValueType) * 3);
992 
994  // Read in the mask for the voxel values.
995  mBuffer.mData.load(is);
996  } else {
997  // Older files stored one or more bool arrays.
998 
999  // Read in the number of buffers, which should now always be one.
1000  int8_t numBuffers = 0;
1001  is.read(reinterpret_cast<char*>(&numBuffers), sizeof(int8_t));
1002 
1003  // Read in the buffer.
1004  // (Note: prior to the bool leaf optimization, buffers were always compressed.)
1005  std::unique_ptr<bool[]> buf{new bool[SIZE]};
1006  io::readData<bool>(is, buf.get(), SIZE, /*isCompressed=*/true);
1007 
1008  // Transfer values to mBuffer.
1009  mBuffer.mData.setOff();
1010  for (Index i = 0; i < SIZE; ++i) {
1011  if (buf[i]) mBuffer.mData.setOn(i);
1012  }
1013 
1014  if (numBuffers > 1) {
1015  // Read in and discard auxiliary buffers that were created with
1016  // earlier versions of the library.
1017  for (int i = 1; i < numBuffers; ++i) {
1018  io::readData<bool>(is, buf.get(), SIZE, /*isCompressed=*/true);
1019  }
1020  }
1021  }
1022 }
1023 
1024 
1025 template<Index Log2Dim>
1026 inline void
1027 LeafNode<bool, Log2Dim>::writeBuffers(std::ostream& os, bool /*toHalf*/) const
1028 {
1029  // Write out the value mask.
1030  mValueMask.save(os);
1031  // Write out the origin.
1032  os.write(reinterpret_cast<const char*>(&mOrigin), sizeof(Coord::ValueType) * 3);
1033  // Write out the voxel values.
1034  mBuffer.mData.save(os);
1035 }
1036 
1037 
1038 ////////////////////////////////////////
1039 
1040 
1041 template<Index Log2Dim>
1042 inline bool
1044 {
1045  return mOrigin == other.mOrigin &&
1046  mValueMask == other.valueMask() &&
1047  mBuffer == other.mBuffer;
1048 }
1049 
1050 
1051 template<Index Log2Dim>
1052 inline bool
1054 {
1055  return !(this->operator==(other));
1056 }
1057 
1058 
1059 ////////////////////////////////////////
1060 
1061 
1062 template<Index Log2Dim>
1063 inline bool
1064 LeafNode<bool, Log2Dim>::isConstant(bool& constValue, bool& state, bool tolerance) const
1065 {
1066  if (!mValueMask.isConstant(state)) return false;
1067 
1068  // Note: if tolerance is true (i.e., 1), then all boolean values compare equal.
1069  if (!tolerance && !(mBuffer.mData.isOn() || mBuffer.mData.isOff())) return false;
1070 
1071  constValue = mBuffer.mData.isOn();
1072  return true;
1073 }
1074 
1075 ////////////////////////////////////////
1076 
1077 template<Index Log2Dim>
1078 inline bool
1080 {
1081  const Index countTrue = mBuffer.mData.countOn();
1082  return countTrue > (NUM_VALUES >> 1);
1083 }
1084 
1085 template<Index Log2Dim>
1086 inline Index
1088 {
1089  const NodeMaskType tmp = mBuffer.mData & mValueMask;//both true and active
1090  const Index countTrueOn = tmp.countOn(), countOn = mValueMask.countOn();
1091  state = countTrueOn > (NUM_VALUES >> 1);
1092  return countOn;
1093 }
1094 
1095 template<Index Log2Dim>
1096 inline Index
1098 {
1099  const NodeMaskType tmp = mBuffer.mData & (!mValueMask);//both true and inactive
1100  const Index countTrueOff = tmp.countOn(), countOff = mValueMask.countOff();
1101  state = countTrueOff > (NUM_VALUES >> 1);
1102  return countOff;
1103 }
1104 
1105 ////////////////////////////////////////
1106 
1107 
1108 template<Index Log2Dim>
1109 inline void
1110 LeafNode<bool, Log2Dim>::addTile(Index /*level*/, const Coord& xyz, bool val, bool active)
1111 {
1112  this->addTile(this->coordToOffset(xyz), val, active);
1113 }
1114 
1115 template<Index Log2Dim>
1116 inline void
1118 {
1119  assert(offset < SIZE);
1120  this->setValueOnly(offset, val);
1121  this->setActiveState(offset, active);
1122 }
1123 
1124 template<Index Log2Dim>
1125 template<typename AccessorT>
1126 inline void
1128  bool val, bool active, AccessorT&)
1129 {
1130  this->addTile(level, xyz, val, active);
1131 }
1132 
1133 
1134 ////////////////////////////////////////
1135 
1136 
1137 template<Index Log2Dim>
1138 inline const bool&
1139 LeafNode<bool, Log2Dim>::getValue(const Coord& xyz) const
1140 {
1141  // This *CANNOT* use operator ? because Visual C++
1142  if (mBuffer.mData.isOn(this->coordToOffset(xyz))) return Buffer::sOn; else return Buffer::sOff;
1143 }
1144 
1145 
1146 template<Index Log2Dim>
1147 inline const bool&
1149 {
1150  assert(offset < SIZE);
1151  // This *CANNOT* use operator ? for Windows
1152  if (mBuffer.mData.isOn(offset)) return Buffer::sOn; else return Buffer::sOff;
1153 }
1154 
1155 
1156 template<Index Log2Dim>
1157 inline bool
1158 LeafNode<bool, Log2Dim>::probeValue(const Coord& xyz, bool& val) const
1159 {
1160  const Index offset = this->coordToOffset(xyz);
1161  val = mBuffer.mData.isOn(offset);
1162  return mValueMask.isOn(offset);
1163 }
1164 
1165 
1166 template<Index Log2Dim>
1167 inline void
1169 {
1170  this->setValueOn(this->coordToOffset(xyz), val);
1171 }
1172 
1173 
1174 template<Index Log2Dim>
1175 inline void
1177 {
1178  assert(offset < SIZE);
1179  mValueMask.setOn(offset);
1180  mBuffer.mData.set(offset, val);
1181 }
1182 
1183 
1184 template<Index Log2Dim>
1185 inline void
1187 {
1188  this->setValueOnly(this->coordToOffset(xyz), val);
1189 }
1190 
1191 
1192 template<Index Log2Dim>
1193 inline void
1195 {
1196  mValueMask.set(this->coordToOffset(xyz), on);
1197 }
1198 
1199 
1200 template<Index Log2Dim>
1201 inline void
1203 {
1204  this->setValueOff(this->coordToOffset(xyz), val);
1205 }
1206 
1207 
1208 template<Index Log2Dim>
1209 inline void
1211 {
1212  assert(offset < SIZE);
1213  mValueMask.setOff(offset);
1214  mBuffer.mData.set(offset, val);
1215 }
1216 
1217 
1218 template<Index Log2Dim>
1219 template<typename ModifyOp>
1220 inline void
1222 {
1223  bool val = mBuffer.mData.isOn(offset);
1224  op(val);
1225  mBuffer.mData.set(offset, val);
1226  mValueMask.setOn(offset);
1227 }
1228 
1229 
1230 template<Index Log2Dim>
1231 template<typename ModifyOp>
1232 inline void
1233 LeafNode<bool, Log2Dim>::modifyValue(const Coord& xyz, const ModifyOp& op)
1234 {
1235  this->modifyValue(this->coordToOffset(xyz), op);
1236 }
1237 
1238 
1239 template<Index Log2Dim>
1240 template<typename ModifyOp>
1241 inline void
1242 LeafNode<bool, Log2Dim>::modifyValueAndActiveState(const Coord& xyz, const ModifyOp& op)
1243 {
1244  const Index offset = this->coordToOffset(xyz);
1245  bool val = mBuffer.mData.isOn(offset), state = mValueMask.isOn(offset);
1246  op(val, state);
1247  mBuffer.mData.set(offset, val);
1248  mValueMask.set(offset, state);
1249 }
1250 
1251 
1252 ////////////////////////////////////////
1253 
1254 
1255 template<Index Log2Dim>
1256 inline void
1257 LeafNode<bool, Log2Dim>::resetBackground(bool oldBackground, bool newBackground)
1258 {
1259  if (newBackground != oldBackground) {
1260  // Flip mBuffer's background bits and zero its foreground bits.
1261  NodeMaskType bgMask = !(mBuffer.mData | mValueMask);
1262  // Overwrite mBuffer's background bits, leaving its foreground bits intact.
1263  mBuffer.mData = (mBuffer.mData & mValueMask) | bgMask;
1264  }
1265 }
1266 
1267 
1268 ////////////////////////////////////////
1269 
1270 
1271 template<Index Log2Dim>
1272 template<MergePolicy Policy>
1273 inline void
1274 LeafNode<bool, Log2Dim>::merge(const LeafNode& other, bool /*bg*/, bool /*otherBG*/)
1275 {
1277  if (Policy == MERGE_NODES) return;
1278  for (typename NodeMaskType::OnIterator iter = other.valueMask().beginOn(); iter; ++iter) {
1279  const Index n = iter.pos();
1280  if (mValueMask.isOff(n)) {
1281  mBuffer.mData.set(n, other.mBuffer.mData.isOn(n));
1282  mValueMask.setOn(n);
1283  }
1284  }
1286 }
1287 
1288 template<Index Log2Dim>
1289 template<MergePolicy Policy>
1290 inline void
1291 LeafNode<bool, Log2Dim>::merge(bool tileValue, bool tileActive)
1292 {
1294  if (Policy != MERGE_ACTIVE_STATES_AND_NODES) return;
1295  if (!tileActive) return;
1296  // Replace all inactive values with the active tile value.
1297  if (tileValue) mBuffer.mData |= !mValueMask; // -0=>1, +0=>0, -1=>1, +1=>1 (-,+ = off,on)
1298  else mBuffer.mData &= mValueMask; // -0=>0, +0=>0, -1=>0, +1=>1
1299  mValueMask.setOn();
1301 }
1302 
1303 
1304 ////////////////////////////////////////
1305 
1306 
1307 template<Index Log2Dim>
1308 template<typename OtherType>
1309 inline void
1311 {
1312  mValueMask |= other.valueMask();
1313 }
1314 
1315 
1316 template<Index Log2Dim>
1317 template<typename OtherType>
1318 inline void
1320  const bool&)
1321 {
1322  mValueMask &= other.valueMask();
1323 }
1324 
1325 
1326 template<Index Log2Dim>
1327 template<typename OtherType>
1328 inline void
1330  const bool&)
1331 {
1332  mValueMask &= !other.valueMask();
1333 }
1334 
1335 
1336 ////////////////////////////////////////
1337 
1338 
1339 template<Index Log2Dim>
1340 inline void
1341 LeafNode<bool, Log2Dim>::clip(const CoordBBox& clipBBox, bool background)
1342 {
1343  CoordBBox nodeBBox = this->getNodeBoundingBox();
1344  if (!clipBBox.hasOverlap(nodeBBox)) {
1345  // This node lies completely outside the clipping region. Fill it with background tiles.
1346  this->fill(nodeBBox, background, /*active=*/false);
1347  } else if (clipBBox.isInside(nodeBBox)) {
1348  // This node lies completely inside the clipping region. Leave it intact.
1349  return;
1350  }
1351 
1352  // This node isn't completely contained inside the clipping region.
1353  // Set any voxels that lie outside the region to the background value.
1354 
1355  // Construct a boolean mask that is on inside the clipping region and off outside it.
1357  nodeBBox.intersect(clipBBox);
1358  Coord xyz;
1359  int &x = xyz.x(), &y = xyz.y(), &z = xyz.z();
1360  for (x = nodeBBox.min().x(); x <= nodeBBox.max().x(); ++x) {
1361  for (y = nodeBBox.min().y(); y <= nodeBBox.max().y(); ++y) {
1362  for (z = nodeBBox.min().z(); z <= nodeBBox.max().z(); ++z) {
1363  mask.setOn(static_cast<Index32>(this->coordToOffset(xyz)));
1364  }
1365  }
1366  }
1367 
1368  // Set voxels that lie in the inactive region of the mask (i.e., outside
1369  // the clipping region) to the background value.
1370  for (MaskOffIter maskIter = mask.beginOff(); maskIter; ++maskIter) {
1371  this->setValueOff(maskIter.pos(), background);
1372  }
1373 }
1374 
1375 
1376 ////////////////////////////////////////
1377 
1378 
1379 template<Index Log2Dim>
1380 inline void
1381 LeafNode<bool, Log2Dim>::fill(const CoordBBox& bbox, bool value, bool active)
1382 {
1383  auto clippedBBox = this->getNodeBoundingBox();
1384  clippedBBox.intersect(bbox);
1385  if (!clippedBBox) return;
1386 
1387  for (Int32 x = clippedBBox.min().x(); x <= clippedBBox.max().x(); ++x) {
1388  const Index offsetX = (x & (DIM-1u))<<2*Log2Dim;
1389  for (Int32 y = clippedBBox.min().y(); y <= clippedBBox.max().y(); ++y) {
1390  const Index offsetXY = offsetX + ((y & (DIM-1u))<< Log2Dim);
1391  for (Int32 z = clippedBBox.min().z(); z <= clippedBBox.max().z(); ++z) {
1392  const Index offset = offsetXY + (z & (DIM-1u));
1393  mValueMask.set(offset, active);
1394  mBuffer.mData.set(offset, value);
1395  }
1396  }
1397  }
1398 }
1399 
1400 template<Index Log2Dim>
1401 inline void
1403 {
1404  mBuffer.fill(value);
1405 }
1406 
1407 template<Index Log2Dim>
1408 inline void
1409 LeafNode<bool, Log2Dim>::fill(const bool& value, bool active)
1410 {
1411  mBuffer.fill(value);
1412  mValueMask.set(active);
1413 }
1414 
1415 
1416 ////////////////////////////////////////
1417 
1418 
1419 template<Index Log2Dim>
1420 template<typename DenseT>
1421 inline void
1422 LeafNode<bool, Log2Dim>::copyToDense(const CoordBBox& bbox, DenseT& dense) const
1423 {
1424  using DenseValueType = typename DenseT::ValueType;
1425 
1426  const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1427  const Coord& min = dense.bbox().min();
1428  DenseValueType* t0 = dense.data() + zStride * (bbox.min()[2] - min[2]); // target array
1429  const Int32 n0 = bbox.min()[2] & (DIM-1u);
1430  for (Int32 x = bbox.min()[0], ex = bbox.max()[0] + 1; x < ex; ++x) {
1431  DenseValueType* t1 = t0 + xStride * (x - min[0]);
1432  const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1433  for (Int32 y = bbox.min()[1], ey = bbox.max()[1] + 1; y < ey; ++y) {
1434  DenseValueType* t2 = t1 + yStride * (y - min[1]);
1435  Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1436  for (Int32 z = bbox.min()[2], ez = bbox.max()[2] + 1; z < ez; ++z, t2 += zStride) {
1437  *t2 = DenseValueType(mBuffer.mData.isOn(n2++));
1438  }
1439  }
1440  }
1441 }
1442 
1443 
1444 template<Index Log2Dim>
1445 template<typename DenseT>
1446 inline void
1447 LeafNode<bool, Log2Dim>::copyFromDense(const CoordBBox& bbox, const DenseT& dense,
1448  bool background, bool tolerance)
1449 {
1450  using DenseValueType = typename DenseT::ValueType;
1451  struct Local {
1452  inline static bool toBool(const DenseValueType& v) { return !math::isZero(v); }
1453  };
1454 
1455  const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1456  const Coord& min = dense.bbox().min();
1457  const DenseValueType* s0 = dense.data() + zStride * (bbox.min()[2] - min[2]); // source
1458  const Int32 n0 = bbox.min()[2] & (DIM-1u);
1459  for (Int32 x = bbox.min()[0], ex = bbox.max()[0] + 1; x < ex; ++x) {
1460  const DenseValueType* s1 = s0 + xStride * (x - min[0]);
1461  const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1462  for (Int32 y = bbox.min()[1], ey = bbox.max()[1] + 1; y < ey; ++y) {
1463  const DenseValueType* s2 = s1 + yStride * (y - min[1]);
1464  Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1465  for (Int32 z = bbox.min()[2], ez = bbox.max()[2]+1; z < ez; ++z, ++n2, s2 += zStride) {
1466  // Note: if tolerance is true (i.e., 1), then all boolean values compare equal.
1467  if (tolerance || (background == Local::toBool(*s2))) {
1468  mValueMask.setOff(n2);
1469  mBuffer.mData.set(n2, background);
1470  } else {
1471  mValueMask.setOn(n2);
1472  mBuffer.mData.set(n2, Local::toBool(*s2));
1473  }
1474  }
1475  }
1476  }
1477 }
1478 
1479 
1480 ////////////////////////////////////////
1481 
1482 
1483 template<Index Log2Dim>
1484 template<typename CombineOp>
1485 inline void
1486 LeafNode<bool, Log2Dim>::combine(const LeafNode& other, CombineOp& op)
1487 {
1489  for (Index i = 0; i < SIZE; ++i) {
1490  bool result = false, aVal = mBuffer.mData.isOn(i), bVal = other.mBuffer.mData.isOn(i);
1491  op(args.setARef(aVal)
1492  .setAIsActive(mValueMask.isOn(i))
1493  .setBRef(bVal)
1494  .setBIsActive(other.valueMask().isOn(i))
1495  .setResultRef(result));
1496  mValueMask.set(i, args.resultIsActive());
1497  mBuffer.mData.set(i, result);
1498  }
1499 }
1500 
1501 
1502 template<Index Log2Dim>
1503 template<typename CombineOp>
1504 inline void
1505 LeafNode<bool, Log2Dim>::combine(bool value, bool valueIsActive, CombineOp& op)
1506 {
1508  args.setBRef(value).setBIsActive(valueIsActive);
1509  for (Index i = 0; i < SIZE; ++i) {
1510  bool result = false, aVal = mBuffer.mData.isOn(i);
1511  op(args.setARef(aVal)
1512  .setAIsActive(mValueMask.isOn(i))
1513  .setResultRef(result));
1514  mValueMask.set(i, args.resultIsActive());
1515  mBuffer.mData.set(i, result);
1516  }
1517 }
1518 
1519 
1520 ////////////////////////////////////////
1521 
1522 
1523 template<Index Log2Dim>
1524 template<typename CombineOp, typename OtherType>
1525 inline void
1526 LeafNode<bool, Log2Dim>::combine2(const LeafNode& other, const OtherType& value,
1527  bool valueIsActive, CombineOp& op)
1528 {
1530  args.setBRef(value).setBIsActive(valueIsActive);
1531  for (Index i = 0; i < SIZE; ++i) {
1532  bool result = false, aVal = other.mBuffer.mData.isOn(i);
1533  op(args.setARef(aVal)
1534  .setAIsActive(other.valueMask().isOn(i))
1535  .setResultRef(result));
1536  mValueMask.set(i, args.resultIsActive());
1537  mBuffer.mData.set(i, result);
1538  }
1539 }
1540 
1541 
1542 template<Index Log2Dim>
1543 template<typename CombineOp, typename OtherNodeT>
1544 inline void
1545 LeafNode<bool, Log2Dim>::combine2(bool value, const OtherNodeT& other,
1546  bool valueIsActive, CombineOp& op)
1547 {
1549  args.setARef(value).setAIsActive(valueIsActive);
1550  for (Index i = 0; i < SIZE; ++i) {
1551  bool result = false, bVal = other.mBuffer.mData.isOn(i);
1552  op(args.setBRef(bVal)
1553  .setBIsActive(other.valueMask().isOn(i))
1554  .setResultRef(result));
1555  mValueMask.set(i, args.resultIsActive());
1556  mBuffer.mData.set(i, result);
1557  }
1558 }
1559 
1560 
1561 template<Index Log2Dim>
1562 template<typename CombineOp, typename OtherNodeT>
1563 inline void
1564 LeafNode<bool, Log2Dim>::combine2(const LeafNode& b0, const OtherNodeT& b1, CombineOp& op)
1565 {
1567  for (Index i = 0; i < SIZE; ++i) {
1568  // Default behavior: output voxel is active if either input voxel is active.
1569  mValueMask.set(i, b0.valueMask().isOn(i) || b1.valueMask().isOn(i));
1570 
1571  bool result = false, b0Val = b0.mBuffer.mData.isOn(i), b1Val = b1.mBuffer.mData.isOn(i);
1572  op(args.setARef(b0Val)
1573  .setAIsActive(b0.valueMask().isOn(i))
1574  .setBRef(b1Val)
1575  .setBIsActive(b1.valueMask().isOn(i))
1576  .setResultRef(result));
1577  mValueMask.set(i, args.resultIsActive());
1578  mBuffer.mData.set(i, result);
1579  }
1580 }
1581 
1582 
1583 ////////////////////////////////////////
1584 
1585 template<Index Log2Dim>
1586 template<typename BBoxOp>
1587 inline void
1589 {
1590  if (op.template descent<LEVEL>()) {
1591  for (ValueOnCIter i=this->cbeginValueOn(); i; ++i) {
1592  op.template operator()<LEVEL>(CoordBBox::createCube(i.getCoord(), 1));
1593  }
1594  } else {
1595  op.template operator()<LEVEL>(this->getNodeBoundingBox());
1596  }
1597 }
1598 
1599 
1600 template<Index Log2Dim>
1601 template<typename VisitorOp>
1602 inline void
1604 {
1605  doVisit<LeafNode, VisitorOp, ChildAllIter>(*this, op);
1606 }
1607 
1608 
1609 template<Index Log2Dim>
1610 template<typename VisitorOp>
1611 inline void
1613 {
1614  doVisit<const LeafNode, VisitorOp, ChildAllCIter>(*this, op);
1615 }
1616 
1617 
1618 template<Index Log2Dim>
1619 template<typename NodeT, typename VisitorOp, typename ChildAllIterT>
1620 inline void
1621 LeafNode<bool, Log2Dim>::doVisit(NodeT& self, VisitorOp& op)
1622 {
1623  for (ChildAllIterT iter = self.beginChildAll(); iter; ++iter) {
1624  op(iter);
1625  }
1626 }
1627 
1628 
1629 ////////////////////////////////////////
1630 
1631 
1632 template<Index Log2Dim>
1633 template<typename OtherLeafNodeType, typename VisitorOp>
1634 inline void
1635 LeafNode<bool, Log2Dim>::visit2Node(OtherLeafNodeType& other, VisitorOp& op)
1636 {
1637  doVisit2Node<LeafNode, OtherLeafNodeType, VisitorOp, ChildAllIter,
1638  typename OtherLeafNodeType::ChildAllIter>(*this, other, op);
1639 }
1640 
1641 
1642 template<Index Log2Dim>
1643 template<typename OtherLeafNodeType, typename VisitorOp>
1644 inline void
1645 LeafNode<bool, Log2Dim>::visit2Node(OtherLeafNodeType& other, VisitorOp& op) const
1646 {
1647  doVisit2Node<const LeafNode, OtherLeafNodeType, VisitorOp, ChildAllCIter,
1648  typename OtherLeafNodeType::ChildAllCIter>(*this, other, op);
1649 }
1650 
1651 
1652 template<Index Log2Dim>
1653 template<
1654  typename NodeT,
1655  typename OtherNodeT,
1656  typename VisitorOp,
1657  typename ChildAllIterT,
1658  typename OtherChildAllIterT>
1659 inline void
1660 LeafNode<bool, Log2Dim>::doVisit2Node(NodeT& self, OtherNodeT& other, VisitorOp& op)
1661 {
1662  // Allow the two nodes to have different ValueTypes, but not different dimensions.
1663  static_assert(OtherNodeT::SIZE == NodeT::SIZE,
1664  "can't visit nodes of different sizes simultaneously");
1665  static_assert(OtherNodeT::LEVEL == NodeT::LEVEL,
1666  "can't visit nodes at different tree levels simultaneously");
1667 
1668  ChildAllIterT iter = self.beginChildAll();
1669  OtherChildAllIterT otherIter = other.beginChildAll();
1670 
1671  for ( ; iter && otherIter; ++iter, ++otherIter) {
1672  op(iter, otherIter);
1673  }
1674 }
1675 
1676 
1677 ////////////////////////////////////////
1678 
1679 
1680 template<Index Log2Dim>
1681 template<typename IterT, typename VisitorOp>
1682 inline void
1683 LeafNode<bool, Log2Dim>::visit2(IterT& otherIter, VisitorOp& op, bool otherIsLHS)
1684 {
1685  doVisit2<LeafNode, VisitorOp, ChildAllIter, IterT>(*this, otherIter, op, otherIsLHS);
1686 }
1687 
1688 
1689 template<Index Log2Dim>
1690 template<typename IterT, typename VisitorOp>
1691 inline void
1692 LeafNode<bool, Log2Dim>::visit2(IterT& otherIter, VisitorOp& op, bool otherIsLHS) const
1693 {
1694  doVisit2<const LeafNode, VisitorOp, ChildAllCIter, IterT>(*this, otherIter, op, otherIsLHS);
1695 }
1696 
1697 
1698 template<Index Log2Dim>
1699 template<
1700  typename NodeT,
1701  typename VisitorOp,
1702  typename ChildAllIterT,
1703  typename OtherChildAllIterT>
1704 inline void
1705 LeafNode<bool, Log2Dim>::doVisit2(NodeT& self, OtherChildAllIterT& otherIter,
1706  VisitorOp& op, bool otherIsLHS)
1707 {
1708  if (!otherIter) return;
1709 
1710  if (otherIsLHS) {
1711  for (ChildAllIterT iter = self.beginChildAll(); iter; ++iter) {
1712  op(otherIter, iter);
1713  }
1714  } else {
1715  for (ChildAllIterT iter = self.beginChildAll(); iter; ++iter) {
1716  op(iter, otherIter);
1717  }
1718  }
1719 }
1720 
1721 } // namespace tree
1722 } // namespace OPENVDB_VERSION_NAME
1723 } // namespace openvdb
1724 
1725 #endif // OPENVDB_TREE_LEAF_NODE_BOOL_HAS_BEEN_INCLUDED
void getNodes(ArrayT &) const
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:522
void setValueOffAndCache(const Coord &xyz, bool value, AccessorT &)
Change the value of the voxel at the given coordinates and mark it as inactive.
Definition: LeafNodeBool.h:346
void setValuesOff()
Mark all voxels as inactive but don't change their values.
Definition: LeafNodeBool.h:266
static void getNodeLog2Dims(std::vector< Index > &dims)
Definition: LeafNodeBool.h:108
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition: LeafNodeBool.h:239
This struct collects both input and output arguments to "grid combiner" functors used with the tree::...
Definition: Types.h:931
OPENVDB_API const void * getGridBackgroundValuePtr(std::ios_base &)
Return a pointer to the background value of the grid currently being read from or written to the give...
void setValuesOn()
Mark all voxels as active but don't change their values.
Definition: LeafNodeBool.h:264
bool isValueOn(const Coord &xyz) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNodeBool.h:269
const NodeMaskType & valueMask() const
Definition: LeafNode.h:869
void setValueOff(Index offset)
Mark the voxel at the given offset as inactive but don't change its value.
Definition: LeafNodeBool.h:231
Index32 countOn() const
Return the total number of on bits.
Definition: NodeMasks.h:443
const bool & getValueAndCache(const Coord &xyz, AccessorT &) const
Return the value of the voxel at the given coordinates.
Definition: LeafNodeBool.h:325
void readBuffers(std::istream &is, bool fromHalf=false)
Read buffers from a stream.
Definition: LeafNode.h:1322
ChildIter< MaskOffIterator, LeafNode, ChildOff > ChildOffIter
Definition: LeafNode.h:286
ValueIter< MaskOnIter, const LeafNode, const bool > ValueOnCIter
Definition: LeafNodeBool.h:637
void setValueOnly(const Coord &xyz, const ValueType &val)
Set the value of the voxel at the given coordinates but don't change its active state.
Definition: LeafNode.h:1121
void readTopology(std::istream &is, bool fromHalf=false)
Read in just the topology.
Definition: LeafNode.h:1286
void setValueAndCache(const Coord &xyz, bool val, AccessorT &)
Change the value of the voxel at the given coordinates and mark it as active.
Definition: LeafNodeBool.h:335
LeafNode specialization for values of type bool that stores both the active states and the values of ...
Definition: LeafNodeBool.h:28
const ValueType & getValue(const Coord &xyz) const
Return the value of the voxel at the given coordinates.
Definition: LeafNode.h:1063
const Args & args
Definition: printf.h:628
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition: LeafNode.h:411
void getOrigin(Int32 &x, Int32 &y, Int32 &z) const
Return the grid index coordinates of this node's local origin.
Definition: LeafNodeBool.h:156
Index64 offVoxelCount() const
Return the number of inactive voxels.
Definition: LeafNodeBool.h:119
bool isConstant(ValueType &firstValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const
Definition: LeafNode.h:1477
const LeafNode * probeConstLeaf(const Coord &) const
Return a pointer to this node.
Definition: LeafNodeBool.h:553
GLuint const GLfloat * val
Definition: glew.h:2794
LeafNode * probeLeaf(const Coord &)
Return a pointer to this node.
Definition: LeafNodeBool.h:536
static void doVisit(NodeT &, VisitorOp &)
Definition: LeafNode.h:1856
static Index log2dim()
Return log2 of the size of the buffer storage.
Definition: LeafNodeBool.h:102
void setOff(Index32 n)
Set the nth bit off.
Definition: NodeMasks.h:457
Index pos() const
Identical to offset.
Definition: Iterator.h:60
void swap(Buffer &other)
Exchange this node's data buffer with the given data buffer without changing the active states of the...
Definition: LeafNodeBool.h:184
const LeafNode * probeConstLeafAndCache(const Coord &, AccessorT &) const
Return a pointer to this node.
Definition: LeafNodeBool.h:555
const bool & getLastValue() const
Return a const reference to the last entry in the buffer.
Definition: LeafNodeBool.h:398
LeafNode * touchLeaf(const Coord &)
Return a pointer to this node.
Definition: LeafNodeBool.h:533
void addLeaf(LeafNode *)
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:513
Index64 memUsage() const
Return the memory in bytes occupied by this node.
Definition: LeafNode.h:1441
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:166
Coord mOrigin
Global grid index coordinates (x,y,z) of the local origin of this node.
Definition: LeafNodeBool.h:730
NodeT * stealNode(const Coord &, const ValueType &, bool)
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:517
Base class for iterators over internal and leaf nodes.
Definition: Iterator.h:29
ChildIter< MaskOnIterator, const LeafNode, ChildOn > ChildOnCIter
Definition: LeafNode.h:285
ChildIter< MaskOnIter, const LeafNode > ChildOnCIter
Definition: LeafNodeBool.h:643
ChildIter< MaskOnIterator, LeafNode, ChildOn > ChildOnIter
Definition: LeafNode.h:284
const GLdouble * v
Definition: glew.h:1391
DenseIter< const LeafNode, const bool > ChildAllCIter
Definition: LeafNodeBool.h:647
void clip(const CoordBBox &, const ValueType &background)
Set all voxels that lie outside the given axis-aligned box to the background.
Definition: LeafNode.h:1139
GLenum GLint GLuint mask
Definition: glew.h:1845
bool allocate()
Allocate memory for this node's buffer if it has not already been allocated.
Definition: LeafNodeBool.h:136
void topologyUnion(const LeafNode< OtherType, Log2Dim > &other)
Union this node's set of active values with the active values of the other node, whose ValueType may ...
Definition: LeafNode.h:1681
NodeT & parent() const
Return a reference to the node over which this iterator is iterating.
Definition: Iterator.h:50
const NodeT * probeConstNode(const Coord &) const
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:521
void topologyIntersection(const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
Intersect this node's set of active values with the active values of the other node, whose ValueType may be different. So a resulting voxel will be active only if both of the original voxels were active.
Definition: LeafNode.h:1689
const LeafNode * probeLeaf(const Coord &) const
Return a pointer to this node.
Definition: LeafNodeBool.h:550
Tag dispatch class that distinguishes constructors during file input.
Definition: Types.h:1047
void setActiveState(const Coord &xyz, bool on)
Set the active state of the voxel at the given coordinates but don't change its value.
Definition: LeafNode.h:1113
ValueIter< MaskDenseIter, LeafNode, const bool > ValueAllIter
Definition: LeafNodeBool.h:640
ValueIter< MaskOffIterator, const LeafNode, const ValueType, ValueOff > ValueOffCIter
Definition: LeafNode.h:281
static Index getValueLevelAndCache(const Coord &, AccessorT &)
Return the LEVEL (=0) at which leaf node values reside.
Definition: LeafNodeBool.h:389
static Coord offsetToLocalCoord(Index n)
Return the local coordinates for a linear table offset, where offset 0 has coordinates (0...
Definition: LeafNode.h:1038
Index32 countOff() const
Return the total number of on bits.
Definition: NodeMasks.h:450
void writeBuffers(std::ostream &os, bool toHalf=false) const
Write buffers to a stream.
Definition: LeafNode.h:1414
ValueIter< MaskDenseIterator, LeafNode, const ValueType, ValueAll > ValueAllIter
Definition: LeafNode.h:282
GLdouble GLdouble z
Definition: glew.h:1559
const Coord & origin() const
Return the grid index coordinates of this node's local origin.
Definition: LeafNodeBool.h:154
std::shared_ptr< T > SharedPtr
Definition: Types.h:91
bool isValueOn(Index offset) const
Return true if the voxel at the given offset is active.
Definition: LeafNodeBool.h:271
bool isValueOn(const Coord &xyz) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNode.h:469
void stealNodes(ArrayT &, const ValueType &, bool)
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:523
void modifyValue(Index offset, const ModifyOp &op)
Apply a functor to the value of the voxel at the given offset and mark the voxel as active...
Definition: LeafNode.h:429
const LeafNode * probeLeafAndCache(const Coord &, AccessorT &) const
Return a pointer to this node.
Definition: LeafNodeBool.h:552
OffMaskIterator< NodeMask > OffIterator
Definition: NodeMasks.h:349
Buffer mBuffer
Bitmask representing the values of voxels.
Definition: LeafNodeBool.h:728
void save(std::ostream &os) const
Definition: NodeMasks.h:565
ValueIter< MaskOnIter, LeafNode, const bool > ValueOnIter
Definition: LeafNodeBool.h:636
void setValueOff(const Coord &xyz)
Mark the voxel at the given coordinates as inactive but don't change its value.
Definition: LeafNodeBool.h:229
GLint GLint GLint GLint GLint x
Definition: glew.h:1252
GLint GLint GLint GLint GLint GLint y
Definition: glew.h:1252
bool isOn(Index32 n) const
Return true if the nth bit is on.
Definition: NodeMasks.h:502
Bit mask for the internal and leaf nodes of VDB. This is a 64-bit implementation. ...
Definition: NodeMasks.h:307
void swap(LeafBuffer &)
Exchange this buffer's values with the other buffer's values.
Definition: LeafBuffer.h:275
*But if you need a or simply need to know when the task has note that the like this
Definition: thread.h:639
void addTile(Index level, const Coord &, const ValueType &, bool)
Definition: LeafNode.h:1582
void denseFill(const CoordBBox &bbox, bool val, bool on=true)
Set all voxels within an axis-aligned box to the specified value and active state.
Definition: LeafNodeBool.h:282
Index64 onVoxelCount() const
Return the number of voxels marked On.
Definition: LeafNode.h:140
static bool hasActiveTiles()
Return false since leaf nodes never contain tiles.
Definition: LeafNodeBool.h:274
Templated block class to hold specific data types and a fixed number of values determined by Log2Dim...
Definition: LeafNode.h:37
void topologyDifference(const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
Difference this node's set of active values with the active values of the other node, whose ValueType may be different. So a resulting voxel will be active only if the original voxel is active in this LeafNode and inactive in the other LeafNode.
Definition: LeafNode.h:1698
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
ValueIter< MaskOnIterator, LeafNode, const ValueType, ValueOn > ValueOnIter
Definition: LeafNode.h:278
void copyToDense(const CoordBBox &bbox, DenseT &dense) const
Copy into a dense grid the values of the voxels that lie within a given bounding box.
Definition: LeafNode.h:1222
void modifyItem(Index n, const ModifyOp &op) const
Definition: LeafNode.h:234
GLsizei n
Definition: glew.h:4040
bool isAllocated() const
Return true if memory for this node's buffer has been allocated.
Definition: LeafNodeBool.h:132
const NodeMaskType & getValueMask() const
Definition: LeafNode.h:867
bool operator!=(const LeafNode &other) const
Definition: LeafNode.h:195
const bool & getFirstValue() const
Return a const reference to the first entry in the buffer.
Definition: LeafNodeBool.h:394
std::string str() const
Return a string representation of this node.
Definition: LeafNode.h:1015
void set(Index32 n, bool On)
Set the nth bit to the specified state.
Definition: NodeMasks.h:462
typename std::remove_const< UnsetItemT >::type NonConstValueType
Definition: Iterator.h:184
void resetBackground(const ValueType &oldBackground, const ValueType &newBackground)
Replace inactive occurrences of oldBackground with newBackground, and inactive occurrences of -oldBac...
Definition: LeafNode.h:1611
ValueType medianAll(ValueType *tmp=nullptr) const
Computes the median value of all the active AND inactive voxels in this node.
Definition: LeafNode.h:1513
LeafNode * touchLeafAndCache(const Coord &, AccessorT &)
Return a pointer to this node.
Definition: LeafNodeBool.h:535
void setOn(Index32 n)
Set the nth bit on.
Definition: NodeMasks.h:452
void setValueOff(const Coord &xyz)
Mark the voxel at the given coordinates as inactive but don't change its value.
Definition: LeafNode.h:401
Index64 offVoxelCount() const
Return the number of voxels marked Off.
Definition: LeafNode.h:142
void modifyValueAndActiveStateAndCache(const Coord &xyz, const ModifyOp &op, AccessorT &)
Definition: LeafNodeBool.h:363
const value_t * data() const
Return a pointer to the underlying scalar type.
Definition: simd.h:947
const Coord & origin() const
Return the grid index coordinates of this node's local origin.
Definition: LeafNode.h:172
void modifyValueAndActiveState(const Coord &xyz, const ModifyOp &op)
Apply a functor to the voxel at the given coordinates.
Definition: LeafNode.h:450
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
SIMD Intrinsic Headers.
Definition: Platform.h:114
ValueIter< MaskOffIter, LeafNode, const bool > ValueOffIter
Definition: LeafNodeBool.h:638
void modifyValueAndCache(const Coord &xyz, const ModifyOp &op, AccessorT &)
Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active...
Definition: LeafNodeBool.h:355
Coord offsetToGlobalCoord(Index n) const
Return the global coordinates for a linear table offset.
Definition: LeafNode.h:1052
Base class for sparse iterators over internal and leaf nodes.
Definition: Iterator.h:114
void setValueOnlyAndCache(const Coord &xyz, bool val, AccessorT &)
Change the value of the voxel at the given coordinates but preserve its state.
Definition: LeafNodeBool.h:341
void combine2(const LeafNode &other, const OtherType &, bool valueIsActive, CombineOp &)
Definition: LeafNode.h:1762
Index medianOn(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the active voxels in this node.
Definition: LeafNode.h:1531
CoordBBox getNodeBoundingBox() const
Return the bounding box of this node, i.e., the full index space spanned by this leaf node...
Definition: LeafNode.h:166
void visit2Node(OtherLeafNodeType &other, VisitorOp &)
Definition: LeafNode.h:1870
NodeT * probeNodeAndCache(const Coord &, AccessorT &)
Return a pointer to this node.
Definition: LeafNodeBool.h:540
Base class for dense iterators over internal and leaf nodes.
Definition: Iterator.h:178
void fill(const ValueType &)
Populate this buffer with a constant value.
Definition: LeafBuffer.h:247
GLsizei const GLchar *const * string
Definition: glew.h:1844
ChildIter< MaskOffIter, const LeafNode > ChildOffCIter
Definition: LeafNodeBool.h:645
DenseMaskIterator< NodeMask > DenseIterator
Definition: NodeMasks.h:350
void setValueOn(Index offset)
Mark the voxel at the given offset as active but don't change its value.
Definition: LeafNodeBool.h:241
static void evalNodeOrigin(Coord &xyz)
Compute the origin of the leaf node that contains the voxel with the given coordinates.
Definition: LeafNodeBool.h:711
ValueIter< MaskOnIterator, const LeafNode, const ValueType, ValueOn > ValueOnCIter
Definition: LeafNode.h:279
void setItem(Index pos, const ValueT &value) const
Definition: LeafNode.h:222
void setActiveState(Index offset, bool on)
Set the active state of the voxel at the given offset but don't change its value. ...
Definition: LeafNodeBool.h:221
Index64 onVoxelCount() const
Return the number of active voxels.
Definition: LeafNodeBool.h:117
bool probeValue(const Coord &xyz, ValueType &val) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNode.h:1079
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition: Types.h:986
void combine(const LeafNode &other, CombineOp &op)
Definition: LeafNode.h:1722
void prune(const ValueType &=zeroVal< ValueType >())
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:512
const NodeT * probeConstNodeAndCache(const Coord &, AccessorT &) const
Return a pointer to this node.
Definition: LeafNodeBool.h:557
Index medianOff(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the inactive voxels in this node.
Definition: LeafNode.h:1555
void addTileAndCache(Index, const Coord &, const ValueType &, bool, AccessorT &)
Definition: LeafNode.h:1599
ValueIter< MaskOffIter, const LeafNode, const bool > ValueOffCIter
Definition: LeafNodeBool.h:639
bool isEmpty() const
Return true if this node has no active voxels.
Definition: LeafNodeBool.h:126
ValueIter< MaskDenseIter, const LeafNode, const bool > ValueAllCIter
Definition: LeafNodeBool.h:641
GLuint GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat s1
Definition: glew.h:12681
GLuint GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat t1
Definition: glew.h:12681
NodeT * probeNode(const Coord &)
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:519
void getOrigin(Coord &origin) const
Return the grid index coordinates of this node's local origin.
Definition: LeafNodeBool.h:155
ValueIter< MaskDenseIterator, const LeafNode, const ValueType, ValueAll > ValueAllCIter
Definition: LeafNode.h:283
OnMaskIterator< NodeMask > OnIterator
Definition: NodeMasks.h:348
void setValue(const Coord &xyz, bool val)
Set the value of the voxel at the given coordinates and mark the voxel as active. ...
Definition: LeafNodeBool.h:246
LeafNode * probeLeafAndCache(const Coord &, AccessorT &)
Return a pointer to this node.
Definition: LeafNodeBool.h:538
static Index getValueLevel(const Coord &)
Return the level (0) at which leaf node values reside.
Definition: LeafNodeBool.h:216
bool isInactive() const
Return true if all of this node's values are inactive.
Definition: LeafNodeBool.h:429
bool isDense() const
Return true if this node only contains active voxels.
Definition: LeafNodeBool.h:128
LeafNode & operator=(const LeafNode &)=default
Deep assignment operator.
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition: Types.h:984
GLuint64EXT * result
Definition: glew.h:14007
#define SIZE
Definition: simple.C:40
void copyFromDense(const CoordBBox &bbox, const DenseT &dense, const ValueType &background, const ValueType &tolerance)
Copy from a dense grid into this node the values of the voxels that lie within a given bounding box...
Definition: LeafNode.h:1249
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
Definition: Platform.h:115
bool getItem(Index pos, void *&child, NonConstValueT &value) const
Definition: LeafNodeBool.h:621
void visit2(IterT &otherIter, VisitorOp &, bool otherIsLHS=false)
Definition: LeafNode.h:1918
static Index dim()
Return the number of voxels in each dimension.
Definition: LeafNodeBool.h:104
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition: Types.h:1045
GLuint GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat s0
Definition: glew.h:12681
void visitActiveBBox(BBoxOp &) const
Calls the templated functor BBoxOp with bounding box information. An additional level argument is pro...
Definition: LeafNode.h:1823
void addLeafAndCache(LeafNode *, AccessorT &)
This function exists only to enable template instantiation.
Definition: LeafNodeBool.h:515
GLuint GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat t0
Definition: glew.h:12681
#define const
Definition: zconf.h:214
void setValue(Index i, const ValueType &)
Set the i'th value of this buffer to the specified value.
Definition: LeafBuffer.h:212
void setActiveStateAndCache(const Coord &xyz, bool on, AccessorT &)
Set the active state of the voxel at the given coordinates without changing its value.
Definition: LeafNodeBool.h:372
DenseIter< const LeafNode, const ValueType, ChildAll > ChildAllCIter
Definition: LeafNode.h:289
vint4 min(const vint4 &a, const vint4 &b)
Definition: simd.h:4694
bool hasSameTopology(const LeafNode< OtherType, OtherLog2Dim > *other) const
Return true if the given node (which may have a different ValueType than this node) has the same acti...
Definition: LeafNode.h:1469
bool operator==(const LeafNode &other) const
Check for buffer, state and origin equivalence.
Definition: LeafNode.h:1431
GLenum GLuint GLsizei const GLchar * buf
Definition: glew.h:2580
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:112
GLsizei const GLfloat * value
Definition: glew.h:1849
void evalActiveBoundingBox(CoordBBox &bbox, bool visitVoxels=true) const
Definition: LeafNode.h:1451
void setValueOnly(Index offset, bool val)
Set the value of the voxel at the given offset but don't change its active state. ...
Definition: LeafNodeBool.h:226
static Index coordToOffset(const Coord &xyz)
Return the linear table offset of the given global or local coordinates.
Definition: LeafNode.h:1028
OPENVDB_API uint32_t getFormatVersion(std::ios_base &)
Return the file format version number associated with the given input stream.
GLint level
Definition: glew.h:1252
void nodeCount(std::vector< Index32 > &) const
no-op
Definition: LeafNodeBool.h:113
static void doVisit2(NodeT &self, OtherChildAllIterT &, VisitorOp &, bool otherIsLHS)
Definition: LeafNode.h:1942
bool probeValueAndCache(const Coord &xyz, bool &val, AccessorT &) const
Return true if the voxel at the given coordinates is active and return the voxel value in val...
Definition: LeafNodeBool.h:381
NodeMaskType mValueMask
Bitmask that determines which voxels are active.
Definition: LeafNodeBool.h:726
ChildIter< MaskOffIterator, const LeafNode, ChildOff > ChildOffCIter
Definition: LeafNode.h:287
CoordBBox getNodeBoundingBox() const
Return the bounding box of this node, i.e., the full index space spanned by this leaf node...
Definition: LeafNodeBool.h:148
bool isZero(const Type &x)
Return true if x is exactly equal to zero.
Definition: Math.h:301
void writeTopology(std::ostream &os, bool toHalf=false) const
Write out just the topology.
Definition: LeafNode.h:1294
bool isOff(Index32 n) const
Return true if the nth bit is off.
Definition: NodeMasks.h:508
bool isValueOnAndCache(const Coord &xyz, AccessorT &) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNodeBool.h:330
DenseIter< LeafNode, ValueType, ChildAll > ChildAllIter
Definition: LeafNode.h:288
void setOrigin(const Coord &origin)
Set the grid index coordinates of this node's local origin.
Definition: LeafNodeBool.h:151
ValueIter< MaskOffIterator, LeafNode, const ValueType, ValueOff > ValueOffIter
Definition: LeafNode.h:280
void fill(const CoordBBox &bbox, const ValueType &, bool active=true)
Set all voxels within an axis-aligned box to the specified value and active state.
Definition: LeafNode.h:1179
static void doVisit2Node(NodeT &self, OtherNodeT &other, VisitorOp &)
Definition: LeafNode.h:1895
GLintptr offset
Definition: glew.h:1682