OpenVDB  1.1.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
ValueAccessor< TreeType, 0, tbb::null_mutex > Struct Template Reference

#include <ValueAccessor.h>

Inherits ValueAccessor0< TreeType >.

Public Types

typedef _TreeType TreeType
 
typedef TreeType::ValueType ValueType
 
typedef TreeType::RootNodeType RootNodeT
 
typedef TreeType::LeafNodeType LeafNodeT
 
typedef ValueAccessorBase
< TreeType
BaseT
 

Public Member Functions

 ValueAccessor (TreeType &tree)
 
 ValueAccessor (const ValueAccessor &other)
 
virtual ~ValueAccessor ()
 
bool isCached (const Coord &) const
 Return true if nodes along the path to the given voxel have been cached. More...
 
const ValueTypegetValue (const Coord &xyz) const
 Return the value of the voxel at the given coordinates. More...
 
bool isValueOn (const Coord &xyz) const
 Return the active state of the voxel at the given coordinates. More...
 
bool probeValue (const Coord &xyz, ValueType &value) const
 Return the active state of the voxel as well as its value. More...
 
int getValueDepth (const Coord &xyz) const
 
bool isVoxel (const Coord &xyz) const
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active without changing its value. More...
 
void setValueOnly (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinate but preserves its active state. More...
 
void setValueOff (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as inactive. More...
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive without changing its value. More...
 
void setValueOnSum (const Coord &xyz, const ValueType &value)
 
void setActiveState (const Coord &xyz, bool on=true)
 Set the active state of the voxel at the given coordinates without changing its value. More...
 
template<typename NodeT >
NodeT * getNode ()
 Return the cached node of type NodeType. [Mainly for internal use]. More...
 
template<typename NodeT >
void insertNode (const Coord &, NodeT &)
 
template<typename NodeT >
void eraseNode ()
 
LeafNodeTtouchLeaf (const Coord &xyz)
 
LeafNodeTprobeLeaf (const Coord &xyz)
 
const LeafNodeTprobeConstLeaf (const Coord &xyz)
 
virtual void clear ()
 Remove all nodes from this cache, then reinsert the root node. More...
 
_TreeType * getTree () const
 
void setValue (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as active. More...
 
void setValueOn (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as active. More...
 

Static Public Member Functions

static Index numCacheLevels ()
 Return the number of cache levels employed by this ValueAccessor. More...
 

Static Public Attributes

static const bool IsConstTree
 

Protected Attributes

_TreeType * mTree
 

Detailed Description

template<typename TreeType>
struct openvdb::v1_1_0::tree::ValueAccessor< TreeType, 0, tbb::null_mutex >

Template specialization of the ValueAccessor with no mutex and no cache levels

Note
This specialization is mosty useful for benchmark comparisions since the cached versions (above) are always expected to be faster.

Member Typedef Documentation

typedef ValueAccessorBase<TreeType> BaseT
inherited
typedef TreeType::LeafNodeType LeafNodeT
inherited
typedef TreeType::RootNodeType RootNodeT
inherited
typedef _TreeType TreeType
inherited
typedef TreeType::ValueType ValueType
inherited

Constructor & Destructor Documentation

ValueAccessor ( TreeType tree)
inline
ValueAccessor ( const ValueAccessor< TreeType, 0, tbb::null_mutex > &  other)
inline
virtual ~ValueAccessor ( )
inlinevirtual

Member Function Documentation

virtual void clear ( )
inlinevirtualinherited

Remove all nodes from this cache, then reinsert the root node.

Implements ValueAccessorBase< _TreeType >.

void eraseNode ( )
inlineinherited

If a node of the given type exists in the cache, remove it, so that isCached(xyz) returns false for any voxel (x, y, z) contained in that node. [Mainly for internal use]

NodeT* getNode ( )
inlineinherited

Return the cached node of type NodeType. [Mainly for internal use].

_TreeType * getTree ( ) const
inlineinherited
Returns
a pointer to the tree associated by this ValueAccessor
const ValueType& getValue ( const Coord xyz) const
inlineinherited

Return the value of the voxel at the given coordinates.

int getValueDepth ( const Coord xyz) const
inlineinherited

Return the tree depth (0 = root) at which the value of voxel (x, y, z) resides, or -1 if (x, y, z) isn't explicitly represented in the tree (i.e., if it is implicitly a background voxel).

void insertNode ( const Coord ,
NodeT &   
)
inlineinherited

Cache the given node, which should lie along the path from the root node to the node containing voxel (x, y, z). [Mainly for internal use]

bool isCached ( const Coord ) const
inlineinherited

Return true if nodes along the path to the given voxel have been cached.

bool isValueOn ( const Coord xyz) const
inlineinherited

Return the active state of the voxel at the given coordinates.

bool isVoxel ( const Coord xyz) const
inlineinherited

Return true if the value of voxel (x, y, z) resides at the leaf level of the tree, i.e., if it is not a tile value.

static Index numCacheLevels ( )
inlinestaticinherited

Return the number of cache levels employed by this ValueAccessor.

const LeafNodeT* probeConstLeaf ( const Coord xyz)
inlineinherited
LeafNodeT* probeLeaf ( const Coord xyz)
inlineinherited
bool probeValue ( const Coord xyz,
ValueType value 
) const
inlineinherited

Return the active state of the voxel as well as its value.

void setActiveState ( const Coord xyz,
bool  on = true 
)
inlineinherited

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

void setValue ( const Coord xyz,
const ValueType value 
)
inlineinherited

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

void setValueOff ( const Coord xyz,
const ValueType value 
)
inlineinherited

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

void setValueOff ( const Coord xyz)
inlineinherited

Mark the voxel at the given coordinates as inactive without changing its value.

void setValueOn ( const Coord xyz,
const ValueType value 
)
inlineinherited

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

void setValueOn ( const Coord xyz)
inlineinherited

Mark the voxel at the given coordinates as active without changing its value.

void setValueOnly ( const Coord xyz,
const ValueType value 
)
inlineinherited

Set the value of the voxel at the given coordinate but preserves its active state.

void setValueOnSum ( const Coord xyz,
const ValueType value 
)
inlineinherited

Set the value of the voxel at the given coordinates to the sum of its current value and the given value, and mark the voxel as active.

LeafNodeT* touchLeaf ( const Coord xyz)
inlineinherited

Member Data Documentation

const bool IsConstTree
staticinherited
_TreeType * mTree
protectedinherited

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