LeafNode specialization for values of type bool that stores both the active states and the values of (2^Log2Dim)^3 voxels as bit masks. More...

#include <openvdb/tree/LeafNodeBool.h>

Classes
struct	ChildIter
	Leaf nodes have no children, so their child iterators have no get/set accessors. More...

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

Public Types
using	LeafNodeType = LeafNode< bool, Log2Dim >

using	BuildType = bool

using	ValueType = bool

using	Buffer = LeafBuffer< ValueType, Log2Dim >

using	NodeMaskType = util::NodeMask< Log2Dim >

using	Ptr = SharedPtr< LeafNodeType >

using	ValueOnIter = ValueIter< MaskOnIter, LeafNode, const bool >

using	ValueOnCIter = ValueIter< MaskOnIter, const LeafNode, const bool >

using	ValueOffIter = ValueIter< MaskOffIter, LeafNode, const bool >

using	ValueOffCIter = ValueIter< MaskOffIter, const LeafNode, const bool >

using	ValueAllIter = ValueIter< MaskDenseIter, LeafNode, const bool >

using	ValueAllCIter = ValueIter< MaskDenseIter, const LeafNode, const bool >

using	ChildOnIter = ChildIter< MaskOnIter, LeafNode >

using	ChildOnCIter = ChildIter< MaskOnIter, const LeafNode >

using	ChildOffIter = ChildIter< MaskOffIter, LeafNode >

using	ChildOffCIter = ChildIter< MaskOffIter, const LeafNode >

using	ChildAllIter = DenseIter< LeafNode, bool >

using	ChildAllCIter = DenseIter< const LeafNode, const bool >

Public Member Functions
	LeafNode ()
	Default constructor. More...

	LeafNode (const Coord &xyz, bool value=false, bool active=false)

	LeafNode (PartialCreate, const Coord &xyz, bool value=false, bool active=false)
	"Partial creation" constructor used during file input More...

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

LeafNode &	operator= (const LeafNode &)=default
	Deep assignment operator. More...

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

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

	~LeafNode ()
	Destructor. More...

void	nodeCount (std::vector< Index32 > &) const
	no-op More...

Index64	onVoxelCount () const
	Return the number of active voxels. More...

Index64	offVoxelCount () const
	Return the number of inactive voxels. More...

Index64	onLeafVoxelCount () const

Index64	offLeafVoxelCount () const

bool	isEmpty () const
	Return `true` if this node has no active voxels. More...

bool	isDense () const
	Return `true` if this node only contains active voxels. More...

bool	isAllocated () const
	Return `true` if memory for this node's buffer has been allocated. More...

bool	allocate ()
	Allocate memory for this node's buffer if it has not already been allocated. More...

Index64	memUsage () const
	Return the memory in bytes occupied by this node. More...

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

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

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

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

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

std::string	str () const
	Return a string representation of this node. More...

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

bool	operator== (const LeafNode &) const
	Check for buffer equivalence by value. More...

bool	operator!= (const LeafNode &) const

void	swap (Buffer &other)
	Exchange this node's data buffer with the given data buffer without changing the active states of the values. More...

const Buffer &	buffer () const

Buffer &	buffer ()

void	readTopology (std::istream &, bool fromHalf=false)
	Read in just the topology. More...

void	writeTopology (std::ostream &, bool toHalf=false) const
	Write out just the topology. More...

void	readBuffers (std::istream &, bool fromHalf=false)
	Read in the topology and the origin. More...

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

void	writeBuffers (std::ostream &, bool toHalf=false) const
	Write out the topology and the origin. More...

const bool &	getValue (const Coord &xyz) const
	Return the value of the voxel at the given coordinates. More...

const bool &	getValue (Index offset) const
	Return the value of the voxel at the given offset. More...

bool	probeValue (const Coord &xyz, bool &val) const
	Return `true` if the voxel at the given coordinates is active. 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	setActiveState (Index offset, bool on)
	Set the active state of the voxel at the given offset but don't change its value. More...

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

void	setValueOnly (Index offset, bool val)
	Set the value of the voxel at the given offset but don't change its active state. More...

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

void	setValueOff (Index offset)
	Mark the voxel at the given offset as inactive but don't change its value. More...

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

void	setValueOff (Index offset, bool val)
	Set the value of the voxel at the given offset and mark the voxel as inactive. More...

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

void	setValueOn (Index offset)
	Mark the voxel at the given offset as active but don't change its value. More...

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

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

void	setValueOn (Index offset, bool val)
	Set the value of the voxel at the given offset and mark the voxel as active. More...

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

void	setValuesOn ()
	Mark all voxels as active but don't change their values. More...

void	setValuesOff ()
	Mark all voxels as inactive but don't change their 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...

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

void	fill (const CoordBBox &bbox, bool value, bool active=true)
	Set all voxels within an axis-aligned box to the specified value and active state. More...

void	denseFill (const CoordBBox &bbox, bool val, bool on=true)
	Set all voxels within an axis-aligned box to the specified value and active state. More...

void	fill (const bool &value)
	Set all voxels to the specified value but don't change their active states. More...

void	fill (const bool &value, bool active)
	Set all voxels to the specified value and active state. 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<typename DenseT >
void	copyFromDense (const CoordBBox &bbox, const DenseT &dense, bool background, bool tolerance)
	Copy from a dense grid into this node the values of the voxels that lie within a given bounding box. More...

template<typename AccessorT >
const bool &	getValueAndCache (const Coord &xyz, AccessorT &) const
	Return the value of the voxel at the given coordinates. More...

template<typename AccessorT >
bool	isValueOnAndCache (const Coord &xyz, AccessorT &) const
	Return `true` if the voxel at the given coordinates is active. More...

template<typename AccessorT >
void	setValueAndCache (const Coord &xyz, bool val, AccessorT &)
	Change the value of the voxel at the given coordinates and mark it as active. More...

template<typename AccessorT >
void	setValueOnlyAndCache (const Coord &xyz, bool val, AccessorT &)
	Change the value of the voxel at the given coordinates but preserve its state. More...

template<typename AccessorT >
void	setValueOffAndCache (const Coord &xyz, bool value, AccessorT &)
	Change the value of the voxel at the given coordinates and mark it as inactive. More...

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

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

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

template<typename AccessorT >
bool	probeValueAndCache (const Coord &xyz, bool &val, AccessorT &) const
	Return `true` if the voxel at the given coordinates is active and return the voxel value in val. More...

const bool &	getFirstValue () const
	Return a const reference to the first entry in the buffer. More...

const bool &	getLastValue () const
	Return a const reference to the last entry in the buffer. More...

bool	isConstant (bool &constValue, bool &state, bool tolerance=0) const

bool	medianAll () const
	Computes the median value of all the active and inactive voxels in this node. More...

Index	medianOn (ValueType &value) const
	Computes the median value of all the active voxels in this node. More...

Index	medianOff (ValueType &value) const
	Computes the median value of all the inactive voxels in this node. More...

bool	isInactive () const
	Return `true` if all of this node's values are inactive. More...

void	resetBackground (bool oldBackground, bool newBackground)

void	negate ()

template<MergePolicy Policy>
void	merge (const LeafNode &other, bool bg=false, bool otherBG=false)

template<MergePolicy Policy>
void	merge (bool tileValue, bool tileActive)

void	voxelizeActiveTiles (bool=true)
	No-op. More...

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

template<typename OtherType >
void	topologyIntersection (const LeafNode< OtherType, Log2Dim > &other, const bool &)
	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. More...

template<typename OtherType >
void	topologyDifference (const LeafNode< OtherType, Log2Dim > &other, const bool &)
	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. More...

template<typename CombineOp >
void	combine (const LeafNode &other, CombineOp &op)

template<typename CombineOp >
void	combine (bool, 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 (bool, const OtherNodeT &other, bool valueIsActive, CombineOp &)

template<typename CombineOp , typename OtherNodeT >
void	combine2 (const LeafNode &b0, const OtherNodeT &b1, CombineOp &)

template<typename BBoxOp >
void	visitActiveBBox (BBoxOp &) const
	Calls the templated functor BBoxOp with bounding box information. An additional level argument is provided to the callback. More...

template<typename VisitorOp >
void	visit (VisitorOp &)

template<typename VisitorOp >
void	visit (VisitorOp &) const

template<typename OtherLeafNodeType , typename VisitorOp >
void	visit2Node (OtherLeafNodeType &other, VisitorOp &)

template<typename OtherLeafNodeType , typename VisitorOp >
void	visit2Node (OtherLeafNodeType &other, VisitorOp &) const

template<typename IterT , typename VisitorOp >
void	visit2 (IterT &otherIter, VisitorOp &, bool otherIsLHS=false)

template<typename IterT , typename VisitorOp >
void	visit2 (IterT &otherIter, VisitorOp &, bool otherIsLHS=false) const

void	addTile (Index level, const Coord &, bool val, bool active)

void	addTile (Index offset, bool val, bool active)

template<typename AccessorT >
void	addTileAndCache (Index level, const Coord &, bool val, bool active, AccessorT &)

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

bool	isValueMaskOn (Index n) const

bool	isValueMaskOn () const

bool	isValueMaskOff (Index n) const

bool	isValueMaskOff () const

const NodeMaskType &	getValueMask () const

const NodeMaskType &	valueMask () const

NodeMaskType &	getValueMask ()

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)

template<typename ValueT >
	LeafNode (const LeafNode< ValueT, Log2Dim > &other, bool background, TopologyCopy)

template<typename ValueT >
	LeafNode (const LeafNode< ValueT, Log2Dim > &other, TopologyCopy)

template<typename ValueT >
	LeafNode (const LeafNode< ValueT, Log2Dim > &other, bool offValue, bool onValue, TopologyCopy)


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

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


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

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

void	getOrigin (Int32 &x, Int32 &y, Int32 &z) const
	Return the grid index coordinates of this node's local origin. More...


void	prune (const ValueType &=zeroVal< ValueType >())
	This function exists only to enable template instantiation. More...

void	addLeaf (LeafNode *)
	This function exists only to enable template instantiation. More...

template<typename AccessorT >
void	addLeafAndCache (LeafNode *, AccessorT &)
	This function exists only to enable template instantiation. More...

template<typename NodeT >
NodeT *	stealNode (const Coord &, const ValueType &, bool)
	This function exists only to enable template instantiation. More...

template<typename NodeT >
NodeT *	probeNode (const Coord &)
	This function exists only to enable template instantiation. More...

template<typename NodeT >
const NodeT *	probeConstNode (const Coord &) const
	This function exists only to enable template instantiation. More...

template<typename ArrayT >
void	getNodes (ArrayT &) const
	This function exists only to enable template instantiation. More...

template<typename ArrayT >
void	stealNodes (ArrayT &, const ValueType &, bool)
	This function exists only to enable template instantiation. More...


LeafNode *	touchLeaf (const Coord &)
	Return a pointer to this node. More...

template<typename AccessorT >
LeafNode *	touchLeafAndCache (const Coord &, AccessorT &)
	Return a pointer to this node. More...

LeafNode *	probeLeaf (const Coord &)
	Return a pointer to this node. More...

template<typename AccessorT >
LeafNode *	probeLeafAndCache (const Coord &, AccessorT &)
	Return a pointer to this node. More...

template<typename NodeT , typename AccessorT >
NodeT *	probeNodeAndCache (const Coord &, AccessorT &)
	Return a pointer to this node. More...


const LeafNode *	probeLeaf (const Coord &) const
	Return a `const` pointer to this node. More...

template<typename AccessorT >
const LeafNode *	probeLeafAndCache (const Coord &, AccessorT &) const
	Return a `const` pointer to this node. More...

const LeafNode *	probeConstLeaf (const Coord &) const
	Return a `const` pointer to this node. More...

template<typename AccessorT >
const LeafNode *	probeConstLeafAndCache (const Coord &, AccessorT &) const
	Return a `const` pointer to this node. More...

template<typename NodeT , typename AccessorT >
const NodeT *	probeConstNodeAndCache (const Coord &, AccessorT &) const
	Return a `const` pointer to this node. More...

Static Public Member Functions
static Index	log2dim ()
	Return log2 of the size of the buffer storage. More...

static Index	dim ()
	Return the number of voxels in each dimension. More...

static Index	size ()

static Index	numValues ()

static Index	getLevel ()

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

static Index	getChildDim ()

static Index32	leafCount ()

static Index32	nonLeafCount ()

static Index64	onTileCount ()

static Index64	offTileCount ()

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

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

static Index	getValueLevel (const Coord &)
	Return the level (0) at which leaf node values reside. More...

static bool	hasActiveTiles ()
	Return `false` since leaf nodes never contain tiles. More...

template<typename AccessorT >
static Index	getValueLevelAndCache (const Coord &, AccessorT &)
	Return the LEVEL (=0) at which leaf node values reside. More...

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	MaskOnIter = typename NodeMaskType::OnIterator

using	MaskOffIter = typename NodeMaskType::OffIterator

using	MaskDenseIter = typename NodeMaskType::DenseIterator

Protected Member Functions
void	setValueMask (Index n, bool on)

void	setValueMaskOn (Index n)

void	setValueMaskOff (Index n)

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

template<typename NodeT , typename VisitorOp , typename ChildAllIterT >
static void	doVisit (NodeT &, VisitorOp &)

template<typename NodeT , typename OtherNodeT , typename VisitorOp , typename ChildAllIterT , typename OtherChildAllIterT >
static void	doVisit2Node (NodeT &self, OtherNodeT &other, VisitorOp &)

template<typename NodeT , typename VisitorOp , typename ChildAllIterT , typename OtherChildAllIterT >
static void	doVisit2 (NodeT &self, OtherChildAllIterT &, VisitorOp &, bool otherIsLHS)

Protected Attributes
NodeMaskType	mValueMask
	Bitmask that determines which voxels are active. More...

Buffer	mBuffer
	Bitmask representing the values of voxels. More...

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	LeafNode
	During topology-only construction, access is needed to protected/private members of other template instances. More...

struct	ValueIter< MaskOnIter, LeafNode, bool >

struct	ValueIter< MaskOffIter, LeafNode, bool >

struct	ValueIter< MaskDenseIter, LeafNode, bool >

struct	ValueIter< MaskOnIter, const LeafNode, bool >

struct	ValueIter< MaskOffIter, const LeafNode, bool >

struct	ValueIter< MaskDenseIter, const LeafNode, bool >


class	IteratorBase< MaskOnIter, LeafNode >

class	IteratorBase< MaskOffIter, LeafNode >

class	IteratorBase< MaskDenseIter, LeafNode >

Detailed Description

template<Index Log2Dim>
class openvdb::v9_0::tree::LeafNode< bool, Log2Dim >

LeafNode specialization for values of type bool that stores both the active states and the values of (2^Log2Dim)^3 voxels as bit masks.

Member Typedef Documentation

using Buffer = LeafBuffer<ValueType, Log2Dim>

using BuildType = bool

using ChildAllCIter = DenseIter<const LeafNode, const bool>

using ChildAllIter = DenseIter<LeafNode, bool>

using ChildOffCIter = ChildIter<MaskOffIter, const LeafNode>

using ChildOffIter = ChildIter<MaskOffIter, LeafNode>

using ChildOnCIter = ChildIter<MaskOnIter, const LeafNode>

using ChildOnIter = ChildIter<MaskOnIter, LeafNode>

using LeafNodeType = LeafNode<bool, Log2Dim>

using MaskDenseIter = typename NodeMaskType::DenseIterator

protected

using MaskOffIter = typename NodeMaskType::OffIterator

protected

using MaskOnIter = typename NodeMaskType::OnIterator

protected

using NodeMaskType = util::NodeMask<Log2Dim>

using Ptr = SharedPtr<LeafNodeType>

using ValueAllCIter = ValueIter<MaskDenseIter, const LeafNode, const bool>

using ValueAllIter = ValueIter<MaskDenseIter, LeafNode, const bool>

using ValueOffCIter = ValueIter<MaskOffIter, const LeafNode, const bool>

using ValueOffIter = ValueIter<MaskOffIter, LeafNode, const bool>

using ValueOnCIter = ValueIter<MaskOnIter, const LeafNode, const bool>

using ValueOnIter = ValueIter<MaskOnIter, LeafNode, const bool>

using ValueType = bool

Constructor & Destructor Documentation

LeafNode ( )

inline

Default constructor.

LeafNode	(	const Coord &	xyz,
		bool	value = `false`,
		bool	active = `false`
	)

inlineexplicit

Constructor

Parameters

xyz	the coordinates of a voxel that lies within the node
value	the initial value for all of this node's voxels
active	the active state to which to initialize all voxels

LeafNode	(	PartialCreate	,
		const Coord &	xyz,
		bool	value = `false`,
		bool	active = `false`
	)

inline

"Partial creation" constructor used during file input

LeafNode ( const LeafNode< bool, Log2Dim > & other )

inline

Deep copy constructor.

LeafNode ( const LeafNode< OtherValueType, Log2Dim > & other )

explicit

Value conversion copy constructor.

LeafNode	(	const LeafNode< ValueType, Log2Dim > &	other,
		TopologyCopy
	)

Topology copy constructor.

LeafNode	(	const LeafNode< ValueType, Log2Dim > &	other,
		bool	offValue,
		bool	onValue,
		TopologyCopy
	)

Topology copy constructor.

Note: This variant exists mainly to enable template instantiation.

LeafNode	(	const LeafNode< ValueType, Log2Dim > &	other,
		bool	background,
		TopologyCopy
	)

Topology copy constructor.

Note: This variant exists mainly to enable template instantiation.

~LeafNode ( )

inline

Destructor.

LeafNode ( const LeafNode< ValueT, Log2Dim > & other )

inline

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

inline

LeafNode	(	const LeafNode< ValueT, Log2Dim > &	other,
		TopologyCopy
	)

inline

LeafNode	(	const LeafNode< ValueT, Log2Dim > &	other,
		bool	offValue,
		bool	onValue,
		TopologyCopy
	)

inline

Member Function Documentation

void addLeaf ( LeafNode< bool, Log2Dim > * )

inline

This function exists only to enable template instantiation.

void addLeafAndCache	(	LeafNode< bool, Log2Dim > *	,
		AccessorT &
	)

inline

This function exists only to enable template instantiation.

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

inline

void addTile	(	Index	offset,
		bool	val,
		bool	active
	)

inline

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

inline

bool allocate ( )

inline

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

Currently, boolean leaf nodes don't support partial creation, so this has no effect.

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

ValueOffIter beginValueOff ( )

inline

ValueOnCIter beginValueOn ( ) const

inline

ValueOnIter beginValueOn ( )

inline

const Buffer& buffer ( ) const

inline

Buffer& buffer ( )

inline

ChildAllCIter cbeginChildAll ( ) const

inline

ChildOffCIter cbeginChildOff ( ) const

inline

ChildOnCIter cbeginChildOn ( ) const

inline

ValueAllCIter cbeginValueAll ( ) const

inline

ValueOffCIter cbeginValueOff ( ) const

inline

ValueOnCIter cbeginValueOn ( ) const

inline

ChildAllCIter cendChildAll ( ) const

inline

ChildOffCIter cendChildOff ( ) const

inline

ChildOnCIter cendChildOn ( ) const

inline

ValueAllCIter cendValueAll ( ) const

inline

ValueOffCIter cendValueOff ( ) const

inline

ValueOnCIter cendValueOn ( ) const

inline

void clip	(	const CoordBBox &	clipBBox,
		bool	background
	)

inline

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

void combine	(	const LeafNode< bool, Log2Dim > &	other,
		CombineOp &	op
	)

inline

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

inline

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

inline

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

inline

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

inline

Index coordToOffset ( const Coord & xyz )

inlinestatic

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

void copyFromDense	(	const CoordBBox &	bbox,
		const DenseT &	dense,
		bool	background,
		bool	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.

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.

void denseFill	(	const CoordBBox &	bbox,
		bool	val,
		bool	on = `true`
	)

inline

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

static Index dim ( )

inlinestatic

Return the number of voxels in each dimension.

void doVisit	(	NodeT &	self,
		VisitorOp &	op
	)

inlinestaticprotected

void doVisit2	(	NodeT &	self,
		OtherChildAllIterT &	otherIter,
		VisitorOp &	op,
		bool	otherIsLHS
	)

inlinestaticprotected

void doVisit2Node	(	NodeT &	self,
		OtherNodeT &	other,
		VisitorOp &	op
	)

inlinestaticprotected

ChildAllCIter endChildAll ( ) const

inline

ChildAllIter endChildAll ( )

inline

ChildOffCIter endChildOff ( ) const

inline

ChildOffIter endChildOff ( )

inline

ChildOnCIter endChildOn ( ) const

inline

ChildOnIter endChildOn ( )

inline

ValueAllCIter endValueAll ( ) const

inline

ValueAllIter endValueAll ( )

inline

ValueOffCIter endValueOff ( ) const

inline

ValueOffIter endValueOff ( )

inline

ValueOnCIter endValueOn ( ) const

inline

ValueOnIter endValueOn ( )

inline

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.

static void evalNodeOrigin ( Coord & xyz )

inlinestaticprotected

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

void fill	(	const CoordBBox &	bbox,
		bool	value,
		bool	active = `true`
	)

inline

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

void fill ( const bool & value )

inline

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

void fill	(	const bool &	value,
		bool	active
	)

inline

Set all voxels to the specified value and active state.

static Index getChildDim ( )

inlinestatic

const bool& getFirstValue ( ) const

inline

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

Note: Since it's actually a reference to a static data member it should not be converted to a non-const pointer!

const bool& getLastValue ( ) const

inline

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

Note: Since it's actually a reference to a static data member it should not be converted to a non-const pointer!

static Index getLevel ( )

inlinestatic

CoordBBox getNodeBoundingBox ( ) const

inline

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

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

inlinestatic

void getNodes ( ArrayT & ) const

inline

This function exists only to enable template instantiation.

void getOrigin ( Coord & origin ) const

inline

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

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

inline

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

const bool & getValue ( const Coord & xyz ) const

inline

Return the value of the voxel at the given coordinates.

const bool & getValue ( Index offset ) const

inline

Return the value of the voxel at the given offset.

const bool& getValueAndCache	(	const Coord &	xyz,
		AccessorT &
	)		const

inline

Return the value of the voxel at the given coordinates.

Note: Used internally by ValueAccessor.

static Index getValueLevel ( const Coord & )

inlinestatic

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

static Index getValueLevelAndCache	(	const Coord &	,
		AccessorT &
	)

inlinestatic

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

Note: Used internally by ValueAccessor.

const NodeMaskType& getValueMask ( ) const

inline

NodeMaskType& getValueMask ( )

inline

static bool hasActiveTiles ( )

inlinestatic

Return false since leaf nodes never contain tiles.

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.

bool isAllocated ( ) const

inline

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

Currently, boolean leaf nodes don't support partial creation, so this always returns true.

bool isChildMaskOff ( Index ) const

inline

bool isChildMaskOff ( ) const

inline

bool isChildMaskOn ( Index ) const

inline

bool isConstant	(	bool &	constValue,
		bool &	state,
		bool	tolerance = `0`
	)		const

inline

Return true if all of this node's voxels have the same active state and are equal to within the given tolerance, and return the value in constValue and the active state in state.

bool isDense ( ) const

inline

Return true if this node only contains active voxels.

bool isEmpty ( ) const

inline

Return true if this node has no active voxels.

bool isInactive ( ) const

inline

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

bool isValueMaskOff ( Index n ) const

inline

bool isValueMaskOff ( ) const

inline

bool isValueMaskOn ( Index n ) const

inline

bool isValueMaskOn ( ) const

inline

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 &
	)		const

inline

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

Note: Used internally by ValueAccessor.

static Index32 leafCount ( )

inlinestatic

static Index log2dim ( )

inlinestatic

Return log2 of the size of the buffer storage.

bool medianAll ( ) const

inline

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

Returns: The median value.

The median for boolean values is defined as the mode of the values, i.e. the value that occurs most often.

Index medianOff ( ValueType & value ) const

inline

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

Returns: The number of inactive voxels.

Parameters

value Updated with the median value of all the inactive voxels.

The median for boolean values is defined as the mode of the values, i.e. the value that occurs most often.

Index medianOn ( ValueType & value ) const

inline

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

Returns: The number of active voxels.

Parameters

value Updated with the median value of all the active voxels.

The median for boolean values is defined as the mode of the values, i.e. the value that occurs most often.

Index64 memUsage ( ) const

inline

Return the memory in bytes occupied by this node.

void merge	(	const LeafNode< bool, Log2Dim > &	other,
		bool	bg = `false`,
		bool	otherBG = `false`
	)

inline

void merge	(	bool	tileValue,
		bool	tileActive
	)

inline

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.

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

inline

Apply a functor to the voxel at the given coordinates.

Note: Used internally by ValueAccessor.

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.

void negate ( )

inline

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

inline

no-op

static Index32 nonLeafCount ( )

inlinestatic

static Index numValues ( )

inlinestatic

Index64 offLeafVoxelCount ( ) const

inline

Coord offsetToGlobalCoord ( Index n ) const

inline

Return the global coordinates for a linear table offset.

Coord offsetToLocalCoord ( Index n )

inlinestatic

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

static Index64 offTileCount ( )

inlinestatic

Index64 offVoxelCount ( ) const

inline

Return the number of inactive voxels.

Index64 onLeafVoxelCount ( ) const

inline

static Index64 onTileCount ( )

inlinestatic

Index64 onVoxelCount ( ) const

inline

Return the number of active voxels.

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

inline

LeafNode& operator= ( const LeafNode< bool, Log2Dim > & )

default

Deep assignment operator.

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

inline

Check for buffer equivalence by value.

const Coord& origin ( ) const

inline

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

const LeafNode* probeConstLeaf ( const Coord & ) const

inline

Return a const pointer to this node.

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

inline

Return a const pointer to this node.

const NodeT* probeConstNode ( const Coord & ) const

inline

This function exists only to enable template instantiation.

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

inline

Return a const pointer to this node.

LeafNode* probeLeaf ( const Coord & )

inline

Return a pointer to this node.

const LeafNode* probeLeaf ( const Coord & ) const

inline

Return a const pointer to this node.

LeafNode* probeLeafAndCache	(	const Coord &	,
		AccessorT &
	)

inline

Return a pointer to this node.

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

inline

Return a const pointer to this node.

NodeT* probeNode ( const Coord & )

inline

This function exists only to enable template instantiation.

NodeT* probeNodeAndCache	(	const Coord &	,
		AccessorT &
	)

inline

Return a pointer to this node.

bool probeValue	(	const Coord &	xyz,
		bool &	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

bool probeValueAndCache	(	const Coord &	xyz,
		bool &	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.

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

inline

This function exists only to enable template instantiation.

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

inline

Read in the topology and the origin.

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

inline

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

inline

Read in just the topology.

void resetBackground	(	bool	oldBackground,
		bool	newBackground
	)

inline

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 setActiveState	(	Index	offset,
		bool	on
	)

inline

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

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.

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 setValue	(	const Coord &	xyz,
		bool	val
	)

inline

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

void setValueAndCache	(	const Coord &	xyz,
		bool	val,
		AccessorT &
	)

inline

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

Note: Used internally by ValueAccessor.

void setValueMask ( const NodeMaskType & mask )

inline

void setValueMask	(	Index	n,
		bool	on
	)

inlineprotected

void setValueMaskOff ( Index n )

inlineprotected

void setValueMaskOn ( Index n )

inlineprotected

void setValueOff ( const Coord & xyz )

inline

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

void setValueOff ( Index offset )

inline

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

void setValueOff	(	const Coord &	xyz,
		bool	val
	)

inline

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

void setValueOff	(	Index	offset,
		bool	val
	)

inline

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

void setValueOffAndCache	(	const Coord &	xyz,
		bool	value,
		AccessorT &
	)

inline

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

Note: Used internally by ValueAccessor.

void setValueOn ( const Coord & xyz )

inline

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

void setValueOn ( Index offset )

inline

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

void setValueOn	(	const Coord &	xyz,
		bool	val
	)

inline

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

void setValueOn	(	Index	offset,
		bool	val
	)

inline

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

void setValueOnly	(	const Coord &	xyz,
		bool	val
	)

inline

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

void setValueOnly	(	Index	offset,
		bool	val
	)

inline

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

void setValueOnlyAndCache	(	const Coord &	xyz,
		bool	val,
		AccessorT &
	)

inline

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

Note: Used internally by ValueAccessor.

void setValuesOff ( )

inline

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

void setValuesOn ( )

inline

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

static Index size ( )

inlinestatic

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

inline

This function exists only to enable template instantiation.

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

inline

This function exists only to enable template instantiation.

std::string str ( ) const

inline

Return a string representation of this node.

void swap ( Buffer & other )

inline

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

void topologyDifference	(	const LeafNode< OtherType, Log2Dim > &	other,
		const bool &
	)

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.

void topologyIntersection	(	const LeafNode< OtherType, Log2Dim > &	other,
		const bool &
	)

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.

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.

LeafNode* touchLeaf ( const Coord & )

inline

Return a pointer to this node.

LeafNode* touchLeafAndCache	(	const Coord &	,
		AccessorT &
	)

inline

Return a pointer to this node.

Index32 transientData ( ) const

inline

Return the transient data value.

const NodeMaskType& valueMask ( ) const

inline

void visit ( VisitorOp & op )

inline

void visit ( VisitorOp & op ) const

inline

void visit2	(	IterT &	otherIter,
		VisitorOp &	op,
		bool	otherIsLHS = `false`
	)

inline

void visit2	(	IterT &	otherIter,
		VisitorOp &	op,
		bool	otherIsLHS = `false`
	)		const

inline

void visit2Node	(	OtherLeafNodeType &	other,
		VisitorOp &	op
	)

inline

void visit2Node	(	OtherLeafNodeType &	other,
		VisitorOp &	op
	)		const

inline

void visitActiveBBox ( BBoxOp & op ) const

inline

Calls the templated functor BBoxOp with bounding box information. An additional level argument is provided to the callback.

Note: The bounding boxes are guaranteed to be non-overlapping.

void voxelizeActiveTiles ( bool = true )

inline

No-op.

This function exists only to enable template instantiation.

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

inline

Write out the topology and the origin.

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

inline

Write out just the topology.

Friends And Related Function Documentation

friend class IteratorBase< MaskDenseIter, LeafNode >

friend

Allow iterators to call mask accessor methods (see below).

friend class IteratorBase< MaskOffIter, LeafNode >

friend

Allow iterators to call mask accessor methods (see below).

friend class IteratorBase< MaskOnIter, LeafNode >

friend

Allow iterators to call mask accessor methods (see below).

friend class LeafNode

friend

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

friend struct ValueIter< MaskDenseIter, const LeafNode, bool >

friend

friend struct ValueIter< MaskDenseIter, LeafNode, bool >

friend

friend struct ValueIter< MaskOffIter, const LeafNode, bool >

friend

friend struct ValueIter< MaskOffIter, LeafNode, bool >

friend

friend struct ValueIter< MaskOnIter, const LeafNode, bool >

friend

friend struct ValueIter< MaskOnIter, LeafNode, bool >

friend

Member Data Documentation

const Index DIM = 1 << TOTAL

static

const Index LEVEL = 0

static

const Index LOG2DIM = Log2Dim

static

Buffer mBuffer

protected

Bitmask representing the values of voxels.

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

Bitmask that determines which voxels are active.

const Index NUM_VALUES = 1 << 3 * Log2Dim

static

const Index NUM_VOXELS = NUM_VALUES

static

const Index SIZE = NUM_VALUES

static

const Index TOTAL = Log2Dim

static

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<Index Log2Dim> class openvdb::v9_0::tree::LeafNode< bool, Log2Dim >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<Index Log2Dim>
class openvdb::v9_0::tree::LeafNode< bool, Log2Dim >