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

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

#include <ValueAccessor.h>

Inherits ValueAccessor0< TreeType, IsSafe >.

Public Types

using TreeType = TreeType
 
using ValueType = typename TreeType::ValueType
 
using RootNodeT = typename TreeType::RootNodeType
 
using LeafNodeT = typename TreeType::LeafNodeType
 
using BaseT = ValueAccessorBase< TreeType, IsSafe >
 

Public Member Functions

 ValueAccessor (TreeType &tree)
 
 ValueAccessor (const ValueAccessor &other)
 
 ~ValueAccessor () override=default
 
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 and, in value, the value of the voxel at the given coordinates. 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 but don't change its value. More...
 
void setValueOnly (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinate but don't change 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 but don't change its value. More...
 
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...
 
void modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the voxel at the given coordinates. More...
 
void setActiveState (const Coord &xyz, bool on=true)
 Set the active state of the voxel at the given coordinates but don't change its value. More...
 
NodeT * getNode ()
 Return the cached node of type NodeType. [Mainly for internal use]. More...
 
void insertNode (const Coord &, NodeT &)
 
void addLeaf (LeafNodeT *leaf)
 Add the specified leaf to this tree, possibly creating a child branch in the process. If the leaf node already exists, replace it. More...
 
void addTile (Index level, const Coord &xyz, const ValueType &value, bool state)
 Add a tile at the specified tree level that contains voxel (x, y, z), possibly deleting existing nodes or creating new nodes in the process. More...
 
void eraseNode ()
 
LeafNodeTtouchLeaf (const Coord &xyz)
 
NodeT * probeNode (const Coord &xyz)
 
const NodeT * probeConstNode (const Coord &xyz) const
 
LeafNodeTprobeLeaf (const Coord &xyz)
 
const LeafNodeTprobeLeaf (const Coord &xyz) const
 
const LeafNodeTprobeConstLeaf (const Coord &xyz) const
 
void clear () override
 Remove all nodes from this cache, then reinsert the root node. More...
 
TreeTypegetTree () const
 Return a pointer to the tree associated with this accessor. More...
 
TreeTypetree () const
 Return a reference to the tree associated with this accessor. More...
 
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 accessor. More...
 
static bool isSafe ()
 Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default). More...
 

Static Public Attributes

static const bool IsConstTree = std::is_const<TreeType>::value
 

Protected Attributes

TreeTypemTree
 

Detailed Description

template<typename TreeType, bool IsSafe>
class openvdb::v8_1::tree::ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex >

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

This specialization is provided mainly for benchmarking. Accessors with caching will almost always be faster.

Member Typedef Documentation

using BaseT = ValueAccessorBase<TreeType, IsSafe>
inherited
using LeafNodeT = typename TreeType::LeafNodeType
inherited
using RootNodeT = typename TreeType::RootNodeType
inherited
using TreeType = TreeType
inherited
using ValueType = typename TreeType::ValueType
inherited

Constructor & Destructor Documentation

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

Member Function Documentation

void addLeaf ( LeafNodeT leaf)
inlineinherited

Add the specified leaf to this tree, possibly creating a child branch in the process. If the leaf node already exists, replace it.

void addTile ( Index  level,
const Coord &  xyz,
const ValueType value,
bool  state 
)
inlineinherited

Add a tile at the specified tree level that contains voxel (x, y, z), possibly deleting existing nodes or creating new nodes in the process.

void clear ( )
inlineoverridevirtualinherited

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

Implements ValueAccessorBase< TreeType, IsSafe >.

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

Return a pointer to the tree associated with this accessor.

The pointer will be null only if the tree from which this accessor was constructed was subsequently deleted (which generally leaves the accessor in an unsafe state).

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.

static bool isSafe ( )
inlinestaticinherited

Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default).

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.

void modifyValue ( const Coord &  xyz,
const ModifyOp &  op 
)
inlineinherited

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

See Tree::modifyValue() for details.

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

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

static Index numCacheLevels ( )
inlinestaticinherited

Return the number of cache levels employed by this accessor.

const LeafNodeT* probeConstLeaf ( const Coord &  xyz) const
inlineinherited
const NodeT* probeConstNode ( const Coord &  xyz) const
inlineinherited
LeafNodeT* probeLeaf ( const Coord &  xyz)
inlineinherited
const LeafNodeT* probeLeaf ( const Coord &  xyz) const
inlineinherited
NodeT* probeNode ( const Coord &  xyz)
inlineinherited
bool probeValue ( const Coord &  xyz,
ValueType value 
) const
inlineinherited

Return the active state and, in value, the value of the voxel at the given coordinates.

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

Set the active state of the voxel at the given coordinates but don't change 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 but don't change 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 but don't change its value.

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

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

LeafNodeT* touchLeaf ( const Coord &  xyz)
inlineinherited
TreeType& tree ( ) const
inlineinherited

Return a reference to the tree associated with this accessor.

Member Data Documentation

const bool IsConstTree = std::is_const<TreeType>::value
staticinherited
TreeType* mTree
protectedinherited

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