#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. More...

	InternalNode (const ValueType &offValue)
	Constructor of an InternalNode with dense inactive tiles of the specified value. More...

	InternalNode (const Coord &origin, const ValueType &fillValue, bool active=false)
	Constructs an InternalNode with dense tiles. More...

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

	InternalNode (const InternalNode &)
	Deep copy constructor. More...

template<typename OtherChildNodeType >
	InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other)
	Value conversion copy constructor. More...

template<typename OtherChildNodeType >
	InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background, TopologyCopy)
	Topology copy constructor. More...

template<typename OtherChildNodeType >
	InternalNode (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &offValue, const ValueType &onValue, TopologyCopy)
	Topology copy constructor. More...

	~InternalNode ()

ChildOnCIter	cbeginChildOn () const

ChildOffCIter	cbeginChildOff () const

ChildAllCIter	cbeginChildAll () const

ChildOnCIter	beginChildOn () const

ChildOffCIter	beginChildOff () const

ChildAllCIter	beginChildAll () const

ChildOnIter	beginChildOn ()

ChildOffIter	beginChildOff ()

ChildAllIter	beginChildAll ()

ValueOnCIter	cbeginValueOn () const

ValueOffCIter	cbeginValueOff () const

ValueAllCIter	cbeginValueAll () const

ValueOnCIter	beginValueOn () const

ValueOffCIter	beginValueOff () const

ValueAllCIter	beginValueAll () const

ValueOnIter	beginValueOn ()

ValueOffIter	beginValueOff ()

ValueAllIter	beginValueAll ()

Coord	offsetToGlobalCoord (Index n) const
	Return the global coordinates for a linear table offset. More...

const Coord &	origin () const
	Return the grid index coordinates of this node's local origin. More...

void	setOrigin (const Coord &origin)
	Set the grid index coordinates of this node's local origin. More...

Index32	transientData () const
	Return the transient data value. More...

void	setTransientData (Index32 transientData)
	Set the transient data value. More...

Index64	leafCount () const

Index64	nonLeafCount () const

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

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

Index32	childCount () const

Index64	onVoxelCount () const

Index64	offVoxelCount () const

Index64	onLeafVoxelCount () const

Index64	offLeafVoxelCount () const

Index64	onTileCount () const

Index64	memUsage () const
	Return the total amount of memory in bytes occupied by this node and its children. More...

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

CoordBBox	getNodeBoundingBox () const
	Return the bounding box of this node, i.e., the full index space spanned by the node regardless of its content. More...

bool	isEmpty () const

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

bool	isConstant (ValueType &minValue, ValueType &maxValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const

bool	isInactive () const
	Return `true` if this node has no children and only contains inactive values. More...

bool	isValueOn (const Coord &xyz) const
	Return `true` if the voxel at the given coordinates is active. More...

bool	isValueOn (Index offset) const
	Return `true` if the voxel at the given offset is active. More...

bool	isValueOff (const Coord &xyz) const
	Return `true` if the voxel at the given coordinates is inactive. More...

bool	isValueOff (Index offset) const
	Return `true` if the voxel at the given offset is inactive. More...

bool	hasActiveTiles () const
	Return `true` if this node or any of its child nodes have any active tiles. More...

const ValueType &	getValue (const Coord &xyz) const

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

Index	getValueLevel (const Coord &xyz) const
	Return the level of the tree (0 = leaf) at which the value at the given coordinates resides. More...

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

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

void	setActiveState (const Coord &xyz, bool on)
	Set the active state of the voxel at the given coordinates but don't change its value. More...

void	setValueOnly (const Coord &xyz, const ValueType &value)
	Set the value of the voxel at the given coordinates but don't change its active state. More...

void	setValueOn (const Coord &xyz)
	Mark the voxel at the given coordinates as active but don't change its value. More...

void	setValueOn (const Coord &xyz, const ValueType &value)
	Set the value of the voxel at the given coordinates and mark the voxel as active. More...

void	setValueOff (const Coord &xyz)
	Mark the voxel at the given coordinates as inactive but don't change its value. More...

void	setValueOff (const Coord &xyz, const ValueType &value)
	Set the value of the voxel at the given coordinates and mark the voxel as inactive. More...

template<typename ModifyOp >
void	modifyValue (const Coord &xyz, const ModifyOp &op)
	Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active. More...

template<typename ModifyOp >
void	modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
	Apply a functor to the voxel at the given coordinates. More...

template<typename AccessorT >
const ValueType &	getValueAndCache (const Coord &xyz, AccessorT &) const

template<typename AccessorT >
bool	isValueOnAndCache (const Coord &xyz, AccessorT &) const

template<typename AccessorT >
void	setValueAndCache (const Coord &xyz, const ValueType &value, AccessorT &)

template<typename AccessorT >
void	setValueOnlyAndCache (const Coord &xyz, const ValueType &value, AccessorT &)

template<typename ModifyOp , typename AccessorT >
void	modifyValueAndCache (const Coord &xyz, const ModifyOp &op, AccessorT &)
	Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active. If necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the voxel. More...

template<typename ModifyOp , typename AccessorT >
void	modifyValueAndActiveStateAndCache (const Coord &xyz, const ModifyOp &op, AccessorT &)

template<typename AccessorT >
void	setValueOffAndCache (const Coord &xyz, const ValueType &value, AccessorT &)

template<typename AccessorT >
void	setActiveStateAndCache (const Coord &xyz, bool on, AccessorT &)

template<typename AccessorT >
bool	probeValueAndCache (const Coord &xyz, ValueType &value, AccessorT &) const

template<typename AccessorT >
Index	getValueLevelAndCache (const Coord &xyz, AccessorT &) const
	Return the level of the tree (0 = leaf) at which the value at the given coordinates resides. More...

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

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

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

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

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

void	readBuffers (std::istream &, const CoordBBox &, bool fromHalf=false)

const ValueType &	getValueUnsafe (Index offset) const
	Return the tile value at offset. More...

bool	getValueUnsafe (Index offset, ValueType &value) const
	Return the tile value and active state at offset. More...

ChildNodeType *	getChildUnsafe (Index offset)
	Return the child node at offset. More...

const ChildNodeType *	getConstChildUnsafe (Index offset) const
	Return the child node at offset. More...

const ChildNodeType *	getChildUnsafe (Index offset) const
	Return the child node at offset. More...

void	setActiveStateUnsafe (Index offset, bool on)
	Set the tile active state at offset but don't change its value. More...

void	setValueOnlyUnsafe (Index offset, const ValueType &value)
	Set the tile value at offset but don't change its value. More...

void	setValueOnUnsafe (Index offset)
	Mark the tile active at offset but don't change its value. More...

void	setValueOnUnsafe (Index offset, const ValueType &value)
	Set the tile value at offset and mark the voxel as active. More...

void	setValueOffUnsafe (Index offset)
	Mark the tile inactive at offset but don't change its value. More...

void	setValueOffUnsafe (Index offset, const ValueType &value)
	Set the tile value at offset and mark the voxel as inactive. More...

void	setChildUnsafe (Index offset, ChildNodeType *child)
	Replace a tile at offset with the given child node. More...

void	resetChildUnsafe (Index offset, ChildNodeType *child)
	Replace a child node at offset with the given child node. More...

ChildNodeType *	stealChildUnsafe (Index offset, const ValueType &value, bool active)
	Replace a child node at offset with the given value and active state. More...

void	deleteChildUnsafe (Index offset, const ValueType &value, bool active)
	Delete a child node at offset and replace with the given value and active state. More...

void	negate ()
	Change the sign of all the values represented in this node and its child nodes. More...

void	fill (const CoordBBox &bbox, const ValueType &value, bool active=true)
	Set all voxels within a given axis-aligned box to a constant value. More...

void	denseFill (const CoordBBox &bbox, const ValueType &value, bool active=true)
	Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are all represented at the leaf level. More...

void	voxelizeActiveTiles (bool threaded=true)
	Densify active tiles, i.e., replace them with leaf-level active voxels. More...

template<typename DenseT >
void	copyToDense (const CoordBBox &bbox, DenseT &dense) const
	Copy into a dense grid the values of the voxels that lie within a given bounding box. More...

template<MergePolicy Policy>
void	merge (InternalNode &other, const ValueType &background, const ValueType &otherBackground)
	Efficiently merge another tree into this tree using one of several schemes. More...

template<MergePolicy Policy>
void	merge (const ValueType &tileValue, bool tileActive)
	Merge, using one of several schemes, this node (and its descendants) with a tile of the same dimensions and the given value and active state. More...

template<typename OtherChildNodeType >
void	topologyUnion (const InternalNode< OtherChildNodeType, Log2Dim > &other, const bool preserveTiles=false)
	Union this branch's set of active values with the other branch's active values. The value type of the other branch can be different. More...

template<typename OtherChildNodeType >
void	topologyIntersection (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background)
	Intersects this tree's set of active values with the active values of the other tree, whose `ValueType` may be different. More...

template<typename OtherChildNodeType >
void	topologyDifference (const InternalNode< OtherChildNodeType, Log2Dim > &other, const ValueType &background)
	Difference this node's set of active values with the active values of the other node, whose `ValueType` may be different. So a resulting voxel will be active only if the original voxel is active in this node and inactive in the other node. More...

template<typename CombineOp >
void	combine (InternalNode &other, CombineOp &)

template<typename CombineOp >
void	combine (const ValueType &value, bool valueIsActive, CombineOp &)

template<typename CombineOp , typename OtherNodeType >
void	combine2 (const InternalNode &other0, const OtherNodeType &other1, CombineOp &)

template<typename CombineOp , typename OtherNodeType >
void	combine2 (const ValueType &value, const OtherNodeType &other, bool valIsActive, CombineOp &)

template<typename CombineOp , typename OtherValueType >
void	combine2 (const InternalNode &other, const OtherValueType &, bool valIsActive, CombineOp &)

void	clip (const CoordBBox &, const ValueType &background)
	Set all voxels that lie outside the given axis-aligned box to the background. More...

void	prune (const ValueType &tolerance=zeroVal< ValueType >())
	Reduce the memory footprint of this tree by replacing with tiles any nodes whose values are all the same (optionally to within a tolerance) and have the same active state. More...

void	addLeaf (LeafNodeType *leaf)
	Add the specified leaf to this node, possibly creating a child branch in the process. If the leaf node already exists, replace it. More...

template<typename AccessorT >
void	addLeafAndCache (LeafNodeType *leaf, AccessorT &)
	Same as addLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate. More...

template<typename NodeT >
NodeT *	stealNode (const Coord &xyz, const ValueType &value, bool state)
	Return a pointer to the node of type `NodeT` that contains voxel (x, y, z) and replace it with a tile of the specified value and state. If no such node exists, leave the tree unchanged and return `nullptr`. More...

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

void	addTile (Index level, const Coord &xyz, const ValueType &value, bool state)
	Add a tile at the specified tree level that contains voxel (x, y, z), possibly creating a parent branch or deleting a child branch in the process. More...

void	addTile (Index offset, const ValueType &value, bool state)
	Delete any existing child branch at the specified offset and add a tile. More...

template<typename AccessorT >
void	addTileAndCache (Index level, const Coord &xyz, const ValueType &, bool state, AccessorT &)
	Same as addTile() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...

LeafNodeType *	touchLeaf (const Coord &xyz)
	Return the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels. More...

template<typename AccessorT >
LeafNodeType *	touchLeafAndCache (const Coord &xyz, AccessorT &)
	Same as touchLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing the coordinate. More...

template<typename ArrayT >
void	stealNodes (ArrayT &array, const ValueType &value, bool state)
	Steals all nodes of a certain type from the tree and adds them to a container with the following API: More...

void	resetBackground (const ValueType &oldBackground, const ValueType &newBackground)
	Change inactive tiles or voxels with value oldBackground to newBackground or -oldBackground to -newBackground. Active values are unchanged. More...

template<typename OtherChildNodeType , Index OtherLog2Dim>
bool	hasSameTopology (const InternalNode< OtherChildNodeType, OtherLog2Dim > *other) const
	Return `true` if the given tree branch has the same node and active value topology as this tree branch (but possibly a different `ValueType`). More...

bool	isValueMaskOn (Index n) const

bool	isValueMaskOn () const

bool	isValueMaskOff (Index n) const

bool	isValueMaskOff () const

bool	isChildMaskOn (Index n) const

bool	isChildMaskOff (Index n) const

bool	isChildMaskOff () const

const NodeMaskType &	getValueMask () const

const NodeMaskType &	getChildMask () const

NodeMaskType	getValueOffMask () const

const UnionType *	getTable () const

template<typename NodeT >
NodeT *	probeNode (const Coord &xyz)

template<typename NodeT , typename AccessorT >
NodeT *	probeNodeAndCache (const Coord &xyz, AccessorT &acc)

template<typename NodeT >
const NodeT *	probeConstNode (const Coord &xyz) const

template<typename NodeT , typename AccessorT >
const NodeT *	probeConstNodeAndCache (const Coord &xyz, AccessorT &acc) const

template<typename AccessorT >
ChildT::LeafNodeType *	probeLeafAndCache (const Coord &xyz, AccessorT &acc)

template<typename AccessorT >
const ChildT::LeafNodeType *	probeLeafAndCache (const Coord &xyz, AccessorT &acc) const

template<typename AccessorT >
const ChildT::LeafNodeType *	probeConstLeafAndCache (const Coord &xyz, AccessorT &acc) const

template<typename 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)


template<typename NodeType >
NodeType *	probeNode (const Coord &xyz)
	Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

template<typename NodeType >
const NodeType *	probeConstNode (const Coord &xyz) const
	Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

template<typename NodeType >
const NodeType *	probeNode (const Coord &xyz) const
	Return a pointer to the node that contains voxel (x, y, z). If no such node exists, return nullptr. More...


ChildNodeType *	probeChild (const Coord &xyz)
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

const ChildNodeType *	probeConstChild (const Coord &xyz) const
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

const ChildNodeType *	probeChild (const Coord &xyz) const
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...


ChildNodeType *	probeChild (const Coord &xyz, ValueType &value, bool &active)
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

const ChildNodeType *	probeConstChild (const Coord &xyz, ValueType &value, bool &active) const
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...

const ChildNodeType *	probeChild (const Coord &xyz, ValueType &value, bool &active) const
	Return a pointer to the child node that contains voxel (x, y, z). If no such node exists, return nullptr. More...


ChildNodeType *	probeChildUnsafe (Index offset)
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...

const ChildNodeType *	probeConstChildUnsafe (Index offset) const
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...

const ChildNodeType *	probeChildUnsafe (Index offset) const
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...


ChildNodeType *	probeChildUnsafe (Index offset, ValueType &value, bool &active)
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...

const ChildNodeType *	probeConstChildUnsafe (Index offset, ValueType &value, bool &active) const
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...

const ChildNodeType *	probeChildUnsafe (Index offset, ValueType &value, bool &active) const
	Return a pointer to the child node for a specific offset. If no such node exists, return nullptr. More...


template<typename NodeType , typename AccessorT >
NodeType *	probeNodeAndCache (const Coord &xyz, AccessorT &)
	Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...

template<typename NodeType , typename AccessorT >
const NodeType *	probeConstNodeAndCache (const Coord &xyz, AccessorT &) const
	Same as probeNode() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...


LeafNodeType *	probeLeaf (const Coord &xyz)
	Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return `nullptr`. More...

const LeafNodeType *	probeConstLeaf (const Coord &xyz) const
	Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return `nullptr`. More...

const LeafNodeType *	probeLeaf (const Coord &xyz) const
	Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, return `nullptr`. More...


template<typename AccessorT >
LeafNodeType *	probeLeafAndCache (const Coord &xyz, AccessorT &acc)
	Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...

template<typename AccessorT >
const LeafNodeType *	probeConstLeafAndCache (const Coord &xyz, AccessorT &acc) const
	Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...

template<typename AccessorT >
const LeafNodeType *	probeLeafAndCache (const Coord &xyz, AccessorT &acc) const
	Same as probeLeaf() except, if necessary, update the accessor with pointers to the nodes along the path from the root node to the node containing (x, y, z). More...


template<typename ArrayT >
void	getNodes (ArrayT &array)
	Adds all nodes of a certain type to a container with the following API: More...

template<typename ArrayT >
void	getNodes (ArrayT &array) const
	Adds all nodes of a certain type to a container with the following API: More...

Static Public Member Functions
static Index	dim ()

static Index	getLevel ()

static void	getNodeLog2Dims (std::vector< Index > &dims)
	Populated an std::vector with the dimension of all the nodes in the branch starting with this node. More...

static Index	getChildDim ()

static Index	coordToOffset (const Coord &xyz)
	Return the linear table offset of the given global or local coordinates. More...

static void	offsetToLocalCoord (Index n, Coord &xyz)
	Return the local coordinates for a linear table offset, where offset 0 has coordinates (0, 0, 0). More...

Static Public Attributes
static const Index	LOG2DIM = Log2Dim

static const Index	TOTAL = Log2Dim + ChildNodeType::TOTAL

static const Index	DIM = 1 << TOTAL

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

static const Index	LEVEL = 1 + ChildNodeType::LEVEL

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

Protected Types
using	MaskOnIterator = typename NodeMaskType::OnIterator

using	MaskOffIterator = typename NodeMaskType::OffIterator

using	MaskDenseIterator = typename NodeMaskType::DenseIterator

Protected Member Functions
void	makeChildNodeEmpty (Index n, const ValueType &value)

void	setChildNode (Index i, ChildNodeType *child)

void	resetChildNode (Index i, ChildNodeType *child)

ChildNodeType *	unsetChildNode (Index i, const ValueType &value)


void	setValueMask (Index n, bool on)


ChildNodeType *	getChildNode (Index n)
	Returns a pointer to the child node at the linear offset n. More...

const ChildNodeType *	getChildNode (Index n) const
	Returns a pointer to the child node at the linear offset n. More...

Protected Attributes
UnionType	mNodes [NUM_VALUES]

NodeMaskType	mChildMask

NodeMaskType	mValueMask

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

Index32	mTransientData = 0
	Transient data (not serialized) More...

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


class	IteratorBase< MaskOnIterator, InternalNode >

class	IteratorBase< MaskOffIterator, InternalNode >

class	IteratorBase< MaskDenseIterator, InternalNode >

Member Typedef Documentation

using BuildType = typename ChildNodeType::BuildType

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

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

using ChildNodeType = _ChildNodeType

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

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

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

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

using LeafNodeType = typename ChildNodeType::LeafNodeType

using MaskDenseIterator = typename NodeMaskType::DenseIterator

protected

using MaskOffIterator = typename NodeMaskType::OffIterator

protected

using MaskOnIterator = typename NodeMaskType::OnIterator

protected

using NodeMaskType = util::NodeMask<Log2Dim>

using UnionType = NodeUnion<ValueType, ChildNodeType>

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

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

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

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

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

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

using ValueType = typename ChildNodeType::ValueType

Constructor & Destructor Documentation

InternalNode ( )

inline

Default constructor.

Warning: The resulting InternalNode is uninitialized

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	(	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	(	PartialCreate	,
		const Coord &	origin,
		const ValueType &	fillValue,
		bool	active = `false`
	)

inline

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

inline

Deep copy constructor.

Note: This method is multi-threaded!

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

inlineexplicit

Value conversion copy constructor.

Note: This method is multi-threaded!

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

inline

Topology copy constructor.

Note: This method is multi-threaded!

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

inline

Topology copy constructor.

Note: This method is multi-threaded!

~InternalNode ( )

inline

Member Function Documentation

bool addChild ( ChildNodeType * child )

inline

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.

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.

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.

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.

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

inline

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

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

ChildAllCIter beginChildAll ( ) const

inline

ChildAllIter beginChildAll ( )

inline

ChildOffCIter beginChildOff ( ) const

inline

ChildOffIter beginChildOff ( )

inline

ChildOnCIter beginChildOn ( ) const

inline

ChildOnIter beginChildOn ( )

inline

ValueAllCIter beginValueAll ( ) const

inline

ValueAllIter beginValueAll ( )

inline

ValueOffCIter beginValueOff ( ) const

inline

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

ValueOffIter beginValueOff ( )

inline

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

ValueOnCIter beginValueOn ( ) const

inline

ValueOnIter beginValueOn ( )

inline

ChildAllCIter cbeginChildAll ( ) const

inline

ChildOffCIter cbeginChildOff ( ) const

inline

ChildOnCIter cbeginChildOn ( ) const

inline

ValueAllCIter cbeginValueAll ( ) const

inline

ValueOffCIter cbeginValueOff ( ) const

inline

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

ValueOnCIter cbeginValueOn ( ) const

inline

Index32 childCount ( ) const

inline

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

inline

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

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

inline

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

inline

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

inline

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

inline

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

inline

Index coordToOffset ( const Coord & xyz )

inlinestatic

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

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.

void deleteChildUnsafe	(	Index	offset,
		const ValueType &	value,
		bool	active
	)

inline

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

Note: Use addTile(Index, const ValueType&, bool) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

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()

static Index dim ( )

inlinestatic

Returns: The dimension of this InternalNode

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

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.

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.

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.

const NodeMaskType& getChildMask ( ) const

inline

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!

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!

ChildT * getChildUnsafe ( Index offset )

inline

Return the child node at offset.

Note: Use probeChild(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

const ChildT * getChildUnsafe ( Index offset ) const

inline

Return the child node at offset.

Note: Use probeChild(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

const ChildT * getConstChildUnsafe ( Index offset ) const

inline

Return the child node at offset.

Note: Use probeConstChild(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

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.

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.

static Index getLevel ( )

inlinestatic

Returns: The level of this node

Level 0 is by definition the level of the leaf nodes

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.

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.

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

void getNodes ( ArrayT & array ) const

inline

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

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

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

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

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

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

const UnionType* getTable ( ) const

inline

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

inline

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.

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

inline

Index getValueLevel ( const Coord & xyz ) const

inline

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

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.

const NodeMaskType& getValueMask ( ) const

inline

NodeMaskType getValueOffMask ( ) const

inline

const ChildT::ValueType & getValueUnsafe ( Index offset ) const

inline

Return the tile value at offset.

Note: Use getValue(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

bool getValueUnsafe	(	Index	offset,
		ValueType &	value
	)		const

inline

Return the tile value and active state at offset.

Note: Use probeValue(const Coord&, ValueType&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

bool hasActiveTiles ( ) const

inline

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

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

bool isChildMaskOff ( Index n ) const

inline

bool isChildMaskOff ( ) const

inline

bool isChildMaskOn ( Index n ) const

inline

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.

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.

bool isEmpty ( ) const

inline

Returns: True if this node contains no child nodes.

bool isInactive ( ) const

inline

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

bool isValueMaskOff ( Index n ) const

inline

bool isValueMaskOff ( ) const

inline

bool isValueMaskOn ( Index n ) const

inline

bool isValueMaskOn ( ) const

inline

bool isValueOff ( const Coord & xyz ) const

inline

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

bool isValueOff ( Index offset ) const

inline

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

bool isValueOn ( const Coord & xyz ) const

inline

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

bool isValueOn ( Index offset ) const

inline

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

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.

Index64 leafCount ( ) const

inline

void makeChildNodeEmpty	(	Index	n,
		const ValueType &	value
	)

inlineprotected

Index64 memUsage ( ) const

inline

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

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.

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.

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.

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

inline

Apply a functor to the voxel at the given coordinates.

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.

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.

void negate ( )

inline

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

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

inline

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

inline

Deprecated:: "Use input type std::vector<Index64> for nodeCount."

Index64 nonLeafCount ( ) const

inline

Index64 offLeafVoxelCount ( ) const

inline

Coord offsetToGlobalCoord ( Index n ) const

inline

Return the global coordinates for a linear table offset.

void offsetToLocalCoord	(	Index	n,
		Coord &	xyz
	)

inlinestatic

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

Index64 offVoxelCount ( ) const

inline

Index64 onLeafVoxelCount ( ) const

inline

Index64 onTileCount ( ) const

inline

Index64 onVoxelCount ( ) const

inline

const Coord& origin ( ) const

inline

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

ChildT * probeChild ( const Coord & xyz )

inline

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

const ChildNodeType* probeChild ( const Coord & xyz ) const

inline

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

ChildT * probeChild	(	const Coord &	xyz,
		ValueType &	value,
		bool &	active
	)

inline

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

const ChildNodeType* probeChild	(	const Coord &	xyz,
		ValueType &	value,
		bool &	active
	)		const

inline

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

ChildT * probeChildUnsafe ( Index offset )

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

const ChildNodeType* probeChildUnsafe ( Index offset ) const

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

ChildT * probeChildUnsafe	(	Index	offset,
		ValueType &	value,
		bool &	active
	)

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

const ChildNodeType* probeChildUnsafe	(	Index	offset,
		ValueType &	value,
		bool &	active
	)		const

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

const ChildT * probeConstChild ( const Coord & xyz ) const

inline

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

const ChildT * probeConstChild	(	const Coord &	xyz,
		ValueType &	value,
		bool &	active
	)		const

inline

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

const ChildT * probeConstChildUnsafe ( Index offset ) const

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

const ChildT * probeConstChildUnsafe	(	Index	offset,
		ValueType &	value,
		bool &	active
	)		const

inline

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

Warning: This method should only be used by experts seeking low-level optimizations.

Note: Out-of-bounds memory access attempts will wrap around using modulo indexing.

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

inline

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

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

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

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

inline

const NodeType* probeConstNode ( const Coord & xyz ) const

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

const NodeT* probeConstNode ( const Coord & xyz ) const

inline

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

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

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

inline

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.

const LeafNodeType* probeLeaf ( const Coord & xyz ) const

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

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

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

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

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

inline

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

inline

NodeType* probeNode ( const Coord & xyz )

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

const NodeType* probeNode ( const Coord & xyz ) const

inline

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

NodeT* probeNode ( const Coord & xyz )

inline

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

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

inline

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

inline

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.

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.

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

inline

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

inline

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

inline

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.

void resetChildNode	(	Index	i,
		ChildNodeType *	child
	)

inlineprotected

void resetChildUnsafe	(	Index	offset,
		ChildNodeType *	child
	)

inline

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

Note: Use addChild(ChildNodeType*) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

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.

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.

void setActiveStateUnsafe	(	Index	offset,
		bool	on
	)

inline

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

Note: Use setActiveState(const Coord&, bool) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setChildNode	(	Index	i,
		ChildNodeType *	child
	)

inlineprotected

void setChildUnsafe	(	Index	offset,
		ChildNodeType *	child
	)

inline

Replace a tile at offset with the given child node.

Note: Use addChild(ChildNodeType*) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setOrigin ( const Coord & origin )

inline

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

void setTransientData ( Index32 transientData )

inline

Set the transient data value.

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.

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.

void setValueOff ( const Coord & xyz )

inline

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

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.

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.

void setValueOffUnsafe ( Index offset )

inline

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

Note: Use setValueOff(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setValueOffUnsafe	(	Index	offset,
		const ValueType &	value
	)

inline

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

Note: Use setValueOff(const Coord&, const ValueType&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setValueOn ( const Coord & xyz )

inline

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

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.

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.

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.

void setValueOnlyUnsafe	(	Index	offset,
		const ValueType &	value
	)

inline

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

Note: Use setValueOnly(const Coord&, const ValueType&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setValueOnUnsafe ( Index offset )

inline

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

Note: Use setValueOn(const Coord&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setValueOnUnsafe	(	Index	offset,
		const ValueType &	value
	)

inline

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

Note: Use setValueOn(const Coord&, const ValueType&) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

void setValuesOn ( )

inline

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

ChildT * stealChildUnsafe	(	Index	offset,
		const ValueType &	value,
		bool	active
	)

inline

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

Note: Use addChild(ChildNodeType*) for a safer alternative.

Warning: This method should only be used by experts seeking low-level optimizations.

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.

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

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.

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

inline

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.

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

inline

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.

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

inline

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.

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.

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

inline

Index32 transientData ( ) const

inline

Return the transient data value.

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

inlineprotected

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()

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

inline

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

inline

Friends And Related Function Documentation

friend class InternalNode

friend

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

friend class IteratorBase< MaskDenseIterator, InternalNode >

friend

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

friend class IteratorBase< MaskOffIterator, InternalNode >

friend

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

friend class IteratorBase< MaskOnIterator, InternalNode >

friend

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

Member Data Documentation

const Index DIM = 1 << TOTAL

static

const Index LEVEL = 1 + ChildNodeType::LEVEL

static

const Index LOG2DIM = Log2Dim

static

NodeMaskType mChildMask

protected

UnionType mNodes[NUM_VALUES]

protected

Coord mOrigin

protected

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

Index32 mTransientData = 0

protected

Transient data (not serialized)

NodeMaskType mValueMask

protected

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

static

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

static

const Index TOTAL = Log2Dim + ChildNodeType::TOTAL

static

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation