OpenVDB 11.0.0

Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
LeafNode< T, Log2Dim > Class Template Reference

Templated block class to hold specific data types and a fixed number of values determined by Log2Dim. The actual coordinate dimension of the block is 2^Log2Dim, i.e. Log2Dim=3 corresponds to a LeafNode that spans a 8^3 block. More...

`#include <openvdb/tree/LeafNode.h>`

Inheritance diagram for LeafNode< T, Log2Dim >:

## Classes
struct | ChildAll
struct | ChildIter
| Leaf nodes have no children, so their child iterators have no get/set accessors. More...
struct | ChildOff
struct | ChildOn
struct | DenseIter
struct | SameConfiguration
| SameConfiguration<OtherNodeType>::value is `true` if and only if OtherNodeType is the type of a LeafNode with the same dimensions as this node. More...
struct | ValueAll
struct | ValueConverter
| ValueConverter<T>::Type is the type of a LeafNode having the same dimensions as this node but a different value type, T. More...
struct | ValueIter
struct | ValueOff
struct | ValueOn

## Public Types
using | BuildType = T
using | ValueType = T
using | Buffer = LeafBuffer<ValueType, Log2Dim>
using | LeafNodeType = LeafNode<ValueType, Log2Dim>
using | NodeMaskType = util::NodeMask<Log2Dim>
using | Ptr = SharedPtr<LeafNode>
using | ValueOnIter = ValueIter<MaskOnIterator, LeafNode, const ValueType, ValueOn>
using | ValueOnCIter = ValueIter<MaskOnIterator, const LeafNode, const ValueType, ValueOn>
using | ValueOffIter = ValueIter<MaskOffIterator, LeafNode, const ValueType, ValueOff>
using | ValueOffCIter = ValueIter<MaskOffIterator,const LeafNode,const ValueType,ValueOff>
using | ValueAllIter = ValueIter<MaskDenseIterator, LeafNode, const ValueType, ValueAll>
using | ValueAllCIter = ValueIter<MaskDenseIterator,const LeafNode,const ValueType,ValueAll>
using | ChildOnIter = ChildIter<MaskOnIterator, LeafNode, ChildOn>
using | ChildOnCIter = ChildIter<MaskOnIterator, const LeafNode, ChildOn>
using | ChildOffIter = ChildIter<MaskOffIterator, LeafNode, ChildOff>
using | ChildOffCIter = ChildIter<MaskOffIterator, const LeafNode, ChildOff>
using | ChildAllIter = DenseIter<LeafNode, ValueType, ChildAll>
using | ChildAllCIter = DenseIter<const LeafNode, const ValueType, ChildAll>

## Public Member Functions
| LeafNode ()
| Default constructor.
| LeafNode (const Coord &coords, const ValueType &value=zeroVal< ValueType >(), bool active=false)
| Constructor.
| LeafNode (PartialCreate, const Coord &coords, const ValueType &value=zeroVal< ValueType >(), bool active=false)
| "Partial creation" constructor used during file input
| LeafNode (const LeafNode &)
| Deep copy constructor.
LeafNode & | operator= (const LeafNode &)=default
| Deep assignment operator.
template<typename OtherValueType >
| LeafNode (const LeafNode< OtherValueType, Log2Dim > &other)
| Value conversion copy constructor.
template<typename OtherValueType >
| LeafNode (const LeafNode< OtherValueType, Log2Dim > &other, const ValueType &offValue, const ValueType &onValue, TopologyCopy)
| Topology copy constructor.
template<typename OtherValueType >
| LeafNode (const LeafNode< OtherValueType, Log2Dim > &other, const ValueType &background, TopologyCopy)
| Topology copy constructor.
| ~LeafNode ()
| Destructor.
void | nodeCount (std::vector< Index32 > &) const
| no-op
Index64 | onVoxelCount () const
| Return the number of voxels marked On.
Index64 | offVoxelCount () const
| Return the number of voxels marked Off.
Index64 | onLeafVoxelCount () const
Index64 | offLeafVoxelCount () const
bool | isEmpty () const
| Return `true` if this node has no active voxels.
bool | isDense () const
| Return `true` if this node contains only active voxels.
bool | isAllocated () const
| Return `true` if memory for this node's buffer has been allocated.
bool | allocate ()
| Allocate memory for this node's buffer if it has not already been allocated.
Index64 | memUsage () const
| Return the memory in bytes occupied by this node.
Index64 | memUsageIfLoaded () const
void | evalActiveBoundingBox (CoordBBox &bbox, bool visitVoxels=true) const
CoordBBox | getNodeBoundingBox () const
| Return the bounding box of this node, i.e., the full index space spanned by this leaf node.
void | setOrigin (const Coord &origin)
| Set the grid index coordinates of this node's local origin.
const Coord & | origin () const
| Return the grid index coordinates of this node's local origin.
void | getOrigin (Coord &origin) const
void | getOrigin (Int32 &x, Int32 &y, Int32 &z) const
Coord | offsetToGlobalCoord (Index n) const
| Return the global coordinates for a linear table offset.
Index32 | transientData () const
| Return the transient data value.
void | setTransientData (Index32 transientData)
| Set the transient data value.
std::string | str () const
| Return a string representation of this node.
template<typename OtherType , Index OtherLog2Dim>
bool | hasSameTopology (const LeafNode< OtherType, OtherLog2Dim > *other) const
| Return `true` if the given node (which may have a different `ValueType` than this node) has the same active value topology as this node.
bool | operator== (const LeafNode &other) const
| Check for buffer, state and origin equivalence.
bool | operator!= (const LeafNode &other) const
ValueOnCIter | cbeginValueOn () const
ValueOnCIter | beginValueOn () const
ValueOnIter | beginValueOn ()
ValueOffCIter | cbeginValueOff () const
ValueOffCIter | beginValueOff () const
ValueOffIter | beginValueOff ()
ValueAllCIter | cbeginValueAll () const
ValueAllCIter | beginValueAll () const
ValueAllIter | beginValueAll ()
ValueOnCIter | cendValueOn () const
ValueOnCIter | endValueOn () const
ValueOnIter | endValueOn ()
ValueOffCIter | cendValueOff () const
ValueOffCIter | endValueOff () const
ValueOffIter | endValueOff ()
ValueAllCIter | cendValueAll () const
ValueAllCIter | endValueAll () const
ValueAllIter | endValueAll ()
ChildOnCIter | cbeginChildOn () const
ChildOnCIter | beginChildOn () const
ChildOnIter | beginChildOn ()
ChildOffCIter | cbeginChildOff () const
ChildOffCIter | beginChildOff () const
ChildOffIter | beginChildOff ()
ChildAllCIter | cbeginChildAll () const
ChildAllCIter | beginChildAll () const
ChildAllIter | beginChildAll ()
ChildOnCIter | cendChildOn () const
ChildOnCIter | endChildOn () const
ChildOnIter | endChildOn ()
ChildOffCIter | cendChildOff () const
ChildOffCIter | endChildOff () const
ChildOffIter | endChildOff ()
ChildAllCIter | cendChildAll () const
ChildAllCIter | endChildAll () const
ChildAllIter | endChildAll ()
void | swap (Buffer &other)
| Exchange this node's data buffer with the given data buffer without changing the active states of the values.
const Buffer & | buffer () const
Buffer & | buffer ()
void | readTopology (std::istream &is, bool fromHalf=false)
| Read in just the topology.
void | writeTopology (std::ostream &os, bool toHalf=false) const
| Write out just the topology.
void | readBuffers (std::istream &is, bool fromHalf=false)
| Read buffers from a stream.
void | readBuffers (std::istream &is, const CoordBBox &bbox, bool fromHalf=false)
| Read buffers that intersect the given bounding box.
void | writeBuffers (std::ostream &os, bool toHalf=false) const
| Write buffers to a stream.
size_t | streamingSize (bool toHalf=false) const
const ValueType & | getValue (const Coord &xyz) const
| Return the value of the voxel at the given coordinates.
const ValueType & | getValue (Index offset) const
| Return the value of the voxel at the given linear offset.
bool | probeValue (const Coord &xyz, ValueType &val) const
| Return `true` if the voxel at the given coordinates is active.
bool | probeValue (Index offset, ValueType &val) const
| Return `true` if the voxel at the given offset is active.
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 | setActiveState (Index offset, bool on)
| Set the active state of the voxel at the given offset but don't change its value.
void | setValueOnly (const Coord &xyz, const ValueType &val)
| Set the value of the voxel at the given coordinates but don't change its active state.
void | setValueOnly (Index offset, const ValueType &val)
| Set the value of the voxel at the given offset but don't change its active state.
void | setValueOff (const Coord &xyz)
| Mark the voxel at the given coordinates as inactive but don't change its value.
void | setValueOff (Index offset)
| Mark the voxel at the given offset as inactive but don't change its value.
void | setValueOff (const Coord &xyz, const ValueType &val)
| Set the value of the voxel at the given coordinates and mark the voxel as inactive.
void | setValueOff (Index offset, const ValueType &val)
| Set the value of the voxel at the given offset and mark the voxel as inactive.
void | setValueOn (const Coord &xyz)
| Mark the voxel at the given coordinates as active but don't change its value.
void | setValueOn (Index offset)
| Mark the voxel at the given offset as active but don't change its value.
void | setValueOn (const Coord &xyz, const ValueType &val)
| Set the value of the voxel at the given coordinates and mark the voxel as active.
void | setValue (const Coord &xyz, const ValueType &val)
| Set the value of the voxel at the given coordinates and mark the voxel as active.
void | setValueOn (Index offset, const ValueType &val)
| Set the value of the voxel at the given offset and mark the voxel as active.
template<typename ModifyOp >
void | modifyValue (Index offset, const ModifyOp &op)
| Apply a functor to the value of the voxel at the given offset and mark the voxel as active.
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.
void | setValuesOn ()
| Mark all voxels as active but don't change their values.
void | setValuesOff ()
| Mark all voxels as inactive but don't change their 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.
void | clip (const CoordBBox &, const ValueType &background)
| Set all voxels that lie outside the given axis-aligned box to the background.
void | fill (const CoordBBox &bbox, const ValueType &, bool active=true)
| Set all voxels within an axis-aligned box to the specified value and active state.
void | denseFill (const CoordBBox &bbox, const ValueType &value, bool active=true)
| Set all voxels within an axis-aligned box to the specified value and active state.
void | fill (const ValueType &value)
| Set all voxels to the specified value but don't change their active states.
void | fill (const ValueType &value, bool active)
| Set all voxels to the specified value and active state.
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<typename DenseT >
void | copyFromDense (const CoordBBox &bbox, const DenseT &dense, const ValueType &background, const ValueType &tolerance)
| Copy from a dense grid into this node the values of the voxels that lie within a given bounding box.
template<typename AccessorT >
const ValueType & | getValueAndCache (const Coord &xyz, AccessorT &) const
| Return the value of the voxel at the given coordinates.
template<typename AccessorT >
bool | isValueOnAndCache (const Coord &xyz, AccessorT &) const
| Return `true` if the voxel at the given coordinates is active.
template<typename AccessorT >
void | setValueAndCache (const Coord &xyz, const ValueType &val, AccessorT &)
| Change the value of the voxel at the given coordinates and mark it as active.
template<typename AccessorT >
void | setValueOnlyAndCache (const Coord &xyz, const ValueType &val, AccessorT &)
| Change the value of the voxel at the given coordinates but preserve its state.
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.
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 &)
| Change the value of the voxel at the given coordinates and mark it as inactive.
template<typename AccessorT >
void | setActiveStateAndCache (const Coord &xyz, bool on, AccessorT &)
| Set the active state of the voxel at the given coordinates without changing its value.
template<typename AccessorT >
bool | probeValueAndCache (const Coord &xyz, ValueType &val, AccessorT &) const
| Return `true` if the voxel at the given coordinates is active and return the voxel value in val.
template<typename AccessorT >
const ValueType & | getValue (const Coord &xyz, bool &state, int &level, AccessorT &) const
| Return the value of the voxel at the given coordinates and return its active state and level (i.e., 0) in state and level.
const ValueType & | getFirstValue () const
| Return a const reference to the first value in the buffer.
const ValueType & | getLastValue () const
| Return a const reference to the last value in the buffer.
void | resetBackground (const ValueType &oldBackground, const ValueType &newBackground)
| Replace inactive occurrences of oldBackground with newBackground, and inactive occurrences of -oldBackground with -newBackground.
void | negate ()
void | voxelizeActiveTiles (bool=true)
| No-op.
template<MergePolicy Policy>
void | merge (const LeafNode &)
template<MergePolicy Policy>
void | merge (const ValueType &tileValue, bool tileActive)
template<MergePolicy Policy>
void | merge (const LeafNode &other, const ValueType &, const ValueType &)
template<typename OtherType >
void | topologyUnion (const LeafNode< OtherType, Log2Dim > &other, const bool preserveTiles=false)
| Union 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 if either of the original voxels were active.
template<typename OtherType >
void | topologyIntersection (const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
| Intersect this node's set of active values with the active values of the other node, whose `ValueType` may be different. So a resulting voxel will be active only if both of the original voxels were active.
template<typename OtherType >
void | topologyDifference (const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
| Difference this node's set of active values with the active values of the other node, whose `ValueType` may be different. So a resulting voxel will be active only if the original voxel is active in this LeafNode and inactive in the other LeafNode.
template<typename CombineOp >
void | combine (const LeafNode &other, CombineOp &op)
template<typename CombineOp >
void | combine (const ValueType &value, bool valueIsActive, CombineOp &op)
template<typename CombineOp , typename OtherType >
void | combine2 (const LeafNode &other, const OtherType &, bool valueIsActive, CombineOp &)
template<typename CombineOp , typename OtherNodeT >
void | combine2 (const ValueType &, const OtherNodeT &other, bool valueIsActive, CombineOp &)
template<typename CombineOp , typename OtherNodeT >
void | combine2 (const LeafNode &b0, const OtherNodeT &b1, CombineOp &)
void | prune (const ValueType &=zeroVal< ValueType >())
| This function exists only to enable template instantiation.
void | addLeaf (LeafNode *)
template<typename AccessorT >
void | addLeafAndCache (LeafNode *, AccessorT &)
template<typename NodeT >
NodeT * | stealNode (const Coord &, const ValueType &, bool)
template<typename NodeT >
NodeT * | probeNode (const Coord &)
template<typename NodeT >
const NodeT * | probeConstNode (const Coord &) const
template<typename ArrayT >
void | getNodes (ArrayT &) const
template<typename ArrayT >
void | stealNodes (ArrayT &, const ValueType &, bool)
void | addTile (Index level, const Coord &, const ValueType &, bool)
void | addTile (Index offset, const ValueType &, bool)
template<typename AccessorT >
void | addTileAndCache (Index, const Coord &, const ValueType &, bool, AccessorT &)
LeafNode * | touchLeaf (const Coord &)
| Return a pointer to this node.
template<typename AccessorT >
LeafNode * | touchLeafAndCache (const Coord &, AccessorT &)
template<typename NodeT , typename AccessorT >
NodeT * | probeNodeAndCache (const Coord &, AccessorT &)
LeafNode * | probeLeaf (const Coord &)
template<typename AccessorT >
LeafNode * | probeLeafAndCache (const Coord &, AccessorT &)
const LeafNode * | probeConstLeaf (const Coord &) const
| Return a `const` pointer to this node.
template<typename AccessorT >
const LeafNode * | probeConstLeafAndCache (const Coord &, AccessorT &) const
template<typename AccessorT >
const LeafNode * | probeLeafAndCache (const Coord &, AccessorT &) const
const LeafNode * | probeLeaf (const Coord &) const
template<typename NodeT , typename AccessorT >
const NodeT * | probeConstNodeAndCache (const Coord &, AccessorT &) 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
ValueType | medianAll (ValueType *tmp=nullptr) const
| Computes the median value of all the active AND inactive voxels in this node.
Index | medianOn (ValueType &value, ValueType *tmp=nullptr) const
| Computes the median value of all the active voxels in this node.
Index | medianOff (ValueType &value, ValueType *tmp=nullptr) const
| Computes the median value of all the inactive voxels in this node.
bool | isInactive () const
| Return `true` if all of this node's values are inactive.
bool | isValueMaskOn (Index n) const
bool | isValueMaskOn () const
bool | isValueMaskOff (Index n) const
bool | isValueMaskOff () const
const NodeMaskType & | getValueMask () const
NodeMaskType & | getValueMask ()
const NodeMaskType & | valueMask () const
void | setValueMask (const NodeMaskType &mask)
bool | isChildMaskOn (Index) const
bool | isChildMaskOff (Index) const
bool | isChildMaskOff () const
template<typename ValueT >
| LeafNode (const LeafNode< ValueT, Log2Dim > &other, bool background, TopologyCopy)

## Static Public Member Functions
static Index | log2dim ()
| Return log2 of the dimension of this LeafNode, e.g. 3 if dimensions are 8^3.
static Index | dim ()
| Return the number of voxels in each coordinate dimension.
static Index | size ()
| Return the total number of voxels represented by this LeafNode.
static Index | numValues ()
| Return the total number of voxels represented by this LeafNode.
static Index | getLevel ()
| Return the level of this node, which by definition is zero for LeafNodes.
static void | getNodeLog2Dims (std::vector< Index > &dims)
| Append the Log2Dim of this LeafNode to the specified vector.
static Index | getChildDim ()
| Return the dimension of child nodes of this LeafNode, which is one for voxels.
static Index32 | leafCount ()
| Return the leaf count for this node, which is one.
static Index32 | nonLeafCount ()
| Return the non-leaf count for this node, which is zero.
static Index32 | childCount ()
| Return the child count for this node, which is zero.
static Index64 | onTileCount ()
static Index64 | offTileCount ()
static Index | coordToOffset (const Coord &xyz)
| Return the linear table offset of the given global or local coordinates.
static Coord | offsetToLocalCoord (Index n)
| Return the local coordinates for a linear table offset, where offset 0 has coordinates (0, 0, 0).
static Index | getValueLevel (const Coord &)
| Return the level (i.e., 0) at which leaf node values reside.
static bool | hasActiveTiles ()
| Return `false` since leaf nodes never contain tiles.
template<typename AccessorT >
static Index | getValueLevelAndCache (const Coord &, AccessorT &)
| Return the LEVEL (=0) at which leaf node values reside.

## Static Public Attributes
static const Index | LOG2DIM = Log2Dim
static const Index | TOTAL = Log2Dim
static const Index | DIM = 1 << TOTAL
static const Index | NUM_VALUES = 1 << 3 * Log2Dim
static const Index | NUM_VOXELS = NUM_VALUES
static const Index | SIZE = NUM_VALUES
static const Index | LEVEL = 0

## 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 | setValueMaskOn (Index n)
void | setValueMaskOff (Index n)
void | skipCompressedValues (bool seekable, std::istream &, bool fromHalf)

## Static Protected Member Functions
static void | evalNodeOrigin (Coord &xyz)
| Compute the origin of the leaf node that contains the voxel with the given coordinates.

## Friends
class | ::TestLeaf
template<typename >
class | ::TestLeafIO
template<typename , Index >
class | LeafNode
struct | ValueIter< MaskOnIterator, LeafNode, ValueType, ValueOn >
struct | ValueIter< MaskOffIterator, LeafNode, ValueType, ValueOff >
struct | ValueIter< MaskDenseIterator, LeafNode, ValueType, ValueAll >
struct | ValueIter< MaskOnIterator, const LeafNode, ValueType, ValueOn >
struct | ValueIter< MaskOffIterator, const LeafNode, ValueType, ValueOff >
struct | ValueIter< MaskDenseIterator, const LeafNode, ValueType, ValueAll >
class | IteratorBase< MaskOnIterator, LeafNode >
class | IteratorBase< MaskOffIterator, LeafNode >
class | IteratorBase< MaskDenseIterator, LeafNode >

## Detailed Description

template<typename T, Index Log2Dim>
class openvdb::v11_0::tree::LeafNode< T, Log2Dim >

Templated block class to hold specific data types and a fixed number of values determined by Log2Dim. The actual coordinate dimension of the block is 2^Log2Dim, i.e. Log2Dim=3 corresponds to a LeafNode that spans a 8^3 block.

## Member Typedef Documentation

## ◆ Buffer

template<typename T , Index Log2Dim>

using Buffer = LeafBuffer<ValueType, Log2Dim>

## ◆ BuildType

template<typename T , Index Log2Dim>

using BuildType = T

## ◆ ChildAllCIter

template<typename T , Index Log2Dim>

using ChildAllCIter = DenseIter<const LeafNode, const ValueType, ChildAll>

## ◆ ChildAllIter

template<typename T , Index Log2Dim>

using ChildAllIter = DenseIter<LeafNode, ValueType, ChildAll>

## ◆ ChildOffCIter

template<typename T , Index Log2Dim>

using ChildOffCIter = ChildIter<MaskOffIterator, const LeafNode, ChildOff>

## ◆ ChildOffIter

template<typename T , Index Log2Dim>

using ChildOffIter = ChildIter<MaskOffIterator, LeafNode, ChildOff>

## ◆ ChildOnCIter

template<typename T , Index Log2Dim>

using ChildOnCIter = ChildIter<MaskOnIterator, const LeafNode, ChildOn>

## ◆ ChildOnIter

template<typename T , Index Log2Dim>

using ChildOnIter = ChildIter<MaskOnIterator, LeafNode, ChildOn>

## ◆ LeafNodeType

template<typename T , Index Log2Dim>

using LeafNodeType = LeafNode<ValueType, Log2Dim>

## ◆ MaskDenseIterator

template<typename T , Index Log2Dim>

using MaskDenseIterator = typename NodeMaskType::DenseIterator
| protected

## ◆ MaskOffIterator

template<typename T , Index Log2Dim>

using MaskOffIterator = typename NodeMaskType::OffIterator
| protected

## ◆ MaskOnIterator

template<typename T , Index Log2Dim>

using MaskOnIterator = typename NodeMaskType::OnIterator
| protected

## ◆ NodeMaskType

template<typename T , Index Log2Dim>

using NodeMaskType = util::NodeMask<Log2Dim>

## ◆ Ptr

template<typename T , Index Log2Dim>

using Ptr = SharedPtr<LeafNode>

## ◆ ValueAllCIter

template<typename T , Index Log2Dim>

using ValueAllCIter = ValueIter<MaskDenseIterator,const LeafNode,const ValueType,ValueAll>

## ◆ ValueAllIter

template<typename T , Index Log2Dim>

using ValueAllIter = ValueIter<MaskDenseIterator, LeafNode, const ValueType, ValueAll>

## ◆ ValueOffCIter

template<typename T , Index Log2Dim>

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

## ◆ ValueOffIter

template<typename T , Index Log2Dim>

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

## ◆ ValueOnCIter

template<typename T , Index Log2Dim>

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

## ◆ ValueOnIter

template<typename T , Index Log2Dim>

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

## ◆ ValueType

template<typename T , Index Log2Dim>

using ValueType = T

## Constructor & Destructor Documentation

## ◆ LeafNode() [1/8]

template<typename T , Index Log2Dim>

LeafNode | ( |  | ) |
| inline

Default constructor.

## ◆ LeafNode() [2/8]

template<typename T , Index Log2Dim>

LeafNode | ( | const Coord & | coords,
|  | const ValueType & | value = zeroVal<ValueType>(),
|  | bool | active = false )
| inline explicit

Constructor.

Parameters

  coords | the grid index coordinates of a voxel
  value | a value with which to fill the buffer
  active | the active state to which to initialize all voxels

## ◆ LeafNode() [3/8]

template<typename T , Index Log2Dim>

LeafNode | ( | PartialCreate | ,
|  | const Coord & | coords,
|  | const ValueType & | value = zeroVal<ValueType>(),
|  | bool | active = false )
| inline

"Partial creation" constructor used during file input

Parameters

  coords | the grid index coordinates of a voxel
  value | a value with which to fill the buffer
  active | the active state to which to initialize all voxels

This constructor does not allocate memory for voxel values.

## ◆ LeafNode() [4/8]

template<Index Log2Dim>

LeafNode | ( | const LeafNode< T, Log2Dim > & | other | ) |
| inline

Deep copy constructor.

## ◆ LeafNode() [5/8]

template<typename T , Index Log2Dim>
template<typename OtherValueType >

LeafNode | ( | const LeafNode< OtherValueType, Log2Dim > & | other | ) |
| inline explicit

Value conversion copy constructor.

## ◆ LeafNode() [6/8]

template<typename T , Index Log2Dim>
template<typename OtherValueType >

LeafNode | ( | const LeafNode< OtherValueType, Log2Dim > & | other,
|  | const ValueType & | offValue,
|  | const ValueType & | onValue,
|  | TopologyCopy | )
| inline

Topology copy constructor.

## ◆ LeafNode() [7/8]

template<typename T , Index Log2Dim>
template<typename OtherValueType >

LeafNode | ( | const LeafNode< OtherValueType, Log2Dim > & | other,
|  | const ValueType & | background,
|  | TopologyCopy | )
| inline

Topology copy constructor.

## ◆ ~LeafNode()

template<typename T , Index Log2Dim>

~LeafNode | ( |  | ) |
| inline

Destructor.

## ◆ LeafNode() [8/8]

template<typename T , Index Log2Dim>
template<typename ValueT >

LeafNode | ( | const LeafNode< ValueT, Log2Dim > & | other,
|  | bool | background,
|  | TopologyCopy | )
| inline

## Member Function Documentation

## ◆ addLeaf()

template<typename T , Index Log2Dim>

void addLeaf | ( | LeafNode< T, Log2Dim > * |  | ) |
| inline

## ◆ addLeafAndCache()

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

void addLeafAndCache | ( | LeafNode< T, Log2Dim > * | ,
|  | AccessorT & | )
| inline

## ◆ addTile() [1/2]

template<typename T , Index Log2Dim>

void addTile | ( | Index | level,
|  | const Coord & | xyz,
|  | const ValueType & | val,
|  | bool | active )
| inline

## ◆ addTile() [2/2]

template<typename T , Index Log2Dim>

void addTile | ( | Index | offset,
|  | const ValueType & | val,
|  | bool | active )
| inline

## ◆ addTileAndCache()

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

void addTileAndCache | ( | Index | level,
|  | const Coord & | xyz,
|  | const ValueType & | val,
|  | bool | active,
|  | AccessorT & | )
| inline

## ◆ allocate()

template<typename T , Index Log2Dim>

bool allocate | ( |  | ) |
| inline

Allocate memory for this node's buffer if it has not already been allocated.

## ◆ beginChildAll() [1/2]

template<typename T , Index Log2Dim>

ChildAllIter beginChildAll | ( |  | ) |
| inline

## ◆ beginChildAll() [2/2]

template<typename T , Index Log2Dim>

ChildAllCIter beginChildAll | ( |  | ) | const
| inline

## ◆ beginChildOff() [1/2]

template<typename T , Index Log2Dim>

ChildOffIter beginChildOff | ( |  | ) |
| inline

## ◆ beginChildOff() [2/2]

template<typename T , Index Log2Dim>

ChildOffCIter beginChildOff | ( |  | ) | const
| inline

## ◆ beginChildOn() [1/2]

template<typename T , Index Log2Dim>

ChildOnIter beginChildOn | ( |  | ) |
| inline

## ◆ beginChildOn() [2/2]

template<typename T , Index Log2Dim>

ChildOnCIter beginChildOn | ( |  | ) | const
| inline

## ◆ beginValueAll() [1/2]

template<typename T , Index Log2Dim>

ValueAllIter beginValueAll | ( |  | ) |
| inline

## ◆ beginValueAll() [2/2]

template<typename T , Index Log2Dim>

ValueAllCIter beginValueAll | ( |  | ) | const
| inline

## ◆ beginValueOff() [1/2]

template<typename T , Index Log2Dim>

ValueOffIter beginValueOff | ( |  | ) |
| inline

## ◆ beginValueOff() [2/2]

template<typename T , Index Log2Dim>

ValueOffCIter beginValueOff | ( |  | ) | const
| inline

## ◆ beginValueOn() [1/2]

template<typename T , Index Log2Dim>

ValueOnIter beginValueOn | ( |  | ) |
| inline

## ◆ beginValueOn() [2/2]

template<typename T , Index Log2Dim>

ValueOnCIter beginValueOn | ( |  | ) | const
| inline

## ◆ buffer() [1/2]

template<typename T , Index Log2Dim>

Buffer & buffer | ( |  | ) |
| inline

## ◆ buffer() [2/2]

template<typename T , Index Log2Dim>

const Buffer & buffer | ( |  | ) | const
| inline

## ◆ cbeginChildAll()

template<typename T , Index Log2Dim>

ChildAllCIter cbeginChildAll | ( |  | ) | const
| inline

## ◆ cbeginChildOff()

template<typename T , Index Log2Dim>

ChildOffCIter cbeginChildOff | ( |  | ) | const
| inline

## ◆ cbeginChildOn()

template<typename T , Index Log2Dim>

ChildOnCIter cbeginChildOn | ( |  | ) | const
| inline

## ◆ cbeginValueAll()

template<typename T , Index Log2Dim>

ValueAllCIter cbeginValueAll | ( |  | ) | const
| inline

## ◆ cbeginValueOff()

template<typename T , Index Log2Dim>

ValueOffCIter cbeginValueOff | ( |  | ) | const
| inline

## ◆ cbeginValueOn()

template<typename T , Index Log2Dim>

ValueOnCIter cbeginValueOn | ( |  | ) | const
| inline

## ◆ cendChildAll()

template<typename T , Index Log2Dim>

ChildAllCIter cendChildAll | ( |  | ) | const
| inline

## ◆ cendChildOff()

template<typename T , Index Log2Dim>

ChildOffCIter cendChildOff | ( |  | ) | const
| inline

## ◆ cendChildOn()

template<typename T , Index Log2Dim>

ChildOnCIter cendChildOn | ( |  | ) | const
| inline

## ◆ cendValueAll()

template<typename T , Index Log2Dim>

ValueAllCIter cendValueAll | ( |  | ) | const
| inline

## ◆ cendValueOff()

template<typename T , Index Log2Dim>

ValueOffCIter cendValueOff | ( |  | ) | const
| inline

## ◆ cendValueOn()

template<typename T , Index Log2Dim>

ValueOnCIter cendValueOn | ( |  | ) | const
| inline

## ◆ childCount()

template<typename T , Index Log2Dim>

static Index32 childCount | ( |  | ) |
| inline static

Return the child count for this node, which is zero.

## ◆ clip()

template<typename T , 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 T , Index Log2Dim>
template<typename CombineOp >

void combine | ( | const LeafNode< T, Log2Dim > & | other,
|  | CombineOp & | op )
| inline

## ◆ combine() [2/2]

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

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

## ◆ combine2() [1/3]

template<typename T , Index Log2Dim>
template<typename CombineOp , typename OtherNodeT >

void combine2 | ( | const LeafNode< T, Log2Dim > & | b0,
|  | const OtherNodeT & | b1,
|  | CombineOp & | op )
| inline

## ◆ combine2() [2/3]

template<typename T , Index Log2Dim>
template<typename CombineOp , typename OtherType >

void combine2 | ( | const LeafNode< T, Log2Dim > & | other,
|  | const OtherType & | value,
|  | bool | valueIsActive,
|  | CombineOp & | op )
| inline

## ◆ combine2() [3/3]

template<typename T , Index Log2Dim>
template<typename CombineOp , typename OtherNodeT >

void combine2 | ( | const ValueType & | value,
|  | const OtherNodeT & | other,
|  | bool | valueIsActive,
|  | CombineOp & | op )
| inline

## ◆ coordToOffset()

template<typename T , Index Log2Dim>

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

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

## ◆ copyFromDense()

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

void copyFromDense | ( | const CoordBBox & | bbox,
|  | const DenseT & | dense,
|  | const ValueType & | background,
|  | const ValueType & | tolerance )
| inline

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

Only values that are different (by more than the given tolerance) from the background value will be active. Other values are inactive and truncated to the background value.

Parameters

  bbox | inclusive bounding box of the voxels to be copied into this node
  dense | dense grid with a stride in z of one (see tools::Dense in tools/Dense.h for the required API)
  background | background value of the tree that this node belongs to
  tolerance | tolerance within which a value equals the background value

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.
  Consider using tools::CopyFromDense in tools/Dense.h instead of calling this method directly.

## ◆ copyToDense()

template<typename T , 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.
  Consider using tools::CopyToDense in tools/Dense.h instead of calling this method directly.

## ◆ denseFill()

template<typename T , Index Log2Dim>

void denseFill | ( | const CoordBBox & | bbox,
|  | const ValueType & | value,
|  | bool | active = true )
| inline

Set all voxels within an axis-aligned box to the specified value and active state.

## ◆ dim()

template<typename T , Index Log2Dim>

static Index dim | ( |  | ) |
| inline static

Return the number of voxels in each coordinate dimension.

## ◆ endChildAll() [1/2]

template<typename T , Index Log2Dim>

ChildAllIter endChildAll | ( |  | ) |
| inline

## ◆ endChildAll() [2/2]

template<typename T , Index Log2Dim>

ChildAllCIter endChildAll | ( |  | ) | const
| inline

## ◆ endChildOff() [1/2]

template<typename T , Index Log2Dim>

ChildOffIter endChildOff | ( |  | ) |
| inline

## ◆ endChildOff() [2/2]

template<typename T , Index Log2Dim>

ChildOffCIter endChildOff | ( |  | ) | const
| inline

## ◆ endChildOn() [1/2]

template<typename T , Index Log2Dim>

ChildOnIter endChildOn | ( |  | ) |
| inline

## ◆ endChildOn() [2/2]

template<typename T , Index Log2Dim>

ChildOnCIter endChildOn | ( |  | ) | const
| inline

## ◆ endValueAll() [1/2]

template<typename T , Index Log2Dim>

ValueAllIter endValueAll | ( |  | ) |
| inline

## ◆ endValueAll() [2/2]

template<typename T , Index Log2Dim>

ValueAllCIter endValueAll | ( |  | ) | const
| inline

## ◆ endValueOff() [1/2]

template<typename T , Index Log2Dim>

ValueOffIter endValueOff | ( |  | ) |
| inline

## ◆ endValueOff() [2/2]

template<typename T , Index Log2Dim>

ValueOffCIter endValueOff | ( |  | ) | const
| inline

## ◆ endValueOn() [1/2]

template<typename T , Index Log2Dim>

ValueOnIter endValueOn | ( |  | ) |
| inline

## ◆ endValueOn() [2/2]

template<typename T , Index Log2Dim>

ValueOnCIter endValueOn | ( |  | ) | const
| inline

## ◆ evalActiveBoundingBox()

template<typename T , Index Log2Dim>

void evalActiveBoundingBox | ( | CoordBBox & | bbox,
|  | bool | visitVoxels = true ) const
| inline

Expand the given bounding box so that it includes this leaf node's active voxels. If visitVoxels is false this LeafNode will be approximated as dense, i.e. with all voxels active. Else the individual active voxels are visited to produce a tight bbox.

## ◆ evalNodeOrigin()

template<typename T , Index Log2Dim>

static void evalNodeOrigin | ( | Coord & | xyz | ) |
| inline static protected

Compute the origin of the leaf node that contains the voxel with the given coordinates.

## ◆ fill() [1/3]

template<typename T , Index Log2Dim>

void fill | ( | const CoordBBox & | bbox,
|  | const ValueType & | value,
|  | bool | active = true )
| inline

Set all voxels within an axis-aligned box to the specified value and active state.

## ◆ fill() [2/3]

template<typename T , Index Log2Dim>

void fill | ( | const ValueType & | value | ) |
| inline

Set all voxels to the specified value but don't change their active states.

## ◆ fill() [3/3]

template<typename T , Index Log2Dim>

void fill | ( | const ValueType & | value,
|  | bool | active )
| inline

Set all voxels to the specified value and active state.

## ◆ getChildDim()

template<typename T , Index Log2Dim>

static Index getChildDim | ( |  | ) |
| inline static

Return the dimension of child nodes of this LeafNode, which is one for voxels.

## ◆ getFirstValue()

template<typename T , Index Log2Dim>

const ValueType & getFirstValue | ( |  | ) | const
| inline

Return a const reference to the first value in the buffer.

Note
  Though it is potentially risky you can convert this to a non-const pointer by means of const_case<ValueType*>&.

## ◆ getLastValue()

template<typename T , Index Log2Dim>

const ValueType & getLastValue | ( |  | ) | const
| inline

Return a const reference to the last value in the buffer.

## ◆ getLevel()

template<typename T , Index Log2Dim>

static Index getLevel | ( |  | ) |
| inline static

Return the level of this node, which by definition is zero for LeafNodes.

## ◆ getNodeBoundingBox()

template<typename T , Index Log2Dim>

CoordBBox getNodeBoundingBox | ( |  | ) | const
| inline

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

## ◆ getNodeLog2Dims()

template<typename T , Index Log2Dim>

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

Append the Log2Dim of this LeafNode to the specified vector.

## ◆ getNodes()

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

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

## ◆ getOrigin() [1/2]

template<typename T , Index Log2Dim>

void getOrigin | ( | Coord & | origin | ) | const
| inline

## ◆ getOrigin() [2/2]

template<typename T , Index Log2Dim>

void getOrigin | ( | Int32 & | x,
|  | Int32 & | y,
|  | Int32 & | z ) const
| inline

## ◆ getValue() [1/3]

template<typename ValueT , Index Log2Dim>

const ValueT & getValue | ( | const Coord & | xyz | ) | const
| inline

Return the value of the voxel at the given coordinates.

## ◆ getValue() [2/3]

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

const ValueType & getValue | ( | const Coord & | xyz,
|  | bool & | state,
|  | int & | level,
|  | AccessorT & | ) const
| inline

Return the value of the voxel at the given coordinates and return its active state and level (i.e., 0) in state and level.

Note
  Used internally by ValueAccessor.

## ◆ getValue() [3/3]

template<typename ValueT , Index Log2Dim>

const ValueT & getValue | ( | Index | offset | ) | const
| inline

Return the value of the voxel at the given linear offset.

## ◆ getValueAndCache()

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

const ValueType & getValueAndCache | ( | const Coord & | xyz,
|  | AccessorT & | ) const
| inline

Return the value of the voxel at the given coordinates.

Note
  Used internally by ValueAccessor.

## ◆ getValueLevel()

template<typename T , Index Log2Dim>

static Index getValueLevel | ( | const Coord & |  | ) |
| inline static

Return the level (i.e., 0) at which leaf node values reside.

## ◆ getValueLevelAndCache()

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

static Index getValueLevelAndCache | ( | const Coord & | ,
|  | AccessorT & | )
| inline static

Return the LEVEL (=0) at which leaf node values reside.

Note
  Used internally by ValueAccessor (note last argument is a dummy).

## ◆ getValueMask() [1/2]

template<typename T , Index Log2Dim>

NodeMaskType & getValueMask | ( |  | ) |
| inline

## ◆ getValueMask() [2/2]

template<typename T , Index Log2Dim>

const NodeMaskType & getValueMask | ( |  | ) | const
| inline

## ◆ hasActiveTiles()

template<typename T , Index Log2Dim>

static bool hasActiveTiles | ( |  | ) |
| inline static

Return `false` since leaf nodes never contain tiles.

## ◆ hasSameTopology()

template<typename T , Index Log2Dim>
template<typename OtherType , Index OtherLog2Dim>

bool hasSameTopology | ( | const LeafNode< OtherType, OtherLog2Dim > * | other | ) | const
| inline

Return `true` if the given node (which may have a different `ValueType` than this node) has the same active value topology as this node.

## ◆ isAllocated()

template<typename T , Index Log2Dim>

bool isAllocated | ( |  | ) | const
| inline

Return `true` if memory for this node's buffer has been allocated.

## ◆ isChildMaskOff() [1/2]

template<typename T , Index Log2Dim>

bool isChildMaskOff | ( |  | ) | const
| inline

## ◆ isChildMaskOff() [2/2]

template<typename T , Index Log2Dim>

bool isChildMaskOff | ( | Index |  | ) | const
| inline

## ◆ isChildMaskOn()

template<typename T , Index Log2Dim>

bool isChildMaskOn | ( | Index |  | ) | const
| inline

## ◆ isConstant() [1/2]

template<typename T , Index Log2Dim>

bool isConstant | ( | ValueType & | firstValue,
|  | bool & | state,
|  | const ValueType & | tolerance = zeroVal<ValueType>() ) const
| inline

Return `true` if all of this node's values have the same active state and are in the range this->getFirstValue() +/- tolerance.

Parameters

  firstValue | Is updated with the first value of this leaf node.
  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 equal to the for value.

## ◆ isConstant() [2/2]

template<typename T , 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 values have the same active state and the range (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.

## ◆ isDense()

template<typename T , Index Log2Dim>

bool isDense | ( |  | ) | const
| inline

Return `true` if this node contains only active voxels.

## ◆ isEmpty()

template<typename T , Index Log2Dim>

bool isEmpty | ( |  | ) | const
| inline

Return `true` if this node has no active voxels.

## ◆ isInactive()

template<typename T , Index Log2Dim>

bool isInactive | ( |  | ) | const
| inline

Return `true` if all of this node's values are inactive.

## ◆ isValueMaskOff() [1/2]

template<typename T , Index Log2Dim>

bool isValueMaskOff | ( |  | ) | const
| inline

## ◆ isValueMaskOff() [2/2]

template<typename T , Index Log2Dim>

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

## ◆ isValueMaskOn() [1/2]

template<typename T , Index Log2Dim>

bool isValueMaskOn | ( |  | ) | const
| inline

## ◆ isValueMaskOn() [2/2]

template<typename T , Index Log2Dim>

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

## ◆ isValueOn() [1/2]

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

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

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

## ◆ isValueOnAndCache()

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

bool isValueOnAndCache | ( | const Coord & | xyz,
|  | AccessorT & | ) const
| inline

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

Note
  Used internally by ValueAccessor.

## ◆ leafCount()

template<typename T , Index Log2Dim>

static Index32 leafCount | ( |  | ) |
| inline static

Return the leaf count for this node, which is one.

## ◆ log2dim()

template<typename T , Index Log2Dim>

static Index log2dim | ( |  | ) |
| inline static

Return log2 of the dimension of this LeafNode, e.g. 3 if dimensions are 8^3.

## ◆ medianAll()

template<typename T , Index Log2Dim>

T medianAll | ( | ValueType * | tmp = nullptr | ) | const
| inline

Computes the median value of all the active AND inactive voxels in this node.

Returns
  The median value of all values in this node.

Parameters

  tmp | Optional temporary storage that can hold at least NUM_VALUES values Use of this temporary storage can improve performance when this method is called multiple times.

Note
  If tmp = this->buffer().data() then the median value is computed very efficiently (in place) but the voxel values in this node are re-shuffled!

Warning
  If tmp != nullptr then it is the responsibility of the client code that it points to enough memory to hold NUM_VALUES elements of type ValueType.

## ◆ medianOff()

template<typename T , Index Log2Dim>

Index medianOff | ( | ValueType & | value,
|  | ValueType * | tmp = nullptr ) const
| inline

Computes the median value of all the inactive voxels in this node.

Returns
  The number of inactive voxels.

Parameters

  value | If the return value is non zero value is updated with the median value.
  tmp | Optional temporary storage that can hold at least as many values as there are inactive voxels in this node. Use of this temporary storage can improve performance when this method is called multiple times.

Warning
  If tmp != nullptr then it is the responsibility of the client code that it points to enough memory to hold the number of inactive voxels of type ValueType.

## ◆ medianOn()

template<typename T , Index Log2Dim>

Index medianOn | ( | ValueType & | value,
|  | ValueType * | tmp = nullptr ) const
| inline

Computes the median value of all the active voxels in this node.

Returns
  The number of active voxels.

Parameters

  value | If the return value is non zero value is updated with the median value.
  tmp | Optional temporary storage that can hold at least as many values as there are active voxels in this node. Use of this temporary storage can improve performance when this method is called multiple times.

Warning
  If tmp != nullptr then it is the responsibility of the client code that it points to enough memory to hold the number of active voxels of type ValueType.

## ◆ memUsage()

template<typename T , Index Log2Dim>

Index64 memUsage | ( |  | ) | const
| inline

Return the memory in bytes occupied by this node.

## ◆ memUsageIfLoaded()

template<typename T , Index Log2Dim>

Index64 memUsageIfLoaded | ( |  | ) | const
| inline

## ◆ merge() [1/3]

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

void merge | ( | const LeafNode< T, Log2Dim > & | other | ) |
| inline

## ◆ merge() [2/3]

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

void merge | ( | const LeafNode< T, Log2Dim > & | other,
|  | const ValueType & | ,
|  | const ValueType & | )
| inline

## ◆ merge() [3/3]

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

void merge | ( | const ValueType & | tileValue,
|  | bool | tileActive )
| inline

## ◆ modifyValue() [1/2]

template<typename T , 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.

## ◆ modifyValue() [2/2]

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

void modifyValue | ( | Index | offset,
|  | const ModifyOp & | op )
| inline

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

## ◆ modifyValueAndActiveState()

template<typename T , 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 T , Index Log2Dim>
template<typename ModifyOp , typename AccessorT >

void modifyValueAndActiveStateAndCache | ( | const Coord & | xyz,
|  | const ModifyOp & | op,
|  | AccessorT & | )
| inline

Apply a functor to the voxel at the given coordinates.

Note
  Used internally by ValueAccessor.

## ◆ modifyValueAndCache()

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

void modifyValueAndCache | ( | const Coord & | xyz,
|  | const ModifyOp & | op,
|  | AccessorT & | )
| inline

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

Note
  Used internally by ValueAccessor.

## ◆ negate()

template<typename T , Index Log2Dim>

void negate | ( |  | ) |
| inline

## ◆ nodeCount()

template<typename T , Index Log2Dim>

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

no-op

## ◆ nonLeafCount()

template<typename T , Index Log2Dim>

static Index32 nonLeafCount | ( |  | ) |
| inline static

Return the non-leaf count for this node, which is zero.

## ◆ numValues()

template<typename T , Index Log2Dim>

static Index numValues | ( |  | ) |
| inline static

Return the total number of voxels represented by this LeafNode.

## ◆ offLeafVoxelCount()

template<typename T , Index Log2Dim>

Index64 offLeafVoxelCount | ( |  | ) | const
| inline

## ◆ offsetToGlobalCoord()

template<typename T , Index Log2Dim>

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

Return the global coordinates for a linear table offset.

## ◆ offsetToLocalCoord()

template<typename T , Index Log2Dim>

Coord offsetToLocalCoord | ( | Index | n | ) |
| inline static

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

## ◆ offTileCount()

template<typename T , Index Log2Dim>

static Index64 offTileCount | ( |  | ) |
| inline static

## ◆ offVoxelCount()

template<typename T , Index Log2Dim>

Index64 offVoxelCount | ( |  | ) | const
| inline

Return the number of voxels marked Off.

## ◆ onLeafVoxelCount()

template<typename T , Index Log2Dim>

Index64 onLeafVoxelCount | ( |  | ) | const
| inline

## ◆ onTileCount()

template<typename T , Index Log2Dim>

static Index64 onTileCount | ( |  | ) |
| inline static

## ◆ onVoxelCount()

template<typename T , Index Log2Dim>

Index64 onVoxelCount | ( |  | ) | const
| inline

Return the number of voxels marked On.

## ◆ operator!=()

template<typename T , Index Log2Dim>

bool operator!= | ( | const LeafNode< T, Log2Dim > & | other | ) | const
| inline

## ◆ operator=()

template<typename T , Index Log2Dim>

LeafNode & operator= | ( | const LeafNode< T, Log2Dim > & |  | ) |
| default

Deep assignment operator.

## ◆ operator==()

template<typename T , Index Log2Dim>

bool operator== | ( | const LeafNode< T, Log2Dim > & | other | ) | const
| inline

Check for buffer, state and origin equivalence.

## ◆ origin()

template<typename T , Index Log2Dim>

const Coord & origin | ( |  | ) | const
| inline

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

## ◆ probeConstLeaf()

template<typename T , Index Log2Dim>

const LeafNode * probeConstLeaf | ( | const Coord & |  | ) | const
| inline

Return a `const` pointer to this node.

## ◆ probeConstLeafAndCache()

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

const LeafNode * probeConstLeafAndCache | ( | const Coord & | ,
|  | AccessorT & | ) const
| inline

## ◆ probeConstNode()

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

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

## ◆ probeConstNodeAndCache()

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

const NodeT * probeConstNodeAndCache | ( | const Coord & | ,
|  | AccessorT & | ) const
| inline

## ◆ probeLeaf() [1/2]

template<typename T , Index Log2Dim>

LeafNode * probeLeaf | ( | const Coord & |  | ) |
| inline

## ◆ probeLeaf() [2/2]

template<typename T , Index Log2Dim>

const LeafNode * probeLeaf | ( | const Coord & |  | ) | const
| inline

## ◆ probeLeafAndCache() [1/2]

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

LeafNode * probeLeafAndCache | ( | const Coord & | ,
|  | AccessorT & | )
| inline

## ◆ probeLeafAndCache() [2/2]

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

const LeafNode * probeLeafAndCache | ( | const Coord & | ,
|  | AccessorT & | ) const
| inline

## ◆ probeNode()

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

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

## ◆ probeNodeAndCache()

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

NodeT * probeNodeAndCache | ( | const Coord & | ,
|  | AccessorT & | )
| inline

## ◆ probeValue() [1/2]

template<typename T , Index Log2Dim>

bool probeValue | ( | const Coord & | xyz,
|  | ValueType & | val ) const
| inline

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

Parameters

  | xyz | the coordinates of the voxel to be probed
  [out] | val | the value of the voxel at the given coordinates

## ◆ probeValue() [2/2]

template<typename T , Index Log2Dim>

bool probeValue | ( | Index | offset,
|  | ValueType & | val ) const
| inline

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

Parameters

  | offset | the linear offset of the voxel to be probed
  [out] | val | the value of the voxel at the given coordinates

## ◆ probeValueAndCache()

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

bool probeValueAndCache | ( | const Coord & | xyz,
|  | ValueType & | val,
|  | AccessorT & | ) const
| inline

Return `true` if the voxel at the given coordinates is active and return the voxel value in val.

Note
  Used internally by ValueAccessor.

## ◆ prune()

template<typename T , Index Log2Dim>

void prune | ( | const ValueType & | = zeroVal<ValueType>() | ) |
| inline

This function exists only to enable template instantiation.

## ◆ readBuffers() [1/2]

template<typename T , Index Log2Dim>

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

Read buffers from a stream.

Parameters

  is | the stream from which to read
  fromHalf | if true, floating-point input values are assumed to be 16-bit

## ◆ readBuffers() [2/2]

template<typename T , Index Log2Dim>

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

Read buffers that intersect the given bounding box.

Parameters

  is | the stream from which to read
  bbox | an index-space bounding box
  fromHalf | if true, floating-point input values are assumed to be 16-bit

## ◆ readTopology()

template<typename T , Index Log2Dim>

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

Read in just the topology.

Parameters

  is | the stream from which to read
  fromHalf | if true, floating-point input values are assumed to be 16-bit

## ◆ resetBackground()

template<typename T , Index Log2Dim>

void resetBackground | ( | const ValueType & | oldBackground,
|  | const ValueType & | newBackground )
| inline

Replace inactive occurrences of oldBackground with newBackground, and inactive occurrences of -oldBackground with -newBackground.

## ◆ setActiveState() [1/2]

template<typename T , 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.

## ◆ setActiveState() [2/2]

template<typename T , Index Log2Dim>

void setActiveState | ( | Index | offset,
|  | bool | on )
| inline

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

## ◆ setActiveStateAndCache()

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

void setActiveStateAndCache | ( | const Coord & | xyz,
|  | bool | on,
|  | AccessorT & | )
| inline

Set the active state of the voxel at the given coordinates without changing its value.

Note
  Used internally by ValueAccessor.

## ◆ setOrigin()

template<typename T , Index Log2Dim>

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

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

## ◆ setTransientData()

template<typename T , Index Log2Dim>

void setTransientData | ( | Index32 | transientData | ) |
| inline

Set the transient data value.

## ◆ setValue()

template<typename T , Index Log2Dim>

void setValue | ( | const Coord & | xyz,
|  | const ValueType & | val )
| inline

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

## ◆ setValueAndCache()

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

void setValueAndCache | ( | const Coord & | xyz,
|  | const ValueType & | val,
|  | AccessorT & | )
| inline

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

Note
  Used internally by ValueAccessor.

## ◆ setValueMask() [1/2]

template<typename T , Index Log2Dim>

void setValueMask | ( | const NodeMaskType & | mask | ) |
| inline

## ◆ setValueMask() [2/2]

template<typename T , Index Log2Dim>

void setValueMask | ( | Index | n,
|  | bool | on )
| inline protected

## ◆ setValueMaskOff()

template<typename T , Index Log2Dim>

void setValueMaskOff | ( | Index | n | ) |
| inline protected

## ◆ setValueMaskOn()

template<typename T , Index Log2Dim>

void setValueMaskOn | ( | Index | n | ) |
| inline protected

## ◆ setValueOff() [1/4]

template<typename T , 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/4]

template<typename T , Index Log2Dim>

void setValueOff | ( | const Coord & | xyz,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOff() [3/4]

template<typename T , Index Log2Dim>

void setValueOff | ( | Index | offset | ) |
| inline

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

## ◆ setValueOff() [4/4]

template<typename T , Index Log2Dim>

void setValueOff | ( | Index | offset,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOffAndCache()

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

void setValueOffAndCache | ( | const Coord & | xyz,
|  | const ValueType & | value,
|  | AccessorT & | )
| inline

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

Note
  Used internally by ValueAccessor.

## ◆ setValueOn() [1/4]

template<typename T , 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/4]

template<typename T , Index Log2Dim>

void setValueOn | ( | const Coord & | xyz,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOn() [3/4]

template<typename T , Index Log2Dim>

void setValueOn | ( | Index | offset | ) |
| inline

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

## ◆ setValueOn() [4/4]

template<typename T , Index Log2Dim>

void setValueOn | ( | Index | offset,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOnly() [1/2]

template<typename T , Index Log2Dim>

void setValueOnly | ( | const Coord & | xyz,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOnly() [2/2]

template<typename T , Index Log2Dim>

void setValueOnly | ( | Index | offset,
|  | const ValueType & | val )
| inline

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

## ◆ setValueOnlyAndCache()

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

void setValueOnlyAndCache | ( | const Coord & | xyz,
|  | const ValueType & | val,
|  | AccessorT & | )
| inline

Change the value of the voxel at the given coordinates but preserve its state.

Note
  Used internally by ValueAccessor.

## ◆ setValuesOff()

template<typename T , Index Log2Dim>

void setValuesOff | ( |  | ) |
| inline

Mark all voxels as inactive but don't change their values.

## ◆ setValuesOn()

template<typename T , Index Log2Dim>

void setValuesOn | ( |  | ) |
| inline

Mark all voxels as active but don't change their values.

## ◆ size()

template<typename T , Index Log2Dim>

static Index size | ( |  | ) |
| inline static

Return the total number of voxels represented by this LeafNode.

## ◆ skipCompressedValues()

template<typename T , Index Log2Dim>

void skipCompressedValues | ( | bool | seekable,
|  | std::istream & | is,
|  | bool | fromHalf )
| inline protected

## ◆ stealNode()

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

NodeT * stealNode | ( | const Coord & | ,
|  | const ValueType & | ,
|  | bool | )
| inline

## ◆ stealNodes()

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

void stealNodes | ( | ArrayT & | ,
|  | const ValueType & | ,
|  | bool | )
| inline

## ◆ str()

template<typename T , Index Log2Dim>

std::string str | ( |  | ) | const
| inline

Return a string representation of this node.

## ◆ streamingSize()

template<typename T , Index Log2Dim>

size_t streamingSize | ( | bool | toHalf = false | ) | const

## ◆ swap()

template<typename T , Index Log2Dim>

void swap | ( | Buffer & | other | ) |
| inline

Exchange this node's data buffer with the given data buffer without changing the active states of the values.

## ◆ topologyDifference()

template<typename T , Index Log2Dim>
template<typename OtherType >

void topologyDifference | ( | const LeafNode< OtherType, Log2Dim > & | other,
|  | const ValueType & | )
| inline

Difference this node's set of active values with the active values of the other node, whose `ValueType` may be different. So a resulting voxel will be active only if the original voxel is active in this LeafNode and inactive in the other LeafNode.

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

Note
  This operation modifies only active states, not values. Also, because it can deactivate all of this node's voxels, consider subsequently calling prune.

## ◆ topologyIntersection()

template<typename T , Index Log2Dim>
template<typename OtherType >

void topologyIntersection | ( | const LeafNode< OtherType, Log2Dim > & | other,
|  | const ValueType & | )
| inline

Intersect this node's set of active values with the active values of the other node, whose `ValueType` may be different. So a resulting voxel will be active only if both of the original voxels were active.

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

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.

## ◆ topologyUnion()

template<typename T , Index Log2Dim>
template<typename OtherType >

void topologyUnion | ( | const LeafNode< OtherType, Log2Dim > & | other,
|  | const bool | preserveTiles = false )
| inline

Union 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 if either of the original voxels were active.

Note
  This operation modifies only active states, not values.

## ◆ touchLeaf()

template<typename T , Index Log2Dim>

LeafNode * touchLeaf | ( | const Coord & |  | ) |
| inline

Return a pointer to this node.

## ◆ touchLeafAndCache()

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

LeafNode * touchLeafAndCache | ( | const Coord & | ,
|  | AccessorT & | )
| inline

## ◆ transientData()

template<typename T , Index Log2Dim>

Index32 transientData | ( |  | ) | const
| inline

Return the transient data value.

## ◆ valueMask()

template<typename T , Index Log2Dim>

const NodeMaskType & valueMask | ( |  | ) | const
| inline

## ◆ voxelizeActiveTiles()

template<typename T , Index Log2Dim>

void voxelizeActiveTiles | ( | bool | = true | ) |
| inline

No-op.

This function exists only to enable template instantiation.

## ◆ writeBuffers()

template<typename T , Index Log2Dim>

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

Write buffers to a stream.

Parameters

  os | the stream to which to write
  toHalf | if true, output floating-point values as 16-bit half floats

## ◆ writeTopology()

template<typename T , Index Log2Dim>

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

Write out just the topology.

Parameters

  os | the stream to which to write
  toHalf | if true, output floating-point values as 16-bit half floats

## Friends And Related Symbol Documentation

## ◆ ::TestLeaf

template<typename T , Index Log2Dim>

friend class ::TestLeaf
| friend

## ◆ ::TestLeafIO

template<typename T , Index Log2Dim>
template<typename >

friend class ::TestLeafIO
| friend

## ◆ IteratorBase< MaskDenseIterator, LeafNode >

template<typename T , Index Log2Dim>

friend class IteratorBase< MaskDenseIterator, LeafNode >
| friend

## ◆ IteratorBase< MaskOffIterator, LeafNode >

template<typename T , Index Log2Dim>

friend class IteratorBase< MaskOffIterator, LeafNode >
| friend

## ◆ IteratorBase< MaskOnIterator, LeafNode >

template<typename T , Index Log2Dim>

friend class IteratorBase< MaskOnIterator, LeafNode >
| friend

## ◆ LeafNode

template<typename T , Index Log2Dim>
template<typename , Index >

friend class LeafNode
| friend

## ◆ ValueIter< MaskDenseIterator, const LeafNode, ValueType, ValueAll >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskDenseIterator, const LeafNode, ValueType, ValueAll >
| friend

## ◆ ValueIter< MaskDenseIterator, LeafNode, ValueType, ValueAll >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskDenseIterator, LeafNode, ValueType, ValueAll >
| friend

## ◆ ValueIter< MaskOffIterator, const LeafNode, ValueType, ValueOff >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskOffIterator, const LeafNode, ValueType, ValueOff >
| friend

## ◆ ValueIter< MaskOffIterator, LeafNode, ValueType, ValueOff >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskOffIterator, LeafNode, ValueType, ValueOff >
| friend

## ◆ ValueIter< MaskOnIterator, const LeafNode, ValueType, ValueOn >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskOnIterator, const LeafNode, ValueType, ValueOn >
| friend

## ◆ ValueIter< MaskOnIterator, LeafNode, ValueType, ValueOn >

template<typename T , Index Log2Dim>

friend struct ValueIter< MaskOnIterator, LeafNode, ValueType, ValueOn >
| friend

## Member Data Documentation

## ◆ DIM

template<typename T , Index Log2Dim>

const Index DIM = 1 << TOTAL
| static

## ◆ LEVEL

template<typename T , Index Log2Dim>

const Index LEVEL = 0
| static

## ◆ LOG2DIM

template<typename T , Index Log2Dim>

const Index LOG2DIM = Log2Dim
| static

## ◆ NUM_VALUES

template<typename T , Index Log2Dim>

const Index NUM_VALUES = 1 << 3 * Log2Dim
| static

## ◆ NUM_VOXELS

template<typename T , Index Log2Dim>

const Index NUM_VOXELS = NUM_VALUES
| static

## ◆ SIZE

template<typename T , Index Log2Dim>

const Index SIZE = NUM_VALUES
| static

## ◆ TOTAL

template<typename T , Index Log2Dim>

const Index TOTAL = Log2Dim
| static