Loading...
Searching...
No Matches
InternalNode< _ChildNodeType, Log2Dim > Class Template Reference

`#include <openvdb/tree/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.
| InternalNode (const ValueType &offValue)
| Constructor of an InternalNode with dense inactive tiles of the specified value.
| InternalNode (const Coord &origin, const ValueType &fillValue, bool active=false)
| Constructs an InternalNode with dense tiles.
| InternalNode (PartialCreate, const Coord &, const ValueType &fillValue, bool active=false)
| InternalNode (const InternalNode &)
| Deep copy constructor.
template<typename OtherChildNodeType >
| InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other)
| Value conversion copy constructor.
template<typename OtherChildNodeType >
| InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background, TopologyCopy)
| Topology copy constructor.
template<typename OtherChildNodeType >
| InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &offValue, const ValueType &onValue, TopologyCopy)
| Topology copy constructor.
| ~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.
const Coord & | origin () const
| Return the grid index coordinates of this node's local origin.
void | setOrigin (const Coord &origin)
| Set the grid index coordinates of this node's local origin.
Index32 | transientData () const
| Return the transient data value.
void | setTransientData (Index32 transientData)
| Set the transient data value.
Index32 | leafCount () const
void | nodeCount (std::vector< Index32 > &vec) const
Index32 | nonLeafCount () 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.
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.
CoordBBox | getNodeBoundingBox () const
| Return the bounding box of this node, i.e., the full index space spanned by the node regardless of its content.
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.
bool | isValueOn (const Coord &xyz) const
| Return `true` if the voxel at the given coordinates is active.
bool | isValueOn (Index offset) const
| Return `true` if the voxel at the given offset is active.
bool | hasActiveTiles () const
| Return `true` if this node or any of its child nodes have any active tiles.
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.
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.
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.
void | setActiveState (const Coord &xyz, bool on)
| Set the active state of the voxel at the given coordinates but don't change its value.
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.
void | setValueOn (const Coord &xyz)
| Mark the voxel at the given coordinates as active but don't change its value.
void | setValueOn (const Coord &xyz, const ValueType &value)
| Set the value of the voxel at the given coordinates and mark the voxel as active.
void | setValueOff (const Coord &xyz)
| Mark the voxel at the given coordinates as inactive but don't change its value.
void | setValueOff (const Coord &xyz, const ValueType &value)
| Set the value of the voxel at the given coordinates and mark the voxel as inactive.
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.
template<typename ModifyOp >
void | modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
| Apply a functor to the voxel at the given coordinates.
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.
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.
void | setValuesOn ()
| Mark all values (both tiles and voxels) as active.
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)
void | negate ()
| Change the sign of all the values represented in this node and its child nodes.
void | fill (const CoordBBox &bbox, const ValueType &value, bool active=true)
| Set all voxels within a given axis-aligned box to a constant value.
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.
void | voxelizeActiveTiles (bool threaded=true)
| Densify active tiles, i.e., replace them with leaf-level active voxels.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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`.
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)
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.
void | addTile (Index offset, const ValueType &value, bool state)
| Delete any existing child branch at the specified offset and add a tile.
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).
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.
template<typename NodeType >
const NodeType * | probeConstNode (const Coord &xyz) const
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).
template<typename NodeType , typename AccessorT >
const NodeType * | probeConstNodeAndCache (const Coord &xyz, AccessorT &) const
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`.
const LeafNodeType * | probeConstLeaf (const Coord &xyz) const
const LeafNodeType * | probeLeaf (const Coord &xyz) const
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).
template<typename AccessorT >
const LeafNodeType * | probeConstLeafAndCache (const Coord &xyz, AccessorT &acc) const
template<typename AccessorT >
const LeafNodeType * | probeLeafAndCache (const Coord &xyz, AccessorT &acc) const
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.
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.
template<typename ArrayT >
void | getNodes (ArrayT &array)
| Adds all nodes of a certain type to a container with the following API:
template<typename ArrayT >
void | getNodes (ArrayT &array) const
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:
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.
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`).
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 AccessorT >
ChildT::LeafNodeType * | touchLeafAndCache (const Coord &xyz, AccessorT &acc)
template<typename AccessorT >
const ChildT::ValueType & | getValueAndCache (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)

## 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.
static Index | getChildDim ()
static Index | coordToOffset (const Coord &xyz)
| Return the linear table offset of the given global or local coordinates.
static void | offsetToLocalCoord (Index n, Coord &xyz)
| Return the local coordinates for a linear table offset, where offset 0 has coordinates (0, 0, 0).

## 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 | setValueMask (Index n, bool on)
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)
ChildNodeType * | getChildNode (Index n)
| Returns a pointer to the child node at the linear offset n.
const ChildNodeType * | getChildNode (Index n) const
| Returns a pointer to the child node at the linear offset n.

## 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.
Index32 | mTransientData = 0
| Transient data (not serialized)

## Friends

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

## Member Typedef Documentation

## BuildType

template<typename _ChildNodeType , Index Log2Dim>

using BuildType = typename ChildNodeType::BuildType

## ChildAllCIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildAllCIter = DenseIter<const InternalNode,const ChildNodeType, ValueType, ChildAll>

## ChildAllIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildAllIter = DenseIter<InternalNode, ChildNodeType, ValueType, ChildAll>

## ChildNodeType

template<typename _ChildNodeType , Index Log2Dim>

using ChildNodeType = _ChildNodeType

## ChildOffCIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildOffCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ChildOff>

## ChildOffIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildOffIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ChildOff>

## ChildOnCIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildOnCIter = ChildIter<const InternalNode,const ChildNodeType,MaskOnIterator,ChildOn>

## ChildOnIter

template<typename _ChildNodeType , Index Log2Dim>

using ChildOnIter = ChildIter<InternalNode, ChildNodeType, MaskOnIterator, ChildOn>

## LeafNodeType

template<typename _ChildNodeType , Index Log2Dim>

using LeafNodeType = typename ChildNodeType::LeafNodeType

## MaskDenseIterator

template<typename _ChildNodeType , Index Log2Dim>

using MaskDenseIterator = typename NodeMaskType::DenseIterator

protected

## MaskOffIterator

template<typename _ChildNodeType , Index Log2Dim>

using MaskOffIterator = typename NodeMaskType::OffIterator

protected

## MaskOnIterator

template<typename _ChildNodeType , Index Log2Dim>

using MaskOnIterator = typename NodeMaskType::OnIterator

protected

## NodeMaskType

template<typename _ChildNodeType , Index Log2Dim>

using NodeMaskType = util::NodeMask<Log2Dim>

## UnionType

template<typename _ChildNodeType , Index Log2Dim>

using UnionType = NodeUnion<ValueType, ChildNodeType>

## ValueAllCIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueAllCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ValueAll>

## ValueAllIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueAllIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ValueAll>

## ValueOffCIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueOffCIter = ValueIter<const InternalNode,const ValueType,MaskOffIterator,ValueOff>

## ValueOffIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueOffIter = ValueIter<InternalNode, const ValueType, MaskOffIterator, ValueOff>

## ValueOnCIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueOnCIter = ValueIter<const InternalNode, const ValueType, MaskOnIterator, ValueOn>

## ValueOnIter

template<typename _ChildNodeType , Index Log2Dim>

using ValueOnIter = ValueIter<InternalNode, const ValueType, MaskOnIterator, ValueOn>

## ValueType

template<typename _ChildNodeType , Index Log2Dim>

using ValueType = typename ChildNodeType::ValueType

## Constructor & Destructor Documentation

## InternalNode() [1/8]

template<typename _ChildNodeType , Index Log2Dim>

InternalNode | ( |  | ) |

inline

Default constructor.

Warning
  The resulting InternalNode is uninitialized

## InternalNode() [2/8]

template<typename ChildT , Index Log2Dim>

InternalNode | ( | const ValueType & | offValue | ) |

inlineexplicit

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

Parameters

  offValue | Background value used for inactive values

## InternalNode() [3/8]

template<typename ChildT , Index Log2Dim>

InternalNode | ( | const Coord & | origin,
|  | const ValueType & | fillValue,
|  | bool | active = `false`
| ) |  |

inline

Constructs an InternalNode with dense tiles.

Parameters

  origin | The location in index space of the fist tile value
  fillValue | Value assigned to all the tiles
  active | State assigned to all the tiles

## InternalNode() [4/8]

template<typename ChildT , Index Log2Dim>

InternalNode | ( | PartialCreate | ,
|  | const Coord & | origin,
|  | const ValueType & | fillValue,
|  | bool | active = `false`
| ) |  |

inline

## InternalNode() [5/8]

template<typename ChildT , Index Log2Dim>

InternalNode | ( | const InternalNode< _ChildNodeType, Log2Dim > & | other | ) |

inline

Deep copy constructor.

Note
  This method is multi-threaded!

## InternalNode() [6/8]

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >

InternalNode | ( | const InternalNode< OtherChildNodeType, Log2Dim > & | other | ) |

inlineexplicit

Value conversion copy constructor.

Note
  This method is multi-threaded!

## InternalNode() [7/8]

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >

InternalNode | ( | const InternalNode< OtherChildNodeType, Log2Dim > & | other,
|  | const ValueType & | background,
|  | TopologyCopy |
| ) |  |

inline

Topology copy constructor.

Note
  This method is multi-threaded!

## InternalNode() [8/8]

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType >

InternalNode | ( | const InternalNode< OtherChildNodeType, Log2Dim > & | other,
|  | const ValueType & | offValue,
|  | const ValueType & | onValue,
|  | TopologyCopy |
| ) |  |

inline

Topology copy constructor.

Note
  This method is multi-threaded!

## ~InternalNode()

template<typename ChildT , Index Log2Dim>

~InternalNode | ( |  | ) |

inline

## Member Function Documentation

## addChild()

template<typename _ChildNodeType , Index Log2Dim>

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)

Returns
  `true` if inserting the child has been successful, otherwise the caller retains ownership of the node and is responsible for deleting it.

## addLeaf()

template<typename ChildT , Index Log2Dim>

void 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.

## addLeafAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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.

## addTile() [1/2]

template<typename ChildT , Index Log2Dim>

void 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.

## addTile() [2/2]

template<typename ChildT , Index Log2Dim>

void addTile | ( | Index | offset,
|  | const ValueType & | value,
|  | bool | state
| ) |  |

inline

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

## addTileAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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).

## beginChildAll() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildAllIter beginChildAll | ( |  | ) |

inline

## beginChildAll() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildAllCIter beginChildAll | ( |  | ) | const

inline

## beginChildOff() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildOffIter beginChildOff | ( |  | ) |

inline

## beginChildOff() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildOffCIter beginChildOff | ( |  | ) | const

inline

## beginChildOn() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildOnIter beginChildOn | ( |  | ) |

inline

## beginChildOn() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ChildOnCIter beginChildOn | ( |  | ) | const

inline

## beginValueAll() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueAllIter beginValueAll | ( |  | ) |

inline

## beginValueAll() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueAllCIter beginValueAll | ( |  | ) | const

inline

## beginValueOff() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueOffIter beginValueOff | ( |  | ) |

inline

Warning
  This iterator will also visit child nodes so use isChildMaskOn to skip them!

## beginValueOff() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueOffCIter beginValueOff | ( |  | ) | const

inline

Warning
  This iterator will also visit child nodes so use isChildMaskOn to skip them!

## beginValueOn() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueOnIter beginValueOn | ( |  | ) |

inline

## beginValueOn() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

ValueOnCIter beginValueOn | ( |  | ) | const

inline

## cbeginChildAll()

template<typename _ChildNodeType , Index Log2Dim>

ChildAllCIter cbeginChildAll | ( |  | ) | const

inline

## cbeginChildOff()

template<typename _ChildNodeType , Index Log2Dim>

ChildOffCIter cbeginChildOff | ( |  | ) | const

inline

## cbeginChildOn()

template<typename _ChildNodeType , Index Log2Dim>

ChildOnCIter cbeginChildOn | ( |  | ) | const

inline

## cbeginValueAll()

template<typename _ChildNodeType , Index Log2Dim>

ValueAllCIter cbeginValueAll | ( |  | ) | const

inline

## cbeginValueOff()

template<typename _ChildNodeType , Index Log2Dim>

ValueOffCIter cbeginValueOff | ( |  | ) | const

inline

Warning
  This iterator will also visit child nodes so use isChildMaskOn to skip them!

## cbeginValueOn()

template<typename _ChildNodeType , Index Log2Dim>

ValueOnCIter cbeginValueOn | ( |  | ) | const

inline

## childCount()

template<typename ChildT , Index Log2Dim>

Index32 childCount | ( |  | ) | const

inline

## clip()

template<typename ChildT , Index Log2Dim>

void clip | ( | const CoordBBox & | clipBBox,
|  | const ValueType & | background
| ) |  |

inline

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

## combine() [1/2]

template<typename ChildT , Index Log2Dim>
template<typename CombineOp >

void combine | ( | const ValueType & | value,
|  | bool | valueIsActive,
|  | CombineOp & | op
| ) |  |

inline

## combine() [2/2]

template<typename ChildT , Index Log2Dim>
template<typename CombineOp >

void combine | ( | InternalNode< _ChildNodeType, Log2Dim > & | other,
|  | CombineOp & | op
| ) |  |

inline

## combine2() [1/3]

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherValueType >

void combine2 | ( | const InternalNode< _ChildNodeType, Log2Dim > & | other,
|  | const OtherValueType & | value,
|  | bool | valIsActive,
|  | CombineOp & | op
| ) |  |

inline

## combine2() [2/3]

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherNodeType >

void combine2 | ( | const InternalNode< _ChildNodeType, Log2Dim > & | other0,
|  | const OtherNodeType & | other1,
|  | CombineOp & | op
| ) |  |

inline

## combine2() [3/3]

template<typename ChildT , Index Log2Dim>
template<typename CombineOp , typename OtherNodeType >

void combine2 | ( | const ValueType & | value,
|  | const OtherNodeType & | other,
|  | bool | valIsActive,
|  | CombineOp & | op
| ) |  |

inline

## coordToOffset()

template<typename ChildT , Index Log2Dim>

Index coordToOffset | ( | const Coord & | xyz | ) |

inlinestatic

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

## copyToDense()

template<typename ChildT , Index Log2Dim>
template<typename DenseT >

void 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

  bbox | inclusive bounding box of the voxels to be copied into the dense grid
  dense | dense 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.

## denseFill()

template<typename ChildT , Index Log2Dim>

void 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

  bbox | inclusive coordinates of opposite corners of an axis-aligned box.
  value | the value to which to set voxels within the box.
  active | if true, mark voxels within the box as active, otherwise mark them as inactive.

See also
  voxelizeActiveTiles()

## dim()

template<typename _ChildNodeType , Index Log2Dim>

static Index dim | ( |  | ) |

inlinestatic

Returns
  The dimension of this InternalNode

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

## evalActiveBoundingBox()

template<typename ChildT , Index Log2Dim>

void 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.

## fill()

template<typename ChildT , Index Log2Dim>

void 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

  bbox | inclusive coordinates of opposite corners of an axis-aligned box
  value | the value to which to set voxels within the box
  active | if 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.

## getChildDim()

template<typename _ChildNodeType , Index Log2Dim>

static Index 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.

## getChildMask()

template<typename _ChildNodeType , Index Log2Dim>

const NodeMaskType & getChildMask | ( |  | ) | const

inline

## getChildNode() [1/2]

template<typename ChildT , Index Log2Dim>

ChildT * 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!

## getChildNode() [2/2]

template<typename ChildT , Index Log2Dim>

const ChildT * 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!

## getFirstValue()

template<typename ChildT , Index Log2Dim>

const ChildT::ValueType & 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.

## getLastValue()

template<typename ChildT , Index Log2Dim>

const ChildT::ValueType & 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.

## getLevel()

template<typename _ChildNodeType , Index Log2Dim>

static Index getLevel | ( |  | ) |

inlinestatic

Returns
  The level of this node

Level 0 is by definition the level of the leaf nodes

## getNodeBoundingBox()

template<typename _ChildNodeType , Index Log2Dim>

CoordBBox getNodeBoundingBox | ( |  | ) | const

inline

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

## getNodeLog2Dims()

template<typename ChildT , Index Log2Dim>

void getNodeLog2Dims | ( | std::vector< Index > & | dims | ) |

static

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

## getNodes() [1/2]

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >

void 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);

## getNodes() [2/2]

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >

void getNodes | ( | ArrayT & | array | ) | const

inline

## getTable()

template<typename _ChildNodeType , Index Log2Dim>

const UnionType * getTable | ( |  | ) | const

inline

## getValue()

template<typename ChildT , Index Log2Dim>

const ChildT::ValueType & getValue | ( | const Coord & | xyz | ) | const

inline

## getValueAndCache() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const ValueType & 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.

## getValueAndCache() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const ChildT::ValueType & getValueAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

inline

## getValueLevel()

template<typename ChildT , Index Log2Dim>

Index getValueLevel | ( | const Coord & | xyz | ) | const

inline

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

## getValueLevelAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

Index 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.

## getValueMask()

template<typename _ChildNodeType , Index Log2Dim>

const NodeMaskType & getValueMask | ( |  | ) | const

inline

## getValueOffMask()

template<typename _ChildNodeType , Index Log2Dim>

NodeMaskType getValueOffMask | ( |  | ) | const

inline

## hasActiveTiles()

template<typename ChildT , Index Log2Dim>

bool hasActiveTiles | ( |  | ) | const

inline

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

## hasSameTopology()

template<typename ChildT , Index Log2Dim>
template<typename OtherChildNodeType , Index OtherLog2Dim>

bool 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`).

## isChildMaskOff() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isChildMaskOff | ( |  | ) | const

inline

## isChildMaskOff() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isChildMaskOff | ( | Index | n | ) | const

inline

## isChildMaskOn()

template<typename _ChildNodeType , Index Log2Dim>

bool isChildMaskOn | ( | Index | n | ) | const

inline

## isConstant() [1/2]

template<typename ChildT , Index Log2Dim>

bool 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.

## isConstant() [2/2]

template<typename ChildT , Index Log2Dim>

bool 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

  minValue | Is updated with the minimum of all values IF method returns `true`. Else the value is undefined!
  maxValue | Is updated with the maximum of all values IF method returns `true`. Else the value is undefined!
  state | Is updated with the state of all values IF method returns `true`. Else the value is undefined!
  tolerance | The tolerance used to determine if values are approximately constant.

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

## isEmpty()

template<typename _ChildNodeType , Index Log2Dim>

bool isEmpty | ( |  | ) | const

inline

Returns
  True if this node contains no child nodes.

## isInactive()

template<typename _ChildNodeType , Index Log2Dim>

bool isInactive | ( |  | ) | const

inline

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

## isValueMaskOff() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isValueMaskOff | ( |  | ) | const

inline

## isValueMaskOff() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isValueMaskOff | ( | Index | n | ) | const

inline

## isValueMaskOn() [1/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isValueMaskOn | ( |  | ) | const

inline

## isValueMaskOn() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isValueMaskOn | ( | Index | n | ) | const

inline

## isValueOn() [1/2]

template<typename ChildT , Index Log2Dim>

bool isValueOn | ( | const Coord & | xyz | ) | const

inline

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

## isValueOn() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

bool isValueOn | ( | Index | offset | ) | const

inline

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

## isValueOnAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

bool 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.

## leafCount()

template<typename ChildT , Index Log2Dim>

Index32 leafCount | ( |  | ) | const

inline

## makeChildNodeEmpty()

template<typename ChildT , Index Log2Dim>

void makeChildNodeEmpty | ( | Index | n,
|  | const ValueType & | value
| ) |  |

inlineprotected

## memUsage()

template<typename ChildT , Index Log2Dim>

Index64 memUsage | ( |  | ) | const

inline

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

## merge() [1/2]

template<typename ChildT , Index Log2Dim>
template<MergePolicy Policy>

void 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.

## merge() [2/2]

template<typename ChildT , Index Log2Dim>
template<MergePolicy Policy>

void 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.

## modifyValue()

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp >

void 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.

## modifyValueAndActiveState()

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp >

void modifyValueAndActiveState | ( | const Coord & | xyz,
|  | const ModifyOp & | op
| ) |  |

inline

Apply a functor to the voxel at the given coordinates.

## modifyValueAndActiveStateAndCache()

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp , typename AccessorT >

void 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.

## modifyValueAndCache()

template<typename ChildT , Index Log2Dim>
template<typename ModifyOp , typename AccessorT >

void 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.

## negate()

template<typename ChildT , Index Log2Dim>

void negate | ( |  | ) |

inline

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

## nodeCount()

template<typename ChildT , Index Log2Dim>

void nodeCount | ( | std::vector< Index32 > & | vec | ) | const

inline

## nonLeafCount()

template<typename ChildT , Index Log2Dim>

Index32 nonLeafCount | ( |  | ) | const

inline

## offLeafVoxelCount()

template<typename ChildT , Index Log2Dim>

Index64 offLeafVoxelCount | ( |  | ) | const

inline

## offsetToGlobalCoord()

template<typename ChildT , Index Log2Dim>

Coord offsetToGlobalCoord | ( | Index | n | ) | const

inline

Return the global coordinates for a linear table offset.

## offsetToLocalCoord()

template<typename ChildT , Index Log2Dim>

void offsetToLocalCoord | ( | Index | n,
|  | Coord & | xyz
| ) |  |

inlinestatic

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

## offVoxelCount()

template<typename ChildT , Index Log2Dim>

Index64 offVoxelCount | ( |  | ) | const

inline

## onLeafVoxelCount()

template<typename ChildT , Index Log2Dim>

Index64 onLeafVoxelCount | ( |  | ) | const

inline

## onTileCount()

template<typename ChildT , Index Log2Dim>

Index64 onTileCount | ( |  | ) | const

inline

## onVoxelCount()

template<typename ChildT , Index Log2Dim>

Index64 onVoxelCount | ( |  | ) | const

inline

## origin()

template<typename _ChildNodeType , Index Log2Dim>

const Coord & origin | ( |  | ) | const

inline

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

## probeConstLeaf()

template<typename ChildT , Index Log2Dim>

const ChildT::LeafNodeType * probeConstLeaf | ( | const Coord & | xyz | ) | const

inline

## probeConstLeafAndCache() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const LeafNodeType * probeConstLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

## probeConstLeafAndCache() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const ChildT::LeafNodeType * probeConstLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

inline

## probeConstNode() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeType >

const NodeType * probeConstNode | ( | const Coord & | xyz | ) | const

## probeConstNode() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeT >

const NodeT * probeConstNode | ( | const Coord & | xyz | ) | const

inline

## probeConstNodeAndCache() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeType , typename AccessorT >

const NodeType * probeConstNodeAndCache | ( | const Coord & | xyz,
|  | AccessorT & |
| ) |  | const

## probeConstNodeAndCache() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeT , typename AccessorT >

const NodeT * probeConstNodeAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

inline

## probeLeaf() [1/2]

template<typename ChildT , Index Log2Dim>

ChildT::LeafNodeType * 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`.

## probeLeaf() [2/2]

template<typename _ChildNodeType , Index Log2Dim>

const LeafNodeType * probeLeaf | ( | const Coord & | xyz | ) | const

## probeLeafAndCache() [1/4]

template<typename _ChildNodeType , Index Log2Dim>
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).

## probeLeafAndCache() [2/4]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

ChildT::LeafNodeType * probeLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  |

inline

## probeLeafAndCache() [3/4]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const LeafNodeType * probeLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

## probeLeafAndCache() [4/4]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

const ChildT::LeafNodeType * probeLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  | const

inline

## probeNode() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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.

## probeNode() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeT >

NodeT * probeNode | ( | const Coord & | xyz | ) |

inline

## probeNodeAndCache() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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).

## probeNodeAndCache() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename NodeT , typename AccessorT >

NodeT * probeNodeAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  |

inline

## probeValue()

template<typename ChildT , Index Log2Dim>

bool probeValue | ( | const Coord & | xyz,
|  | ValueType & | value
| ) |  | const

inline

## probeValueAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

bool 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.

## prune()

template<typename ChildT , Index Log2Dim>

void 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.

## readBuffers() [1/2]

template<typename ChildT , Index Log2Dim>

void readBuffers | ( | std::istream & | is,
|  | bool | fromHalf = `false`
| ) |  |

inline

## readBuffers() [2/2]

template<typename ChildT , Index Log2Dim>

void readBuffers | ( | std::istream & | is,
|  | const CoordBBox & | clipBBox,
|  | bool | fromHalf = `false`
| ) |  |

inline

## readTopology()

template<typename ChildT , Index Log2Dim>

void readTopology | ( | std::istream & | is,
|  | bool | fromHalf = `false`
| ) |  |

inline

## resetBackground()

template<typename ChildT , Index Log2Dim>

void 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.

## resetChildNode()

template<typename ChildT , Index Log2Dim>

void resetChildNode | ( | Index | i,
|  | ChildNodeType * | child
| ) |  |

inlineprotected

## setActiveState()

template<typename ChildT , Index Log2Dim>

void setActiveState | ( | const Coord & | xyz,
|  | bool | on
| ) |  |

inline

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

## setActiveStateAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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.

## setChildNode()

template<typename ChildT , Index Log2Dim>

void setChildNode | ( | Index | i,
|  | ChildNodeType * | child
| ) |  |

inlineprotected

## setOrigin()

template<typename _ChildNodeType , Index Log2Dim>

void setOrigin | ( | const Coord & | origin | ) |

inline

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

## setTransientData()

template<typename _ChildNodeType , Index Log2Dim>

void setTransientData | ( | Index32 | transientData | ) |

inline

Set the transient data value.

## setValueAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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.

## setValueMask()

template<typename _ChildNodeType , Index Log2Dim>

void 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.

## setValueOff() [1/2]

template<typename ChildT , Index Log2Dim>

void setValueOff | ( | const Coord & | xyz | ) |

inline

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

## setValueOff() [2/2]

template<typename ChildT , Index Log2Dim>

void setValueOff | ( | const Coord & | xyz,
|  | const ValueType & | value
| ) |  |

inline

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

## setValueOffAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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.

## setValueOn() [1/2]

template<typename ChildT , Index Log2Dim>

void setValueOn | ( | const Coord & | xyz | ) |

inline

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

## setValueOn() [2/2]

template<typename ChildT , Index Log2Dim>

void setValueOn | ( | const Coord & | xyz,
|  | const ValueType & | value
| ) |  |

inline

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

## setValueOnly()

template<typename ChildT , Index Log2Dim>

void 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.

## setValueOnlyAndCache()

template<typename ChildT , Index Log2Dim>
template<typename AccessorT >

void 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.

## setValuesOn()

template<typename ChildT , Index Log2Dim>

void setValuesOn | ( |  | ) |

inline

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

## stealNode()

template<typename ChildT , Index Log2Dim>
template<typename NodeT >

NodeT * 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.

## stealNodes()

template<typename ChildT , Index Log2Dim>
template<typename ArrayT >

void 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);

## topologyDifference() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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.

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.

## topologyDifference() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename OtherChildT >

void topologyDifference | ( | const InternalNode< OtherChildT, Log2Dim > & | other,
|  | const ValueType & | background
| ) |  |

inline

## topologyIntersection() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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.

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.

## topologyIntersection() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename OtherChildT >

void topologyIntersection | ( | const InternalNode< OtherChildT, Log2Dim > & | other,
|  | const ValueType & | background
| ) |  |

inline

## topologyUnion() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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.

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.

## topologyUnion() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename OtherChildT >

void topologyUnion | ( | const InternalNode< OtherChildT, Log2Dim > & | other,
|  | const bool | preserveTiles
| ) |  |

inline

## touchLeaf()

template<typename ChildT , Index Log2Dim>

ChildT::LeafNodeType * 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.

## touchLeafAndCache() [1/2]

template<typename _ChildNodeType , Index Log2Dim>
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.

## touchLeafAndCache() [2/2]

template<typename _ChildNodeType , Index Log2Dim>
template<typename AccessorT >

ChildT::LeafNodeType * touchLeafAndCache | ( | const Coord & | xyz,
|  | AccessorT & | acc
| ) |  |

inline

## transientData()

template<typename _ChildNodeType , Index Log2Dim>

Index32 transientData | ( |  | ) | const

inline

Return the transient data value.

## unsetChildNode()

template<typename ChildT , Index Log2Dim>

ChildT * unsetChildNode | ( | Index | i,
|  | const ValueType & | value
| ) |  |

inlineprotected

## voxelizeActiveTiles()

template<typename ChildT , Index Log2Dim>

void voxelizeActiveTiles | ( | bool | threaded = `true` | ) |

inline

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

Parameters

  threaded | if true, this operation is multi-threaded (over the internal nodes).

See also
  denseFill()

## writeBuffers()

template<typename ChildT , Index Log2Dim>

void writeBuffers | ( | std::ostream & | os,
|  | bool | toHalf = `false`
| ) |  | const

inline

## writeTopology()

template<typename ChildT , Index Log2Dim>

void writeTopology | ( | std::ostream & | os,
|  | bool | toHalf = `false`
| ) |  | const

inline

## Friends And Related Symbol Documentation

## InternalNode

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.

## IteratorBase< MaskDenseIterator, InternalNode >

template<typename _ChildNodeType , Index Log2Dim>

friend class IteratorBase< MaskDenseIterator, InternalNode >

friend

## IteratorBase< MaskOffIterator, InternalNode >

template<typename _ChildNodeType , Index Log2Dim>

friend class IteratorBase< MaskOffIterator, InternalNode >

friend

## IteratorBase< MaskOnIterator, InternalNode >

template<typename _ChildNodeType , Index Log2Dim>

friend class IteratorBase< MaskOnIterator, InternalNode >

friend

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

## Member Data Documentation

## DIM

template<typename _ChildNodeType , Index Log2Dim>

const Index DIM = 1 << TOTAL

static

## LEVEL

template<typename _ChildNodeType , Index Log2Dim>

const Index LEVEL = 1 + ChildNodeType::LEVEL

static

## LOG2DIM

template<typename _ChildNodeType , Index Log2Dim>

const Index LOG2DIM = Log2Dim

static

## mChildMask

template<typename _ChildNodeType , Index Log2Dim>

NodeMaskType mChildMask

protected

## mNodes

template<typename _ChildNodeType , Index Log2Dim>

UnionType mNodes[NUM_VALUES]

protected

## mOrigin

template<typename _ChildNodeType , Index Log2Dim>

Coord mOrigin

protected

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

## mTransientData

template<typename _ChildNodeType , Index Log2Dim>

Index32 mTransientData = 0

protected

Transient data (not serialized)

## mValueMask

template<typename _ChildNodeType , Index Log2Dim>

NodeMaskType mValueMask

protected

## NUM_VALUES

template<typename _ChildNodeType , Index Log2Dim>

const Index NUM_VALUES = 1 << (3 * Log2Dim)

static

## NUM_VOXELS

template<typename _ChildNodeType , Index Log2Dim>

const Index64 NUM_VOXELS = uint64_t(1) << (3 * TOTAL)

static

## TOTAL

template<typename _ChildNodeType , Index Log2Dim>

const Index TOTAL = Log2Dim + ChildNodeType::TOTAL

static