HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim > Class Template Reference

#include <InternalNode.h>

Classes

struct  ChildAll
 
struct  ChildIter
 
struct  ChildOff
 
struct  ChildOn
 
struct  DeepCopy
 
struct  DenseIter
 
struct  SameConfiguration
 SameConfiguration<OtherNodeType>::value is true if and only if OtherNodeType is the type of an InternalNode with the same dimensions as this node and whose ChildNodeType has the same configuration as this node's ChildNodeType. More...
 
struct  TopologyCopy1
 
struct  TopologyCopy2
 
struct  TopologyDifference
 
struct  TopologyIntersection
 
struct  TopologyUnion
 
struct  ValueAll
 
struct  ValueConverter
 ValueConverter<T>::Type is the type of an InternalNode having the same child hierarchy and dimensions as this node but a different value type, T. More...
 
struct  ValueIter
 
struct  ValueOff
 
struct  ValueOn
 
struct  VoxelizeActiveTiles
 

Public Types

using ChildNodeType = _ChildNodeType
 
using LeafNodeType = typename ChildNodeType::LeafNodeType
 
using ValueType = typename ChildNodeType::ValueType
 
using BuildType = typename ChildNodeType::BuildType
 
using UnionType = NodeUnion< ValueType, ChildNodeType >
 
using NodeMaskType = util::NodeMask< Log2Dim >
 
using ChildOnIter = ChildIter< InternalNode, ChildNodeType, MaskOnIterator, ChildOn >
 
using ChildOnCIter = ChildIter< const InternalNode, const ChildNodeType, MaskOnIterator, ChildOn >
 
using ChildOffIter = ValueIter< InternalNode, const ValueType, MaskOffIterator, ChildOff >
 
using ChildOffCIter = ValueIter< const InternalNode, const ValueType, MaskOffIterator, ChildOff >
 
using ChildAllIter = DenseIter< InternalNode, ChildNodeType, ValueType, ChildAll >
 
using ChildAllCIter = DenseIter< const InternalNode, const ChildNodeType, ValueType, ChildAll >
 
using ValueOnIter = ValueIter< InternalNode, const ValueType, MaskOnIterator, ValueOn >
 
using ValueOnCIter = ValueIter< const InternalNode, const ValueType, MaskOnIterator, ValueOn >
 
using ValueOffIter = ValueIter< InternalNode, const ValueType, MaskOffIterator, ValueOff >
 
using ValueOffCIter = ValueIter< const InternalNode, const ValueType, MaskOffIterator, ValueOff >
 
using ValueAllIter = ValueIter< InternalNode, const ValueType, MaskOffIterator, ValueAll >
 
using ValueAllCIter = ValueIter< const InternalNode, const ValueType, MaskOffIterator, ValueAll >
 

Public Member Functions

 InternalNode ()
 Default constructor. More...
 
 InternalNode (const ValueType &offValue)
 Constructor of an InternalNode with dense inactive tiles of the specified value. More...
 
 InternalNode (const Coord &origin, const ValueType &fillValue, bool active=false)
 Constructs an InternalNode with dense tiles. More...
 
 InternalNode (PartialCreate, const Coord &, const ValueType &fillValue, bool active=false)
 
 InternalNode (const InternalNode &)
 Deep copy constructor. More...
 
template<typename OtherChildNodeType >
 InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other)
 Value conversion copy constructor. More...
 
template<typename OtherChildNodeType >
 InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background, TopologyCopy)
 Topology copy constructor. More...
 
template<typename OtherChildNodeType >
 InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &offValue, const ValueType &onValue, TopologyCopy)
 Topology copy constructor. More...
 
 ~InternalNode ()
 
ChildOnCIter cbeginChildOn () const
 
ChildOffCIter cbeginChildOff () const
 
ChildAllCIter cbeginChildAll () const
 
ChildOnCIter beginChildOn () const
 
ChildOffCIter beginChildOff () const
 
ChildAllCIter beginChildAll () const
 
ChildOnIter beginChildOn ()
 
ChildOffIter beginChildOff ()
 
ChildAllIter beginChildAll ()
 
ValueOnCIter cbeginValueOn () const
 
ValueOffCIter cbeginValueOff () const
 
ValueAllCIter cbeginValueAll () const
 
ValueOnCIter beginValueOn () const
 
ValueOffCIter beginValueOff () const
 
ValueAllCIter beginValueAll () const
 
ValueOnIter beginValueOn ()
 
ValueOffIter beginValueOff ()
 
ValueAllIter beginValueAll ()
 
Coord offsetToGlobalCoord (Index n) const
 Return the global coordinates for a linear table offset. More...
 
const Coord & origin () const
 Return the grid index coordinates of this node's local origin. More...
 
void setOrigin (const Coord &origin)
 Set the grid index coordinates of this node's local origin. More...
 
Index32 transientData () const
 Return the transient data value. More...
 
void setTransientData (Index32 transientData)
 Set the transient data value. More...
 
Index64 leafCount () const
 
Index64 nonLeafCount () const
 
void nodeCount (std::vector< Index64 > &vec) const
 
void nodeCount (std::vector< Index32 > &vec) const
 
Index32 childCount () const
 
Index64 onVoxelCount () const
 
Index64 offVoxelCount () const
 
Index64 onLeafVoxelCount () const
 
Index64 offLeafVoxelCount () const
 
Index64 onTileCount () const
 
Index64 memUsage () const
 Return the total amount of memory in bytes occupied by this node and its children. More...
 
void evalActiveBoundingBox (CoordBBox &bbox, bool visitVoxels=true) const
 Expand the specified bounding box so that it includes the active tiles of this internal node as well as all the active values in its child nodes. If visitVoxels is false LeafNodes will be approximated as dense, i.e. with all voxels active. Else the individual active voxels are visited to produce a tight bbox. More...
 
CoordBBox getNodeBoundingBox () const
 Return the bounding box of this node, i.e., the full index space spanned by the node regardless of its content. More...
 
bool isEmpty () const
 
bool isConstant (ValueType &firstValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const
 
bool isConstant (ValueType &minValue, ValueType &maxValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const
 
bool isInactive () const
 Return true if this node has no children and only contains inactive values. More...
 
bool isValueOn (const Coord &xyz) const
 Return true if the voxel at the given coordinates is active. More...
 
bool isValueOn (Index offset) const
 Return true if the voxel at the given offset is active. More...
 
bool isValueOff (const Coord &xyz) const
 Return true if the voxel at the given coordinates is inactive. More...
 
bool isValueOff (Index offset) const
 Return true if the voxel at the given offset is inactive. More...
 
bool hasActiveTiles () const
 Return true if this node or any of its child nodes have any active tiles. More...
 
const ValueType & getValue (const Coord &xyz) const
 
bool probeValue (const Coord &xyz, ValueType &value) const
 
Index getValueLevel (const Coord &xyz) const
 Return the level of the tree (0 = leaf) at which the value at the given coordinates resides. More...
 
const ValueType & getFirstValue () const
 If the first entry in this node's table is a tile, return the tile's value. Otherwise, return the result of calling getFirstValue() on the child. More...
 
const ValueType & getLastValue () const
 If the last entry in this node's table is a tile, return the tile's value. Otherwise, return the result of calling getLastValue() on the child. More...
 
void setActiveState (const Coord &xyz, bool on)
 Set the active state of the voxel at the given coordinates but don't change its value. More...
 
void setValueOnly (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates but don't change its active state. More...
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active but don't change its value. More...
 
void setValueOn (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as active. More...
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive but don't change its value. More...
 
void setValueOff (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as inactive. More...
 
template<typename ModifyOp >
void modifyValue (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active. More...
 
template<typename ModifyOp >
void modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the voxel at the given coordinates. More...
 
template<typename AccessorT >
const ValueType & getValueAndCache (const Coord &xyz, AccessorT &) const
 
template<typename AccessorT >
bool isValueOnAndCache (const Coord &xyz, AccessorT &) const
 
template<typename AccessorT >
void setValueAndCache (const Coord &xyz, const ValueType &value, AccessorT &)
 
template<typename AccessorT >
void setValueOnlyAndCache (const Coord &xyz, const ValueType &value, AccessorT &)
 
template<typename ModifyOp , typename AccessorT >
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. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel. More...
 
template<typename ModifyOp , typename AccessorT >
void modifyValueAndActiveStateAndCache (const Coord &xyz, const ModifyOp &op, AccessorT &)
 
template<typename AccessorT >
void setValueOffAndCache (const Coord &xyz, const ValueType &value, AccessorT &)
 
template<typename AccessorT >
void setActiveStateAndCache (const Coord &xyz, bool on, AccessorT &)
 
template<typename AccessorT >
bool probeValueAndCache (const Coord &xyz, ValueType &value, AccessorT &) const
 
template<typename AccessorT >
Index getValueLevelAndCache (const Coord &xyz, AccessorT &) const
 Return the level of the tree (0 = leaf) at which the value at the given coordinates resides. More...
 
void setValuesOn ()
 Mark all values (both tiles and voxels) as active. More...
 
void writeTopology (std::ostream &, bool toHalf=false) const
 
void readTopology (std::istream &, bool fromHalf=false)
 
void writeBuffers (std::ostream &, bool toHalf=false) const
 
void readBuffers (std::istream &, bool fromHalf=false)
 
void readBuffers (std::istream &, const CoordBBox &, bool fromHalf=false)
 
const ValueType & getValueUnsafe (Index offset) const
 Return the tile value at offset. More...
 
bool getValueUnsafe (Index offset, ValueType &value) const
 Return the tile value and active state at offset. More...
 
ChildNodeType * getChildUnsafe (Index offset)
 Return the child node at offset. More...
 
const ChildNodeType * getConstChildUnsafe (Index offset) const
 Return the child node at offset. More...
 
const ChildNodeType * getChildUnsafe (Index offset) const
 Return the child node at offset. More...
 
void setActiveStateUnsafe (Index offset, bool on)
 Set the tile active state at offset but don't change its value. More...
 
void setValueOnlyUnsafe (Index offset, const ValueType &value)
 Set the tile value at offset but don't change its value. More...
 
void setValueOnUnsafe (Index offset)
 Mark the tile active at offset but don't change its value. More...
 
void setValueOnUnsafe (Index offset, const ValueType &value)
 Set the tile value at offset and mark the voxel as active. More...
 
void setValueOffUnsafe (Index offset)
 Mark the tile inactive at offset but don't change its value. More...
 
void setValueOffUnsafe (Index offset, const ValueType &value)
 Set the tile value at offset and mark the voxel as inactive. More...
 
void setChildUnsafe (Index offset, ChildNodeType *child)
 Replace a tile at offset with the given child node. More...
 
void resetChildUnsafe (Index offset, ChildNodeType *child)
 Replace a child node at offset with the given child node. More...
 
ChildNodeType * stealChildUnsafe (Index offset, const ValueType &value, bool active)
 Replace a child node at offset with the given value and active state. More...
 
void deleteChildUnsafe (Index offset, const ValueType &value, bool active)
 Delete a child node at offset and replace with the given value and active state. More...
 
void negate ()
 Change the sign of all the values represented in this node and its child nodes. More...
 
void fill (const CoordBBox &bbox, const ValueType &value, bool active=true)
 Set all voxels within a given axis-aligned box to a constant value. More...
 
void denseFill (const CoordBBox &bbox, const ValueType &value, bool active=true)
 Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are all represented at the leaf level. More...
 
void voxelizeActiveTiles (bool threaded=true)
 Densify active tiles, i.e., replace them with leaf-level active voxels. More...
 
template<typename DenseT >
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. More...
 
template<MergePolicy Policy>
void merge (InternalNode &other, const ValueType &background, const ValueType &otherBackground)
 Efficiently merge another tree into this tree using one of several schemes. More...
 
template<MergePolicy Policy>
void merge (const ValueType &tileValue, bool tileActive)
 Merge, using one of several schemes, this node (and its descendants) with a tile of the same dimensions and the given value and active state. More...
 
template<typename OtherChildNodeType >
void topologyUnion (const InternalNode< OtherChildNodeType, Log2Dim > &other, const bool preserveTiles=false)
 Union this branch's set of active values with the other branch's active values. The value type of the other branch can be different. More...
 
template<typename OtherChildNodeType >
void topologyIntersection (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background)
 Intersects this tree's set of active values with the active values of the other tree, whose ValueType may be different. More...
 
template<typename OtherChildNodeType >
void topologyDifference (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background)
 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 node and inactive in the other node. More...
 
template<typename CombineOp >
void combine (InternalNode &other, CombineOp &)
 
template<typename CombineOp >
void combine (const ValueType &value, bool valueIsActive, CombineOp &)
 
template<typename CombineOp , typename OtherNodeType >
void combine2 (const InternalNode &other0, const OtherNodeType &other1, CombineOp &)
 
template<typename CombineOp , typename OtherNodeType >
void combine2 (const ValueType &value, const OtherNodeType &other, bool valIsActive, CombineOp &)
 
template<typename CombineOp , typename OtherValueType >
void combine2 (const InternalNode &other, const OtherValueType &, bool valIsActive, CombineOp &)
 
void clip (const CoordBBox &, const ValueType &background)
 Set all voxels that lie outside the given axis-aligned box to the background. More...
 
void prune (const ValueType &tolerance=zeroVal< ValueType >())
 Reduce the memory footprint of this tree by replacing with tiles any nodes whose values are all the same (optionally to within a tolerance) and have the same active state. More...
 
void addLeaf (LeafNodeType *leaf)
 Add the specified leaf to this node, possibly creating a child branch in the process. If the leaf node already exists, replace it. More...
 
template<typename AccessorT >
void addLeafAndCache (LeafNodeType *leaf, AccessorT &)
 Same as addLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate. More...
 
template<typename NodeT >
NodeT * stealNode (const Coord &xyz, const ValueType &value, bool state)
 Return a pointer to the node of type NodeT that contains voxel (x, y, z) and replace it with a tile of the specified value and state. If no such node exists, leave the tree unchanged and return nullptr. More...
 
bool addChild (ChildNodeType *child)
 Add the given child node at this level deducing the offset from it's origin. If a child node with this offset already exists, delete the old node and add the new node in its place (i.e. ownership of the new child node is transferred to this InternalNode) More...
 
void addTile (Index level, const Coord &xyz, const ValueType &value, bool state)
 Add a tile at the specified tree level that contains voxel (x, y, z), possibly creating a parent branch or deleting a child branch in the process. More...
 
void addTile (Index offset, const ValueType &value, bool state)
 Delete any existing child branch at the specified offset and add a tile. More...
 
template<typename AccessorT >
void addTileAndCache (Index level, const Coord &xyz, const ValueType &, bool state, AccessorT &)
 Same as addTile() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
LeafNodeType * touchLeaf (const Coord &xyz)
 Return the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels. More...
 
template<typename AccessorT >
LeafNodeType * touchLeafAndCache (const Coord &xyz, AccessorT &)
 Same as touchLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate. More...
 
template<typename ArrayT >
void stealNodes (ArrayT &array, const ValueType &value, bool state)
 Steals all nodes of a certain type from the tree and adds them to a container with the following API: More...
 
void resetBackground (const ValueType &oldBackground, const ValueType &newBackground)
 Change inactive tiles or voxels with value oldBackground to newBackground or -oldBackground to -newBackground. Active values are unchanged. More...
 
template<typename OtherChildNodeType , Index OtherLog2Dim>
bool hasSameTopology (const InternalNode< OtherChildNodeType, OtherLog2Dim > *other) const
 Return true if the given tree branch has the same node and active value topology as this tree branch (but possibly a different ValueType). More...
 
bool isValueMaskOn (Index n) const
 
bool isValueMaskOn () const
 
bool isValueMaskOff (Index n) const
 
bool isValueMaskOff () const
 
bool isChildMaskOn (Index n) const
 
bool isChildMaskOff (Index n) const
 
bool isChildMaskOff () const
 
const NodeMaskType & getValueMask () const
 
const NodeMaskType & getChildMask () const
 
NodeMaskType getValueOffMask () const
 
const UnionType * getTable () const
 
template<typename NodeT >
NodeT * probeNode (const Coord &xyz)
 
template<typename NodeT , typename AccessorT >
NodeT * probeNodeAndCache (const Coord &xyz, AccessorT &acc)
 
template<typename NodeT >
const NodeT * probeConstNode (const Coord &xyz) const
 
template<typename NodeT , typename AccessorT >
const NodeT * probeConstNodeAndCache (const Coord &xyz, AccessorT &acc) const
 
template<typename AccessorT >
ChildT::LeafNodeType * probeLeafAndCache (const Coord &xyz, AccessorT &acc)
 
template<typename AccessorT >
const ChildT::LeafNodeType * probeLeafAndCache (const Coord &xyz, AccessorT &acc) const
 
template<typename AccessorT >
const ChildT::LeafNodeType * probeConstLeafAndCache (const Coord &xyz, AccessorT &acc) const
 
template<typename OtherChildT >
void topologyUnion (const InternalNode< OtherChildT, Log2Dim > &other, const bool preserveTiles)
 
template<typename OtherChildT >
void topologyIntersection (const InternalNode< OtherChildT, Log2Dim > &other, const ValueType &background)
 
template<typename OtherChildT >
void topologyDifference (const InternalNode< OtherChildT, Log2Dim > &other, const ValueType &background)
 
template<typename NodeType >
NodeType * probeNode (const Coord &xyz)
 Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
template<typename NodeType >
const NodeType * probeConstNode (const Coord &xyz) const
 Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
template<typename NodeType >
const NodeType * probeNode (const Coord &xyz) const
 Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
ChildNodeType * probeChild (const Coord &xyz)
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const ChildNodeType * probeConstChild (const Coord &xyz) const
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const ChildNodeType * probeChild (const Coord &xyz) const
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
ChildNodeType * probeChild (const Coord &xyz, ValueType &value, bool &active)
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const ChildNodeType * probeConstChild (const Coord &xyz, ValueType &value, bool &active) const
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const ChildNodeType * probeChild (const Coord &xyz, ValueType &value, bool &active) const
 Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
ChildNodeType * probeChildUnsafe (Index offset)
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
const ChildNodeType * probeConstChildUnsafe (Index offset) const
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
const ChildNodeType * probeChildUnsafe (Index offset) const
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
ChildNodeType * probeChildUnsafe (Index offset, ValueType &value, bool &active)
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
const ChildNodeType * probeConstChildUnsafe (Index offset, ValueType &value, bool &active) const
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
const ChildNodeType * probeChildUnsafe (Index offset, ValueType &value, bool &active) const
 Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...
 
template<typename NodeType , typename AccessorT >
NodeType * probeNodeAndCache (const Coord &xyz, AccessorT &)
 Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
template<typename NodeType , typename AccessorT >
const NodeType * probeConstNodeAndCache (const Coord &xyz, AccessorT &) const
 Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
LeafNodeType * probeLeaf (const Coord &xyz)
 Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const LeafNodeType * probeConstLeaf (const Coord &xyz) const
 Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
const LeafNodeType * probeLeaf (const Coord &xyz) const
 Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr. More...
 
template<typename AccessorT >
LeafNodeType * probeLeafAndCache (const Coord &xyz, AccessorT &acc)
 Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
template<typename AccessorT >
const LeafNodeType * probeConstLeafAndCache (const Coord &xyz, AccessorT &acc) const
 Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
template<typename AccessorT >
const LeafNodeType * probeLeafAndCache (const Coord &xyz, AccessorT &acc) const
 Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...
 
template<typename ArrayT >
void getNodes (ArrayT &array)
 Adds all nodes of a certain type to a container with the following API: More...
 
template<typename ArrayT >
void getNodes (ArrayT &array) const
 Adds all nodes of a certain type to a container with the following API: More...
 

Static Public Member Functions

static Index dim ()
 
static Index getLevel ()
 
static void getNodeLog2Dims (std::vector< Index > &dims)
 Populated an std::vector with the dimension of all the nodes in the branch starting with this node. More...
 
static Index getChildDim ()
 
static Index coordToOffset (const Coord &xyz)
 Return the linear table offset of the given global or local coordinates. More...
 
static void offsetToLocalCoord (Index n, Coord &xyz)
 Return the local coordinates for a linear table offset, where offset 0 has coordinates (0, 0, 0). More...
 

Static Public Attributes

static const Index LOG2DIM = Log2Dim
 
static const Index TOTAL = Log2Dim + ChildNodeType::TOTAL
 
static const Index DIM = 1 << TOTAL
 
static const Index NUM_VALUES = 1 << (3 * Log2Dim)
 
static const Index LEVEL = 1 + ChildNodeType::LEVEL
 
static const Index64 NUM_VOXELS = uint64_t(1) << (3 * TOTAL)
 

Protected Types

using MaskOnIterator = typename NodeMaskType::OnIterator
 
using MaskOffIterator = typename NodeMaskType::OffIterator
 
using MaskDenseIterator = typename NodeMaskType::DenseIterator
 

Protected Member Functions

void makeChildNodeEmpty (Index n, const ValueType &value)
 
void setChildNode (Index i, ChildNodeType *child)
 
void resetChildNode (Index i, ChildNodeType *child)
 
ChildNodeType * unsetChildNode (Index i, const ValueType &value)
 
void setValueMask (Index n, bool on)
 
ChildNodeType * getChildNode (Index n)
 Returns a pointer to the child node at the linear offset n. More...
 
const ChildNodeType * getChildNode (Index n) const
 Returns a pointer to the child node at the linear offset n. More...
 

Protected Attributes

UnionType mNodes [NUM_VALUES]
 
NodeMaskType mChildMask
 
NodeMaskType mValueMask
 
Coord mOrigin
 Global grid index coordinates (x,y,z) of the local origin of this node. More...
 
Index32 mTransientData = 0
 Transient data (not serialized) More...
 

Friends

template<typename , Index >
class InternalNode
 During topology-only construction, access is needed to protected/private members of other template instances. More...
 
class IteratorBase< MaskOnIterator, InternalNode >
 
class IteratorBase< MaskOffIterator, InternalNode >
 
class IteratorBase< MaskDenseIterator, InternalNode >
 

Detailed Description

template<typename _ChildNodeType, Index Log2Dim>
class openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >

Definition at line 34 of file InternalNode.h.

Member Typedef Documentation

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::BuildType = typename ChildNodeType::BuildType

Definition at line 40 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildAllCIter = DenseIter<const InternalNode,const ChildNodeType, ValueType, ChildAll>

Definition at line 212 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildAllIter = DenseIter<InternalNode, ChildNodeType, ValueType, ChildAll>

Definition at line 211 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildNodeType = _ChildNodeType

Definition at line 37 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildOffCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ChildOff>

Definition at line 210 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildOffIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ChildOff>

Definition at line 209 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildOnCIter = ChildIter<const InternalNode,const ChildNodeType,MaskOnIterator,ChildOn>

Definition at line 208 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ChildOnIter = ChildIter<InternalNode, ChildNodeType, MaskOnIterator, ChildOn>

Definition at line 207 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::LeafNodeType = typename ChildNodeType::LeafNodeType

Definition at line 38 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::MaskDenseIterator = typename NodeMaskType::DenseIterator
protected

Definition at line 117 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::MaskOffIterator = typename NodeMaskType::OffIterator
protected

Definition at line 116 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::MaskOnIterator = typename NodeMaskType::OnIterator
protected

Definition at line 115 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::NodeMaskType = util::NodeMask<Log2Dim>

Definition at line 42 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::UnionType = NodeUnion<ValueType, ChildNodeType>

Definition at line 41 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueAllCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ValueAll>

Definition at line 219 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueAllIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ValueAll>

Definition at line 218 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueOffCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ValueOff>

Definition at line 217 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueOffIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ValueOff>

Definition at line 216 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueOnCIter = ValueIter<const InternalNode, const ValueType, MaskOnIterator, ValueOn>

Definition at line 215 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueOnIter = ValueIter<InternalNode, const ValueType, MaskOnIterator, ValueOn>

Definition at line 214 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::ValueType = typename ChildNodeType::ValueType

Definition at line 39 of file InternalNode.h.

Constructor & Destructor Documentation

template<typename _ChildNodeType, Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::InternalNode ( )
inline

Default constructor.

Warning
The resulting InternalNode is uninitialized

Definition at line 73 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const ValueType &  offValue)
inlineexplicit

Constructor of an InternalNode with dense inactive tiles of the specified value.

Parameters
offValueBackground value used for inactive values

Definition at line 941 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const Coord &  origin,
const ValueType &  fillValue,
bool  active = false 
)
inline

Constructs an InternalNode with dense tiles.

Parameters
originThe location in index space of the fist tile value
fillValueValue assigned to all the tiles
activeState assigned to all the tiles

Definition at line 949 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( PartialCreate  ,
const Coord &  origin,
const ValueType &  fillValue,
bool  active = false 
)
inline

Definition at line 963 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const InternalNode< _ChildNodeType, Log2Dim > &  other)
inline

Deep copy constructor.

Note
This method is multi-threaded!

Definition at line 994 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const InternalNode< OtherChildNodeType, Log2Dim > &  other)
inlineexplicit

Value conversion copy constructor.

Note
This method is multi-threaded!

Definition at line 1008 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const InternalNode< OtherChildNodeType, Log2Dim > &  other,
const ValueType &  background,
TopologyCopy   
)
inline

Topology copy constructor.

Note
This method is multi-threaded!

Definition at line 1044 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::InternalNode ( const InternalNode< OtherChildNodeType, Log2Dim > &  other,
const ValueType &  offValue,
const ValueType &  onValue,
TopologyCopy   
)
inline

Topology copy constructor.

Note
This method is multi-threaded!

Definition at line 1081 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::~InternalNode ( )
inline

Definition at line 1095 of file InternalNode.h.

Member Function Documentation

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::addChild ( ChildNodeType *  child)

Add the given child node at this level deducing the offset from it's origin. If a child node with this offset already exists, delete the old node and add the new node in its place (i.e. ownership of the new child node is transferred to this InternalNode)

Returns
true if inserting the child has been successful, otherwise the caller retains ownership of the node and is responsible for deleting it.
template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::addLeaf ( LeafNodeType *  leaf)
inline

Add the specified leaf to this node, possibly creating a child branch in the process. If the leaf node already exists, replace it.

Definition at line 1507 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::addLeafAndCache ( LeafNodeType *  leaf,
AccessorT &  acc 
)
inline

Same as addLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate.

Definition at line 1536 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::addTile ( Index  level,
const Coord &  xyz,
const ValueType &  value,
bool  state 
)
inline

Add a tile at the specified tree level that contains voxel (x, y, z), possibly creating a parent branch or deleting a child branch in the process.

Definition at line 1595 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::addTile ( Index  offset,
const ValueType &  value,
bool  state 
)
inline

Delete any existing child branch at the specified offset and add a tile.

Definition at line 1585 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::addTileAndCache ( Index  level,
const Coord &  xyz,
const ValueType &  value,
bool  state,
AccessorT &  acc 
)
inline

Same as addTile() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

Definition at line 1627 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildAll ( ) const
inline

Definition at line 226 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildAllIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildAll ( )
inline

Definition at line 229 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildOff ( ) const
inline

Definition at line 225 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOffIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildOff ( )
inline

Definition at line 228 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildOn ( ) const
inline

Definition at line 224 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOnIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginChildOn ( )
inline

Definition at line 227 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueAll ( ) const
inline

Definition at line 238 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueAllIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueAll ( )
inline

Definition at line 242 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueOff ( ) const
inline
Warning
This iterator will also visit child nodes so use isChildMaskOn to skip them!

Definition at line 237 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOffIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueOff ( )
inline
Warning
This iterator will also visit child nodes so use isChildMaskOn to skip them!

Definition at line 241 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueOn ( ) const
inline

Definition at line 235 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOnIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::beginValueOn ( )
inline

Definition at line 239 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginChildAll ( ) const
inline

Definition at line 223 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginChildOff ( ) const
inline

Definition at line 222 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginChildOn ( ) const
inline

Definition at line 221 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginValueAll ( ) const
inline

Definition at line 234 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginValueOff ( ) const
inline
Warning
This iterator will also visit child nodes so use isChildMaskOn to skip them!

Definition at line 233 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::cbeginValueOn ( ) const
inline

Definition at line 231 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index32 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::childCount ( ) const
inline

Definition at line 1162 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::clip ( const CoordBBox &  clipBBox,
const ValueType &  background 
)
inline

Set all voxels that lie outside the given axis-aligned box to the background.

Definition at line 2190 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename CombineOp >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::combine ( InternalNode< _ChildNodeType, Log2Dim > &  other,
CombineOp &  op 
)
inline

Definition at line 3015 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename CombineOp >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::combine ( const ValueType &  value,
bool  valueIsActive,
CombineOp &  op 
)
inline

Definition at line 3073 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherNodeType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::combine2 ( const InternalNode< _ChildNodeType, Log2Dim > &  other0,
const OtherNodeType &  other1,
CombineOp &  op 
)
inline

Definition at line 3102 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherNodeType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::combine2 ( const ValueType &  value,
const OtherNodeType &  other,
bool  valIsActive,
CombineOp &  op 
)
inline

Definition at line 3149 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherValueType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::combine2 ( const InternalNode< _ChildNodeType, Log2Dim > &  other,
const OtherValueType &  value,
bool  valIsActive,
CombineOp &  op 
)
inline

Definition at line 3182 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::coordToOffset ( const Coord &  xyz)
inlinestatic

Return the linear table offset of the given global or local coordinates.

Definition at line 3283 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename DenseT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::copyToDense ( const CoordBBox &  bbox,
DenseT &  dense 
) const
inline

Copy into a dense grid the values of the voxels that lie within a given bounding box.

Parameters
bboxinclusive bounding box of the voxels to be copied into the dense grid
densedense grid with a stride in z of one (see tools::Dense in tools/Dense.h for the required API)
Note
bbox is assumed to be identical to or contained in the coordinate domains of both the dense grid and this node, i.e., no bounds checking is performed.

Definition at line 2344 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::deleteChildUnsafe ( Index  offset,
const ValueType &  value,
bool  active 
)
inline

Delete a child node at offset and replace with the given value and active state.

Note
Use addTile(Index, const ValueType&, bool) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2632 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::denseFill ( const CoordBBox &  bbox,
const ValueType &  value,
bool  active = true 
)
inline

Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are all represented at the leaf level.

Parameters
bboxinclusive coordinates of opposite corners of an axis-aligned box.
valuethe value to which to set voxels within the box.
activeif true, mark voxels within the box as active, otherwise mark them as inactive.
See Also
voxelizeActiveTiles()

Definition at line 2296 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::dim ( )
inlinestatic
Returns
The dimension of this InternalNode

The number of voxels in one coordinate direction covered by this node

Definition at line 247 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::evalActiveBoundingBox ( CoordBBox &  bbox,
bool  visitVoxels = true 
) const
inline

Expand the specified bounding box so that it includes the active tiles of this internal node as well as all the active values in its child nodes. If visitVoxels is false LeafNodes will be approximated as dense, i.e. with all voxels active. Else the individual active voxels are visited to produce a tight bbox.

Definition at line 1241 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::fill ( const CoordBBox &  bbox,
const ValueType &  value,
bool  active = true 
)
inline

Set all voxels within a given axis-aligned box to a constant value.

Parameters
bboxinclusive coordinates of opposite corners of an axis-aligned box
valuethe value to which to set voxels within the box
activeif true, mark voxels within the box as active, otherwise mark them as inactive
Note
This operation generates a sparse, but not always optimally sparse, representation of the filled box. Follow fill operations with a prune() operation for optimal sparseness.

Definition at line 2240 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getChildDim ( )
inlinestatic
Returns
The dimension of the child nodes of this node.

The number of voxels in one coordinate direction covered by a child node of this node.

Definition at line 257 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const NodeMaskType& openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getChildMask ( ) const
inline

Definition at line 869 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getChildNode ( Index  n)
inlineprotected

Returns a pointer to the child node at the linear offset n.

Warning
This protected method assumes that a child node exists at the specified linear offset!

Definition at line 3461 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getChildNode ( Index  n) const
inlineprotected

Returns a pointer to the child node at the linear offset n.

Warning
This protected method assumes that a child node exists at the specified linear offset!

Definition at line 3470 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getChildUnsafe ( Index  offset)
inline

Return the child node at offset.

Note
Use probeChild(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2513 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getChildUnsafe ( Index  offset) const
inline

Return the child node at offset.

Note
Use probeChild(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2531 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getConstChildUnsafe ( Index  offset) const
inline

Return the child node at offset.

Note
Use probeConstChild(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2522 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT::ValueType & openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getFirstValue ( ) const
inline

If the first entry in this node's table is a tile, return the tile's value. Otherwise, return the result of calling getFirstValue() on the child.

Definition at line 2474 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT::ValueType & openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getLastValue ( ) const
inline

If the last entry in this node's table is a tile, return the tile's value. Otherwise, return the result of calling getLastValue() on the child.

Definition at line 2482 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getLevel ( )
inlinestatic
Returns
The level of this node

Level 0 is by definition the level of the leaf nodes

Definition at line 250 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
CoordBBox openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getNodeBoundingBox ( ) const
inline

Return the bounding box of this node, i.e., the full index space spanned by the node regardless of its content.

Definition at line 300 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getNodeLog2Dims ( std::vector< Index > &  dims)
static

Populated an std::vector with the dimension of all the nodes in the branch starting with this node.

Definition at line 3262 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getNodes ( ArrayT &  array)
inline

Adds all nodes of a certain type to a container with the following API:

struct ArrayT {
using value_type = ...;// defines the type of nodes to be added to the array
void push_back(value_type nodePtr);// method that add nodes to the array
};

An example of a wrapper around a c-style array is:

struct MyArray {
using value_type = LeafType*;
value_type* ptr;
MyArray(value_type* array) : ptr(array) {}
void push_back(value_type leaf) { *ptr++ = leaf; }
};

An example that constructs a list of pointer to all leaf nodes is:

std::vector<const LeafNodeType*> array;//most std contains have the required API
array.reserve(tree.leafCount());//this is a fast preallocation.
tree.getNodes(array);

Definition at line 3308 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getNodes ( ArrayT &  array) const
inline

Adds all nodes of a certain type to a container with the following API:

struct ArrayT {
using value_type = ...;// defines the type of nodes to be added to the array
void push_back(value_type nodePtr);// method that add nodes to the array
};

An example of a wrapper around a c-style array is:

struct MyArray {
using value_type = LeafType*;
value_type* ptr;
MyArray(value_type* array) : ptr(array) {}
void push_back(value_type leaf) { *ptr++ = leaf; }
};

An example that constructs a list of pointer to all leaf nodes is:

std::vector<const LeafNodeType*> array;//most std contains have the required API
array.reserve(tree.leafCount());//this is a fast preallocation.
tree.getNodes(array);

Definition at line 3328 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const UnionType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getTable ( ) const
inline

Definition at line 877 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT::ValueType & openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getValue ( const Coord &  xyz) const
inline

Definition at line 1788 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
const ValueType& openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getValueAndCache ( const Coord &  xyz,
AccessorT &   
) const

Return the value of the voxel at the given coordinates and, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.
template<typename ChildT , Index Log2Dim>
Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getValueLevel ( const Coord &  xyz) const
inline

Return the level of the tree (0 = leaf) at which the value at the given coordinates resides.

Definition at line 1811 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getValueLevelAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const
inline

Return the level of the tree (0 = leaf) at which the value at the given coordinates resides.

If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 1820 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const NodeMaskType& openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getValueMask ( ) const
inline

Definition at line 868 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
NodeMaskType openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::getValueOffMask ( ) const
inline

Definition at line 870 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT::ValueType & openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getValueUnsafe ( Index  offset) const
inline

Return the tile value at offset.

Note
Use getValue(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2494 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::getValueUnsafe ( Index  offset,
ValueType &  value 
) const
inline

Return the tile value and active state at offset.

Note
Use probeValue(const Coord&, ValueType&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2503 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::hasActiveTiles ( ) const
inline

Return true if this node or any of its child nodes have any active tiles.

Definition at line 1743 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType , Index OtherLog2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::hasSameTopology ( const InternalNode< OtherChildNodeType, OtherLog2Dim > *  other) const
inline

Return true if the given tree branch has the same node and active value topology as this tree branch (but possibly a different ValueType).

Definition at line 3399 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isChildMaskOff ( Index  n) const
inline

Definition at line 866 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isChildMaskOff ( ) const
inline

Definition at line 867 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isChildMaskOn ( Index  n) const
inline

Definition at line 865 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::isConstant ( ValueType &  firstValue,
bool &  state,
const ValueType &  tolerance = zeroVal<ValueType>() 
) const
inline

Return true if all of this node's table entries have the same active state and the same constant value to within the given tolerance, and return that value in firstValue and the active state in state.

Note
This method also returns false if this node contains any child nodes.

Definition at line 1696 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::isConstant ( ValueType &  minValue,
ValueType &  maxValue,
bool &  state,
const ValueType &  tolerance = zeroVal<ValueType>() 
) const
inline

Return true if all of this node's tables entries have the same active state and the range of its values satisfy (maxValue - minValue) <= tolerance.

Parameters
minValueIs updated with the minimum of all values IF method returns true. Else the value is undefined!
maxValueIs updated with the maximum of all values IF method returns true. Else the value is undefined!
stateIs updated with the state of all values IF method returns true. Else the value is undefined!
toleranceThe tolerance used to determine if values are approximately constant.
Note
This method also returns false if this node contains any child nodes.

Definition at line 1716 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isEmpty ( ) const
inline
Returns
True if this node contains no child nodes.

Definition at line 303 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isInactive ( ) const
inline

Return true if this node has no children and only contains inactive values.

Definition at line 331 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueMaskOff ( Index  n) const
inline

Definition at line 863 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueMaskOff ( ) const
inline

Definition at line 864 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueMaskOn ( Index  n) const
inline

Definition at line 861 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueMaskOn ( ) const
inline

Definition at line 862 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::isValueOff ( const Coord &  xyz) const
inline

Return true if the voxel at the given coordinates is inactive.

Definition at line 1767 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueOff ( Index  offset) const
inline

Return true if the voxel at the given offset is inactive.

Definition at line 340 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::isValueOn ( const Coord &  xyz) const
inline

Return true if the voxel at the given coordinates is active.

Definition at line 1758 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::isValueOn ( Index  offset) const
inline

Return true if the voxel at the given offset is active.

Definition at line 336 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::isValueOnAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const
inline

Return true if the voxel at the given coordinates is active and, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 1777 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::leafCount ( ) const
inline

Definition at line 1108 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::makeChildNodeEmpty ( Index  n,
const ValueType &  value 
)
inlineprotected

Definition at line 3454 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::memUsage ( ) const
inline

Return the total amount of memory in bytes occupied by this node and its children.

Definition at line 1228 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<MergePolicy Policy>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::merge ( InternalNode< _ChildNodeType, Log2Dim > &  other,
const ValueType &  background,
const ValueType &  otherBackground 
)
inline

Efficiently merge another tree into this tree using one of several schemes.

Warning
This operation cannibalizes the other tree.

Definition at line 2709 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<MergePolicy Policy>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::merge ( const ValueType &  tileValue,
bool  tileActive 
)
inline

Merge, using one of several schemes, this node (and its descendants) with a tile of the same dimensions and the given value and active state.

Definition at line 2818 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::modifyValue ( const Coord &  xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active.

Definition at line 2074 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::modifyValueAndActiveState ( const Coord &  xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the voxel at the given coordinates.

Definition at line 2136 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp , typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::modifyValueAndActiveStateAndCache ( const Coord &  xyz,
const ModifyOp &  op,
AccessorT &  acc 
)
inline

Apply a functor to the voxel at the given coordinates. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 2159 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp , typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::modifyValueAndCache ( const Coord &  xyz,
const ModifyOp &  op,
AccessorT &  acc 
)
inline

Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 2102 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::negate ( )
inline

Change the sign of all the values represented in this node and its child nodes.

Definition at line 2644 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::nodeCount ( std::vector< Index64 > &  vec) const
inline

Definition at line 1120 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::nodeCount ( std::vector< Index32 > &  vec) const
inline

Definition at line 1132 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::nonLeafCount ( ) const
inline

Definition at line 1149 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::offLeafVoxelCount ( ) const
inline

Definition at line 1206 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Coord openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::offsetToGlobalCoord ( Index  n) const
inline

Return the global coordinates for a linear table offset.

Definition at line 3293 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::offsetToLocalCoord ( Index  n,
Coord &  xyz 
)
inlinestatic

Return the local coordinates for a linear table offset, where offset 0 has coordinates (0, 0, 0).

Definition at line 3271 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::offVoxelCount ( ) const
inline

Definition at line 1182 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::onLeafVoxelCount ( ) const
inline

Definition at line 1194 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::onTileCount ( ) const
inline

Definition at line 1217 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::onVoxelCount ( ) const
inline

Definition at line 1170 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Coord& openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::origin ( ) const
inline

Return the grid index coordinates of this node's local origin.

Definition at line 268 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeChild ( const Coord &  xyz)
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1385 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const ChildNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeChild ( const Coord &  xyz) const
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 710 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeChild ( const Coord &  xyz,
ValueType &  value,
bool &  active 
)
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1401 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const ChildNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeChild ( const Coord &  xyz,
ValueType &  value,
bool &  active 
) const
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 718 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeChildUnsafe ( Index  offset)
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 1417 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const ChildNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeChildUnsafe ( Index  offset) const
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 728 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeChildUnsafe ( Index  offset,
ValueType &  value,
bool &  active 
)
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 1435 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const ChildNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeChildUnsafe ( Index  offset,
ValueType &  value,
bool &  active 
) const
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 738 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeConstChild ( const Coord &  xyz) const
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1393 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeConstChild ( const Coord &  xyz,
ValueType &  value,
bool &  active 
) const
inline

Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1409 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeConstChildUnsafe ( Index  offset) const
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 1426 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeConstChildUnsafe ( Index  offset,
ValueType &  value,
bool &  active 
) const
inline

Return a pointer to the child node for a specific offset. If no such node exists, return nullptr.

Warning
This method should only be used by experts seeking low-level optimizations.
Note
Out-of-bounds memory access attempts will wrap around using modulo indexing.

Definition at line 1446 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
const ChildT::LeafNodeType * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeConstLeaf ( const Coord &  xyz) const
inline

Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1487 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
const LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const

Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
const ChildT::LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const
inline

Definition at line 1496 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeType >
const NodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstNode ( const Coord &  xyz) const

Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeT >
const NodeT* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstNode ( const Coord &  xyz) const
inline

Definition at line 1346 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeType , typename AccessorT >
const NodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstNodeAndCache ( const Coord &  xyz,
AccessorT &   
) const

Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeT , typename AccessorT >
const NodeT* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeConstNodeAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const
inline

Definition at line 1364 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT::LeafNodeType * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeLeaf ( const Coord &  xyz)
inline

Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 1461 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeLeaf ( const Coord &  xyz) const

Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return nullptr.

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
)

Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
const LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const

Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
ChildT::LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
)
inline

Definition at line 1470 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
const ChildT::LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeLeafAndCache ( const Coord &  xyz,
AccessorT &  acc 
) const
inline

Definition at line 1479 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeType >
NodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeNode ( const Coord &  xyz)

Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeType >
const NodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeNode ( const Coord &  xyz) const
inline

Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr.

Definition at line 702 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeNode ( const Coord &  xyz)
inline

Definition at line 1309 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeType , typename AccessorT >
NodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeNodeAndCache ( const Coord &  xyz,
AccessorT &   
)

Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z).

template<typename _ChildNodeType, Index Log2Dim>
template<typename NodeT , typename AccessorT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::probeNodeAndCache ( const Coord &  xyz,
AccessorT &  acc 
)
inline

Definition at line 1327 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeValue ( const Coord &  xyz,
ValueType &  value 
) const
inline

Definition at line 1833 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
bool openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::probeValueAndCache ( const Coord &  xyz,
ValueType &  value,
AccessorT &  acc 
) const
inline

Return, in value, the value of the voxel at the given coordinates and, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Returns
true if the voxel at the given coordinates is active
Note
Used internally by ValueAccessor.

Definition at line 1846 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::prune ( const ValueType &  tolerance = zeroVal<ValueType>())
inline

Reduce the memory footprint of this tree by replacing with tiles any nodes whose values are all the same (optionally to within a tolerance) and have the same active state.

Definition at line 1259 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::readBuffers ( std::istream &  is,
bool  fromHalf = false 
)
inline

Definition at line 3227 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::readBuffers ( std::istream &  is,
const CoordBBox &  clipBBox,
bool  fromHalf = false 
)
inline

Definition at line 3237 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::readTopology ( std::istream &  is,
bool  fromHalf = false 
)
inline

Definition at line 2414 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::resetBackground ( const ValueType &  oldBackground,
const ValueType &  newBackground 
)
inline

Change inactive tiles or voxels with value oldBackground to newBackground or -oldBackground to -newBackground. Active values are unchanged.

Definition at line 3379 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::resetChildNode ( Index  i,
ChildNodeType *  child 
)
inlineprotected

Definition at line 3413 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::resetChildUnsafe ( Index  offset,
ChildNodeType *  child 
)
inline

Replace a child node at offset with the given child node.

Note
Use addChild(ChildNodeType*) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2606 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setActiveState ( const Coord &  xyz,
bool  on 
)
inline

Set the active state of the voxel at the given coordinates but don't change its value.

Definition at line 2020 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setActiveStateAndCache ( const Coord &  xyz,
bool  on,
AccessorT &  acc 
)
inline

Set the active state of the voxel at the given coordinates without changing its value. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 2039 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setActiveStateUnsafe ( Index  offset,
bool  on 
)
inline

Set the tile active state at offset but don't change its value.

Note
Use setActiveState(const Coord&, bool) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2538 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setChildNode ( Index  i,
ChildNodeType *  child 
)
inlineprotected

Definition at line 3427 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setChildUnsafe ( Index  offset,
ChildNodeType *  child 
)
inline

Replace a tile at offset with the given child node.

Note
Use addChild(ChildNodeType*) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2594 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::setOrigin ( const Coord &  origin)
inline

Set the grid index coordinates of this node's local origin.

Definition at line 270 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::setTransientData ( Index32  transientData)
inline

Set the transient data value.

Definition at line 275 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueAndCache ( const Coord &  xyz,
const ValueType &  value,
AccessorT &  acc 
)
inline

Change the value of the voxel at the given coordinates and mark it as active. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 1958 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::setValueMask ( Index  n,
bool  on 
)
inlineprotected

Use a mask accessor to ensure consistency between the child and value masks; i.e., the value mask should always be off wherever the child mask is on.

Definition at line 882 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOff ( const Coord &  xyz)
inline

Mark the voxel at the given coordinates as inactive but don't change its value.

Definition at line 1861 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOff ( const Coord &  xyz,
const ValueType &  value 
)
inline

Set the value of the voxel at the given coordinates and mark the voxel as inactive.

Definition at line 1893 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOffAndCache ( const Coord &  xyz,
const ValueType &  value,
AccessorT &  acc 
)
inline

Change the value of the voxel at the given coordinates and mark it as inactive. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 1913 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOffUnsafe ( Index  offset)
inline

Mark the tile inactive at offset but don't change its value.

Note
Use setValueOff(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2575 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOffUnsafe ( Index  offset,
const ValueType &  value 
)
inline

Set the tile value at offset and mark the voxel as inactive.

Note
Use setValueOff(const Coord&, const ValueType&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2584 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOn ( const Coord &  xyz)
inline

Mark the voxel at the given coordinates as active but don't change its value.

Definition at line 1877 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOn ( const Coord &  xyz,
const ValueType &  value 
)
inline

Set the value of the voxel at the given coordinates and mark the voxel as active.

Definition at line 1938 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOnly ( const Coord &  xyz,
const ValueType &  value 
)
inline

Set the value of the voxel at the given coordinates but don't change its active state.

Definition at line 1982 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOnlyAndCache ( const Coord &  xyz,
const ValueType &  value,
AccessorT &  acc 
)
inline

Set the value of the voxel at the given coordinate but preserves its active state. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel.

Note
Used internally by ValueAccessor.

Definition at line 1999 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOnlyUnsafe ( Index  offset,
const ValueType &  value 
)
inline

Set the tile value at offset but don't change its value.

Note
Use setValueOnly(const Coord&, const ValueType&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2547 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOnUnsafe ( Index  offset)
inline

Mark the tile active at offset but don't change its value.

Note
Use setValueOn(const Coord&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2556 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValueOnUnsafe ( Index  offset,
const ValueType &  value 
)
inline

Set the tile value at offset and mark the voxel as active.

Note
Use setValueOn(const Coord&, const ValueType&) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2565 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::setValuesOn ( )
inline

Mark all values (both tiles and voxels) as active.

Definition at line 2062 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::stealChildUnsafe ( Index  offset,
const ValueType &  value,
bool  active 
)
inline

Replace a child node at offset with the given value and active state.

Note
Use addChild(ChildNodeType*) for a safer alternative.
Warning
This method should only be used by experts seeking low-level optimizations.

Definition at line 2618 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename NodeT >
NodeT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::stealNode ( const Coord &  xyz,
const ValueType &  value,
bool  state 
)
inline

Return a pointer to the node of type NodeT that contains voxel (x, y, z) and replace it with a tile of the specified value and state. If no such node exists, leave the tree unchanged and return nullptr.

Note
The caller takes ownership of the node and is responsible for deleting it.
Warning
Since this method potentially removes nodes and branches of the tree, it is important to clear the caches of all ValueAccessors associated with this tree.

Definition at line 1283 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::stealNodes ( ArrayT &  array,
const ValueType &  value,
bool  state 
)
inline

Steals all nodes of a certain type from the tree and adds them to a container with the following API:

struct ArrayT {
using value_type = ...;// defines the type of nodes to be added to the array
void push_back(value_type nodePtr);// method that add nodes to the array
};

An example of a wrapper around a c-style array is:

struct MyArray {
using value_type = LeafType*;
value_type* ptr;
MyArray(value_type* array) : ptr(array) {}
void push_back(value_type leaf) { *ptr++ = leaf; }
};

An example that constructs a list of pointer to all leaf nodes is:

std::vector<const LeafNodeType*> array;//most std contains have the required API
array.reserve(tree.leafCount());//this is a fast preallocation.
tree.stealNodes(array);

Definition at line 3352 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildNodeType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyDifference ( const InternalNode< OtherChildNodeType, Log2Dim > &  other,
const ValueType &  background 
)

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 node and inactive in the other node.

The last dummy argument is required to match the signature for InternalNode::topologyDifference.

Note
This operation modifies only active states, not values. Also note that this operation can result in all voxels being inactive so consider subsequently calling prune.
template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyDifference ( const InternalNode< OtherChildT, Log2Dim > &  other,
const ValueType &  background 
)
inline

Definition at line 3002 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildNodeType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyIntersection ( const InternalNode< OtherChildNodeType, Log2Dim > &  other,
const ValueType &  background 
)

Intersects this tree's set of active values with the active values of the other tree, whose ValueType may be different.

The resulting state of a value is active only if the corresponding value was already active AND if it is active in the other tree. Also, a resulting value maps to a voxel if the corresponding value already mapped to an active voxel in either of the two grids and it maps to an active tile or voxel in the other grid.

Note
This operation can delete branches in this grid if they overlap with inactive tiles in the other grid. Likewise active voxels can be turned into inactive voxels resulting in leaf nodes with no active values. Thus, it is recommended to subsequently call prune.
template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyIntersection ( const InternalNode< OtherChildT, Log2Dim > &  other,
const ValueType &  background 
)
inline

Definition at line 2942 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildNodeType >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyUnion ( const InternalNode< OtherChildNodeType, Log2Dim > &  other,
const bool  preserveTiles = false 
)

Union this branch's set of active values with the other branch's active values. The value type of the other branch can be different.

The resulting state of a value is active if the corresponding value was already active OR if it is active in the other tree. Also, a resulting value maps to a voxel if the corresponding value already mapped to a voxel OR if it is a voxel in the other tree. Thus, a resulting value can only map to a tile if the corresponding value already mapped to a tile AND if it is a tile value in other tree.

Specifically, active tiles and voxels in this branch are not changed, and tiles or voxels that were inactive in this branch but active in the other branch are marked as active in this branch but left with their original values.

template<typename _ChildNodeType, Index Log2Dim>
template<typename OtherChildT >
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::topologyUnion ( const InternalNode< OtherChildT, Log2Dim > &  other,
const bool  preserveTiles 
)
inline

Definition at line 2893 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT::LeafNodeType * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::touchLeaf ( const Coord &  xyz)
inline

Return the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels.

Use this method to preallocate a static tree topology over which to safely perform multithreaded processing.

Definition at line 1663 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
template<typename AccessorT >
LeafNodeType* openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::touchLeafAndCache ( const Coord &  xyz,
AccessorT &   
)

Same as touchLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate.

template<typename _ChildNodeType, Index Log2Dim>
Index32 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::transientData ( ) const
inline

Return the transient data value.

Definition at line 273 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
ChildT * openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::unsetChildNode ( Index  i,
const ValueType &  value 
)
inlineprotected

Definition at line 3439 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::voxelizeActiveTiles ( bool  threaded = true)
inline

Densify active tiles, i.e., replace them with leaf-level active voxels.

Parameters
threadedif true, this operation is multi-threaded (over the internal nodes).
See Also
denseFill()

Definition at line 2688 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::writeBuffers ( std::ostream &  os,
bool  toHalf = false 
) const
inline

Definition at line 3217 of file InternalNode.h.

template<typename ChildT , Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< ChildT, Log2Dim >::writeTopology ( std::ostream &  os,
bool  toHalf = false 
) const
inline

Definition at line 2389 of file InternalNode.h.

Friends And Related Function Documentation

template<typename _ChildNodeType, Index Log2Dim>
template<typename , Index >
friend class InternalNode
friend

During topology-only construction, access is needed to protected/private members of other template instances.

Definition at line 857 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
friend class IteratorBase< MaskDenseIterator, InternalNode >
friend

Allow iterators to call mask accessor methods (setValueMask(), setChildMask(), etc.).

Todo:
Make mask accessors public?

Definition at line 852 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
friend class IteratorBase< MaskOffIterator, InternalNode >
friend

Allow iterators to call mask accessor methods (setValueMask(), setChildMask(), etc.).

Todo:
Make mask accessors public?

Definition at line 851 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
friend class IteratorBase< MaskOnIterator, InternalNode >
friend

Allow iterators to call mask accessor methods (setValueMask(), setChildMask(), etc.).

Todo:
Make mask accessors public?

Definition at line 850 of file InternalNode.h.

Member Data Documentation

template<typename _ChildNodeType, Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::DIM = 1 << TOTAL
static

Definition at line 47 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::LEVEL = 1 + ChildNodeType::LEVEL
static

Definition at line 49 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::LOG2DIM = Log2Dim
static

Definition at line 45 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
NodeMaskType openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::mChildMask
protected

Definition at line 910 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
UnionType openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::mNodes[NUM_VALUES]
protected

Definition at line 906 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
Coord openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::mOrigin
protected

Global grid index coordinates (x,y,z) of the local origin of this node.

Definition at line 912 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
Index32 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::mTransientData = 0
protected

Transient data (not serialized)

Definition at line 914 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
NodeMaskType openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::mValueMask
protected

Definition at line 910 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::NUM_VALUES = 1 << (3 * Log2Dim)
static

Definition at line 48 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Index64 openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::NUM_VOXELS = uint64_t(1) << (3 * TOTAL)
static

Definition at line 51 of file InternalNode.h.

template<typename _ChildNodeType, Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::InternalNode< _ChildNodeType, Log2Dim >::TOTAL = Log2Dim + ChildNodeType::TOTAL
static

Definition at line 46 of file InternalNode.h.

The documentation for this class was generated from the following file: