HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim > Class Template Reference

LeafNode specialization for values of type ValueMask that encodes both the active states and the boolean values of (2^Log2Dim)^3 voxels in a single bit mask, i.e. voxel values and states are indistinguishable! More...

#include <LeafNodeMask.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< ValueMask, Log2Dim >
 
using BuildType = ValueMask
 
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 dummy=false)
 
 LeafNode (PartialCreate, const Coord &xyz, bool value=false, bool dummy=false)
 "Partial creation" constructor used during file input More...
 
 LeafNode (const LeafNode &)
 Deep copy constructor. 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...
 
Index64 memUsageIfLoaded () const
 
void evalActiveBoundingBox (CoordBBox &bbox, bool visitVoxels=true) const
 
CoordBBox getNodeBoundingBox () const
 Return the bounding box of this node, i.e., the full index space spanned by this leaf node. 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...
 
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 Bufferbuffer () const
 
Bufferbuffer ()
 
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=false)
 Set all voxels within an axis-aligned box to the specified value. More...
 
void denseFill (const CoordBBox &bbox, bool value, bool=false)
 Set all voxels within an axis-aligned box to the specified value. More...
 
void fill (const bool &value, bool dummy=false)
 Set the state of all voxels to the specified 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, bool)
 no-op since for this template specialization voxel values and states are indistinguishable. More...
 
void negate ()
 Invert the bits of the voxels, i.e. states and values. More...
 
template<MergePolicy Policy>
void merge (const LeafNode &other, bool bg=false, bool otherBG=false)
 
template<MergePolicy Policy>
void merge (bool tileValue, bool tileActive=false)
 
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 &)
 
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 NodeMaskTypegetValueMask () const
 
const NodeMaskTypevalueMask () const
 
NodeMaskTypegetValueMask ()
 
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, 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...
 
LeafNodetouchLeaf (const Coord &)
 Return a pointer to this node. More...
 
template<typename AccessorT >
LeafNodetouchLeafAndCache (const Coord &, AccessorT &)
 Return a pointer to this node. More...
 
LeafNodeprobeLeaf (const Coord &)
 Return a pointer to this node. More...
 
template<typename AccessorT >
LeafNodeprobeLeafAndCache (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 LeafNodeprobeLeaf (const Coord &) const
 Return a pointer to this node. More...
 
template<typename AccessorT >
const LeafNodeprobeLeafAndCache (const Coord &, AccessorT &) const
 Return a pointer to this node. More...
 
const LeafNodeprobeConstLeaf (const Coord &) const
 Return a pointer to this node. More...
 
template<typename AccessorT >
const LeafNodeprobeConstLeafAndCache (const Coord &, AccessorT &) const
 Return a pointer to this node. More...
 
template<typename NodeT , typename AccessorT >
const NodeT * probeConstNodeAndCache (const Coord &, AccessorT &) const
 Return a 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 ()
 Return the total number of voxels represented by this LeafNode. More...
 
static Index numValues ()
 Return the total number of voxels represented by this LeafNode. More...
 
static Index getLevel ()
 Return the level of this node, which by definition is zero for LeafNodes. More...
 
static void getNodeLog2Dims (std::vector< Index > &dims)
 Append the Log2Dim of this LeafNode to the specified vector. More...
 
static Index getChildDim ()
 Return the dimension of child nodes of this LeafNode, which is one for voxels. More...
 
static Index32 leafCount ()
 Return the leaf count for this node, which is one. More...
 
static Index32 nonLeafCount ()
 Return the non-leaf count for this node, which is zero. More...
 
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...
 

Protected Attributes

Buffer mBuffer
 Bitmask representing the values AND state of voxels. More...
 
Coord mOrigin
 Global grid index coordinates (x,y,z) of the local origin of this node. 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 >
 
template<typename , Index >
class LeafBuffer
 
class IteratorBase< MaskOnIter, LeafNode >
 
class IteratorBase< MaskOffIter, LeafNode >
 
class IteratorBase< MaskDenseIter, LeafNode >
 

Detailed Description

template<Index Log2Dim>
class openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >

LeafNode specialization for values of type ValueMask that encodes both the active states and the boolean values of (2^Log2Dim)^3 voxels in a single bit mask, i.e. voxel values and states are indistinguishable!

Definition at line 30 of file LeafNodeMask.h.

Member Typedef Documentation

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::Buffer = LeafBuffer<ValueType, Log2Dim>

Definition at line 36 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::BuildType = ValueMask

Definition at line 34 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildAllCIter = DenseIter<const LeafNode, const bool>

Definition at line 645 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildAllIter = DenseIter<LeafNode, bool>

Definition at line 644 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildOffCIter = ChildIter<MaskOffIter, const LeafNode>

Definition at line 643 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildOffIter = ChildIter<MaskOffIter, LeafNode>

Definition at line 642 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildOnCIter = ChildIter<MaskOnIter, const LeafNode>

Definition at line 641 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ChildOnIter = ChildIter<MaskOnIter, LeafNode>

Definition at line 640 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNodeType = LeafNode<ValueMask, Log2Dim>

Definition at line 33 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::MaskDenseIter = typename NodeMaskType::DenseIterator
protected

Definition at line 570 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::MaskOffIter = typename NodeMaskType::OffIterator
protected

Definition at line 569 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::MaskOnIter = typename NodeMaskType::OnIterator
protected

Definition at line 568 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::NodeMaskType = util::NodeMask<Log2Dim>

Definition at line 37 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::Ptr = SharedPtr<LeafNodeType>

Definition at line 38 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueAllCIter = ValueIter<MaskDenseIter, const LeafNode, const bool>

Definition at line 639 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueAllIter = ValueIter<MaskDenseIter, LeafNode, const bool>

Definition at line 638 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueOffCIter = ValueIter<MaskOffIter, const LeafNode, const bool>

Definition at line 637 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueOffIter = ValueIter<MaskOffIter, LeafNode, const bool>

Definition at line 636 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueOnCIter = ValueIter<MaskOnIter, const LeafNode, const bool>

Definition at line 635 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueOnIter = ValueIter<MaskOnIter, LeafNode, const bool>

Definition at line 634 of file LeafNodeMask.h.

template<Index Log2Dim>
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueType = bool

Definition at line 35 of file LeafNodeMask.h.

Constructor & Destructor Documentation

template<Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( )
inline

Default constructor.

Definition at line 750 of file LeafNodeMask.h.

template<Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const Coord &  xyz,
bool  value = false,
bool  dummy = false 
)
inlineexplicit

Constructor

Parameters
xyzthe coordinates of a voxel that lies within the node
valuethe initial value = state for all of this node's voxels
dummydummy value

Definition at line 757 of file LeafNodeMask.h.

template<Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( PartialCreate  ,
const Coord &  xyz,
bool  value = false,
bool  dummy = false 
)
inline

"Partial creation" constructor used during file input

Definition at line 766 of file LeafNodeMask.h.

template<Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueMask, Log2Dim > &  other)
inline

Deep copy constructor.

Definition at line 775 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename OtherValueType >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< OtherValueType, Log2Dim > &  other)
explicit

Value conversion copy constructor.

template<Index Log2Dim>
template<typename ValueType >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueType, Log2Dim > &  other,
TopologyCopy   
)

Topology copy constructor.

template<Index Log2Dim>
template<typename ValueType >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueType, Log2Dim > &  other,
bool  offValue,
bool  onValue,
TopologyCopy   
)

Topology copy constructor.

Note
This variant exists mainly to enable template instantiation.
template<Index Log2Dim>
template<typename ValueType >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueType, Log2Dim > &  other,
bool  background,
TopologyCopy   
)

Topology copy constructor.

Note
This variant exists mainly to enable template instantiation.
template<Index Log2Dim>
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::~LeafNode ( )
inline

Destructor.

Definition at line 849 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueT, Log2Dim > &  other)
inline

Definition at line 789 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueT, Log2Dim > &  other,
bool  ,
TopologyCopy   
)
inline

Definition at line 802 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueT, Log2Dim > &  other,
TopologyCopy   
)
inline

Definition at line 816 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LeafNode ( const LeafNode< ValueT, Log2Dim > &  other,
bool  offValue,
bool  onValue,
TopologyCopy   
)
inline

Definition at line 829 of file LeafNodeMask.h.

Member Function Documentation

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::addLeaf ( LeafNode< ValueMask, Log2Dim > *  )
inline

This function exists only to enable template instantiation.

Definition at line 511 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::addLeafAndCache ( LeafNode< ValueMask, Log2Dim > *  ,
AccessorT &   
)
inline

This function exists only to enable template instantiation.

Definition at line 513 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::addTile ( Index  level,
const Coord &  xyz,
bool  val,
bool  active 
)
inline

Definition at line 1075 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::addTile ( Index  offset,
bool  val,
bool  active 
)
inline

Definition at line 1082 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::addTileAndCache ( Index  level,
const Coord &  xyz,
bool  val,
bool  active,
AccessorT &   
)
inline

Definition at line 1092 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 140 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildAll ( ) const
inline

Definition at line 676 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildAll ( )
inline

Definition at line 677 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildOff ( ) const
inline

Definition at line 673 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildOff ( )
inline

Definition at line 674 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildOn ( ) const
inline

Definition at line 670 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginChildOn ( )
inline

Definition at line 671 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueAll ( ) const
inline

Definition at line 654 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueAll ( )
inline

Definition at line 655 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueOff ( ) const
inline

Definition at line 651 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueOff ( )
inline

Definition at line 652 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueOn ( ) const
inline

Definition at line 648 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::beginValueOn ( )
inline

Definition at line 649 of file LeafNodeMask.h.

template<Index Log2Dim>
const Buffer& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::buffer ( ) const
inline

Definition at line 197 of file LeafNodeMask.h.

template<Index Log2Dim>
Buffer& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::buffer ( )
inline

Definition at line 198 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginChildAll ( ) const
inline

Definition at line 675 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginChildOff ( ) const
inline

Definition at line 672 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginChildOn ( ) const
inline

Definition at line 669 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginValueAll ( ) const
inline

Definition at line 653 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginValueOff ( ) const
inline

Definition at line 650 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cbeginValueOn ( ) const
inline

Definition at line 647 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendChildAll ( ) const
inline

Definition at line 685 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendChildOff ( ) const
inline

Definition at line 682 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendChildOn ( ) const
inline

Definition at line 679 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendValueAll ( ) const
inline

Definition at line 663 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendValueOff ( ) const
inline

Definition at line 660 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::cendValueOn ( ) const
inline

Definition at line 657 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::clip ( const CoordBBox &  clipBBox,
bool  background 
)
inline

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

Definition at line 1276 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename CombineOp >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::combine ( const LeafNode< ValueMask, Log2Dim > &  other,
CombineOp &  op 
)
inline

Definition at line 1410 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename CombineOp >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::combine ( bool  value,
bool  valueIsActive,
CombineOp &  op 
)
inline

Definition at line 1428 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename CombineOp , typename OtherType >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::combine2 ( const LeafNode< ValueMask, Log2Dim > &  other,
const OtherType &  value,
bool  valueIsActive,
CombineOp &  op 
)
inline

Definition at line 1448 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename CombineOp , typename OtherNodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::combine2 ( bool  value,
const OtherNodeT &  other,
bool  valueIsActive,
CombineOp &  op 
)
inline

Definition at line 1466 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename CombineOp , typename OtherNodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::combine2 ( const LeafNode< ValueMask, Log2Dim > &  b0,
const OtherNodeT &  b1,
CombineOp &  op 
)
inline

Definition at line 1484 of file LeafNodeMask.h.

template<Index Log2Dim>
Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::coordToOffset ( const Coord &  xyz)
inlinestatic

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

Definition at line 918 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename DenseT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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
bboxinclusive bounding box of the voxels to be copied into this node
densedense grid with a stride in z of one (see tools::Dense in tools/Dense.h for the required API)
backgroundbackground value of the tree that this node belongs to
tolerancetolerance 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.

Definition at line 1373 of file LeafNodeMask.h.

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

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

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

Definition at line 1348 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::denseFill ( const CoordBBox &  bbox,
bool  value,
bool  = false 
)
inline

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

Definition at line 294 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::dim ( )
inlinestatic

Return the number of voxels in each dimension.

Definition at line 102 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildAll ( ) const
inline

Definition at line 686 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildAllIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildAll ( )
inline

Definition at line 687 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildOff ( ) const
inline

Definition at line 683 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOffIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildOff ( )
inline

Definition at line 684 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildOn ( ) const
inline

Definition at line 680 of file LeafNodeMask.h.

template<Index Log2Dim>
ChildOnIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endChildOn ( )
inline

Definition at line 681 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueAll ( ) const
inline

Definition at line 664 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueAllIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueAll ( )
inline

Definition at line 665 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueOff ( ) const
inline

Definition at line 661 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOffIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueOff ( )
inline

Definition at line 662 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnCIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueOn ( ) const
inline

Definition at line 658 of file LeafNodeMask.h.

template<Index Log2Dim>
ValueOnIter openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::endValueOn ( )
inline

Definition at line 659 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 877 of file LeafNodeMask.h.

template<Index Log2Dim>
static void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::evalNodeOrigin ( Coord &  xyz)
inlinestaticprotected

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

Definition at line 709 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::fill ( const CoordBBox &  bbox,
bool  value,
bool  = false 
)
inline

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

Definition at line 1316 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::fill ( const bool &  value,
bool  dummy = false 
)
inline

Set the state of all voxels to the specified active state.

Definition at line 1336 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getChildDim ( )
inlinestatic

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

Definition at line 112 of file LeafNodeMask.h.

template<Index Log2Dim>
const bool& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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!

Definition at line 404 of file LeafNodeMask.h.

template<Index Log2Dim>
const bool& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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!

Definition at line 408 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getLevel ( )
inlinestatic

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

Definition at line 108 of file LeafNodeMask.h.

template<Index Log2Dim>
CoordBBox openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getNodeBoundingBox ( ) const
inline

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

Definition at line 153 of file LeafNodeMask.h.

template<Index Log2Dim>
static void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getNodeLog2Dims ( std::vector< Index > &  dims)
inlinestatic

Append the Log2Dim of this LeafNode to the specified vector.

Definition at line 110 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ArrayT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getNodes ( ArrayT &  ) const
inline

This function exists only to enable template instantiation.

Definition at line 520 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getOrigin ( Coord &  origin) const
inline

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

Definition at line 160 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getOrigin ( Int32 x,
Int32 y,
Int32 z 
) const
inline

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

Definition at line 161 of file LeafNodeMask.h.

template<Index Log2Dim>
const bool & openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValue ( const Coord &  xyz) const
inline

Return the value of the voxel at the given coordinates.

Definition at line 1104 of file LeafNodeMask.h.

template<Index Log2Dim>
const bool & openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValue ( Index  offset) const
inline

Return the value of the voxel at the given offset.

Definition at line 1113 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
const bool& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValueAndCache ( const Coord &  xyz,
AccessorT &   
) const
inline

Return the value of the voxel at the given coordinates.

Note
Used internally by ValueAccessor.

Definition at line 335 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValueLevel ( const Coord &  )
inlinestatic

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

Definition at line 228 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValueLevelAndCache ( const Coord &  ,
AccessorT &   
)
inlinestatic

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

Note
Used internally by ValueAccessor.

Definition at line 399 of file LeafNodeMask.h.

template<Index Log2Dim>
const NodeMaskType& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValueMask ( ) const
inline

Definition at line 696 of file LeafNodeMask.h.

template<Index Log2Dim>
NodeMaskType& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::getValueMask ( )
inline

Definition at line 698 of file LeafNodeMask.h.

template<Index Log2Dim>
static bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::hasActiveTiles ( )
inlinestatic

Return false since leaf nodes never contain tiles.

Definition at line 286 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename OtherType , Index OtherLog2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 895 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 136 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isChildMaskOff ( Index  ) const
inline

Definition at line 701 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isChildMaskOff ( ) const
inline

Definition at line 702 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isChildMaskOn ( Index  ) const
inline

Definition at line 700 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1032 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isDense ( ) const
inline

Return true if this node only contains active voxels.

Definition at line 132 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isEmpty ( ) const
inline

Return true if this node has no active voxels.

Definition at line 130 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isInactive ( ) const
inline

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

Definition at line 442 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueMaskOff ( Index  n) const
inline

Definition at line 694 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueMaskOff ( ) const
inline

Definition at line 695 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueMaskOn ( Index  n) const
inline

Definition at line 692 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueMaskOn ( ) const
inline

Definition at line 693 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueOn ( const Coord &  xyz) const
inline

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

Definition at line 281 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::isValueOn ( Index  offset) const
inline

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

Definition at line 283 of file LeafNodeMask.h.

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

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

Note
Used internally by ValueAccessor.

Definition at line 340 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index32 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::leafCount ( )
inlinestatic

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

Definition at line 114 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::log2dim ( )
inlinestatic

Return log2 of the size of the buffer storage.

Definition at line 100 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1045 of file LeafNodeMask.h.

template<Index Log2Dim>
Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::medianOff ( ValueType value) const
inline

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

Returns
The number of inactive voxels.
Parameters
valueUpdated with the median value of all the inactive voxels.
Note
Since the value and state are shared for this specialization of the LeafNode the value will always be false!

Definition at line 1062 of file LeafNodeMask.h.

template<Index Log2Dim>
Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::medianOn ( ValueType value) const
inline

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

Returns
The number of active voxels.
Parameters
valueUpdated with the median value of all the active voxels.
Note
Since the value and state are shared for this specialization of the LeafNode the value will always be true!

Definition at line 1053 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::memUsage ( ) const
inline

Return the memory in bytes occupied by this node.

Definition at line 859 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::memUsageIfLoaded ( ) const
inline

Definition at line 868 of file LeafNodeMask.h.

template<Index Log2Dim>
template<MergePolicy Policy>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::merge ( const LeafNode< ValueMask, Log2Dim > &  other,
bool  bg = false,
bool  otherBG = false 
)
inline

Definition at line 1219 of file LeafNodeMask.h.

template<Index Log2Dim>
template<MergePolicy Policy>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::merge ( bool  tileValue,
bool  tileActive = false 
)
inline

Definition at line 1230 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1184 of file LeafNodeMask.h.

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

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

Definition at line 1195 of file LeafNodeMask.h.

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

Apply a functor to the voxel at the given coordinates.

Definition at line 1204 of file LeafNodeMask.h.

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

Apply a functor to the voxel at the given coordinates.

Note
Used internally by ValueAccessor.

Definition at line 373 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ModifyOp , typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 365 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::negate ( )
inline

Invert the bits of the voxels, i.e. states and values.

Definition at line 449 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::nodeCount ( std::vector< Index32 > &  ) const
inline

no-op

Definition at line 116 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index32 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::nonLeafCount ( )
inlinestatic

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

Definition at line 118 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::numValues ( )
inlinestatic

Return the total number of voxels represented by this LeafNode.

Definition at line 106 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::offLeafVoxelCount ( ) const
inline

Definition at line 125 of file LeafNodeMask.h.

template<Index Log2Dim>
Coord openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::offsetToGlobalCoord ( Index  n) const
inline

Return the global coordinates for a linear table offset.

Definition at line 943 of file LeafNodeMask.h.

template<Index Log2Dim>
Coord openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::offsetToLocalCoord ( Index  n)
inlinestatic

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

Definition at line 929 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::offTileCount ( )
inlinestatic

Definition at line 127 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::offVoxelCount ( ) const
inline

Return the number of inactive voxels.

Definition at line 123 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::onLeafVoxelCount ( ) const
inline

Definition at line 124 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::onTileCount ( )
inlinestatic

Definition at line 126 of file LeafNodeMask.h.

template<Index Log2Dim>
Index64 openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::onVoxelCount ( ) const
inline

Return the number of active voxels.

Definition at line 121 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::operator!= ( const LeafNode< ValueMask, Log2Dim > &  other) const
inline

Definition at line 1021 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::operator== ( const LeafNode< ValueMask, Log2Dim > &  other) const
inline

Check for buffer equivalence by value.

Definition at line 1013 of file LeafNodeMask.h.

template<Index Log2Dim>
const Coord& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::origin ( ) const
inline

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

Definition at line 159 of file LeafNodeMask.h.

template<Index Log2Dim>
const LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeConstLeaf ( const Coord &  ) const
inline

Return a pointer to this node.

Definition at line 551 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
const LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeConstLeafAndCache ( const Coord &  ,
AccessorT &   
) const
inline

Return a pointer to this node.

Definition at line 553 of file LeafNodeMask.h.

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

This function exists only to enable template instantiation.

Definition at line 519 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename NodeT , typename AccessorT >
const NodeT* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeConstNodeAndCache ( const Coord &  ,
AccessorT &   
) const
inline

Return a pointer to this node.

Definition at line 555 of file LeafNodeMask.h.

template<Index Log2Dim>
LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeLeaf ( const Coord &  )
inline

Return a pointer to this node.

Definition at line 534 of file LeafNodeMask.h.

template<Index Log2Dim>
const LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeLeaf ( const Coord &  ) const
inline

Return a pointer to this node.

Definition at line 548 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeLeafAndCache ( const Coord &  ,
AccessorT &   
)
inline

Return a pointer to this node.

Definition at line 536 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
const LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeLeafAndCache ( const Coord &  ,
AccessorT &   
) const
inline

Return a pointer to this node.

Definition at line 550 of file LeafNodeMask.h.

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

This function exists only to enable template instantiation.

Definition at line 517 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename NodeT , typename AccessorT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeNodeAndCache ( const Coord &  ,
AccessorT &   
)
inline

Return a pointer to this node.

Definition at line 538 of file LeafNodeMask.h.

template<Index Log2Dim>
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::probeValue ( const Coord &  xyz,
bool &  val 
) const
inline

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

Parameters
xyzthe coordinates of the voxel to be probed
[out]valthe value of the voxel at the given coordinates

Definition at line 1123 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
bool openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 391 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::prune ( const ValueType = zeroVal<ValueType>())
inline

This function exists only to enable template instantiation.

Definition at line 510 of file LeafNodeMask.h.

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

Read in the topology and the origin.

Definition at line 988 of file LeafNodeMask.h.

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

Definition at line 970 of file LeafNodeMask.h.

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

Read in just the topology.

Definition at line 954 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::resetBackground ( bool  ,
bool   
)
inline

no-op since for this template specialization voxel values and states are indistinguishable.

Definition at line 446 of file LeafNodeMask.h.

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

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

Definition at line 1158 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setActiveState ( Index  offset,
bool  on 
)
inline

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

Definition at line 233 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 382 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setOrigin ( const Coord &  origin)
inline

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

Definition at line 156 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValue ( const Coord &  xyz,
bool  val 
)
inline

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

Definition at line 258 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 345 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueMask ( const NodeMaskType mask)
inline

Definition at line 699 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueMask ( Index  n,
bool  on 
)
inlineprotected

Definition at line 704 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueMaskOff ( Index  n)
inlineprotected

Definition at line 706 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueMaskOn ( Index  n)
inlineprotected

Definition at line 705 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOff ( const Coord &  xyz)
inline

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

Definition at line 241 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOff ( Index  offset)
inline

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

Definition at line 243 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOff ( const Coord &  xyz,
bool  val 
)
inline

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

Definition at line 1166 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOff ( Index  offset,
bool  val 
)
inline

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

Definition at line 1174 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 356 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOn ( const Coord &  xyz)
inline

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

Definition at line 251 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOn ( Index  offset)
inline

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

Definition at line 253 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOn ( const Coord &  xyz,
bool  val 
)
inline

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

Definition at line 1133 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOn ( Index  offset,
bool  val 
)
inline

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

Definition at line 1141 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOnly ( const Coord &  xyz,
bool  val 
)
inline

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

Definition at line 1150 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValueOnly ( Index  offset,
bool  val 
)
inline

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

Definition at line 238 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 351 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValuesOff ( )
inline

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

Definition at line 278 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::setValuesOn ( )
inline

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

Definition at line 276 of file LeafNodeMask.h.

template<Index Log2Dim>
static Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::size ( void  )
inlinestatic

Return the total number of voxels represented by this LeafNode.

Definition at line 104 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename NodeT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::stealNode ( const Coord &  ,
const ValueType ,
bool   
)
inline

This function exists only to enable template instantiation.

Definition at line 515 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename ArrayT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::stealNodes ( ArrayT &  ,
const ValueType ,
bool   
)
inline

This function exists only to enable template instantiation.

Definition at line 521 of file LeafNodeMask.h.

template<Index Log2Dim>
std::string openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::str ( ) const
inline

Return a string representation of this node.

Definition at line 904 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::swap ( Buffer other)
inline

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

Definition at line 196 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename OtherType >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1264 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename OtherType >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1254 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename OtherType >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::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.

Definition at line 1245 of file LeafNodeMask.h.

template<Index Log2Dim>
LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::touchLeaf ( const Coord &  )
inline

Return a pointer to this node.

Definition at line 531 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename AccessorT >
LeafNode* openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::touchLeafAndCache ( const Coord &  ,
AccessorT &   
)
inline

Return a pointer to this node.

Definition at line 533 of file LeafNodeMask.h.

template<Index Log2Dim>
const NodeMaskType& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::valueMask ( ) const
inline

Definition at line 697 of file LeafNodeMask.h.

template<Index Log2Dim>
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::voxelizeActiveTiles ( bool  = true)
inline

No-op.

This function exists only to enable template instantiation.

Definition at line 457 of file LeafNodeMask.h.

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

Write out the topology and the origin.

Definition at line 999 of file LeafNodeMask.h.

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

Write out just the topology.

Definition at line 962 of file LeafNodeMask.h.

Friends And Related Function Documentation

template<Index Log2Dim>
friend class IteratorBase< MaskDenseIter, LeafNode >
friend

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

Todo:
Make mask accessors public?

Definition at line 737 of file LeafNodeMask.h.

template<Index Log2Dim>
friend class IteratorBase< MaskOffIter, LeafNode >
friend

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

Todo:
Make mask accessors public?

Definition at line 736 of file LeafNodeMask.h.

template<Index Log2Dim>
friend class IteratorBase< MaskOnIter, LeafNode >
friend

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

Todo:
Make mask accessors public?

Definition at line 735 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename , Index >
friend class LeafBuffer
friend

Definition at line 740 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename , Index >
friend class LeafNode
friend

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

Definition at line 723 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskDenseIter, const LeafNode, bool >
friend

Definition at line 730 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskDenseIter, LeafNode, bool >
friend

Definition at line 727 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskOffIter, const LeafNode, bool >
friend

Definition at line 729 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskOffIter, LeafNode, bool >
friend

Definition at line 726 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskOnIter, const LeafNode, bool >
friend

Definition at line 728 of file LeafNodeMask.h.

template<Index Log2Dim>
friend struct ValueIter< MaskOnIter, LeafNode, bool >
friend

Definition at line 725 of file LeafNodeMask.h.

Member Data Documentation

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::DIM = 1 << TOTAL
static

Definition at line 43 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LEVEL = 0
static

Definition at line 47 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::LOG2DIM = Log2Dim
static

Definition at line 41 of file LeafNodeMask.h.

template<Index Log2Dim>
Buffer openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::mBuffer
protected

Bitmask representing the values AND state of voxels.

Definition at line 712 of file LeafNodeMask.h.

template<Index Log2Dim>
Coord openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::mOrigin
protected

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

Definition at line 714 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::NUM_VALUES = 1 << 3 * Log2Dim
static

Definition at line 44 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::NUM_VOXELS = NUM_VALUES
static

Definition at line 45 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::SIZE = NUM_VALUES
static

Definition at line 46 of file LeafNodeMask.h.

template<Index Log2Dim>
const Index openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::TOTAL = Log2Dim
static

Definition at line 42 of file LeafNodeMask.h.


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