HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::tree::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>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex >:

Public Member Functions

 ValueAccessor (TreeType &tree)
 
 ValueAccessor (const ValueAccessor &other)
 
virtual ~ValueAccessor ()
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor0< TreeType, IsSafe >
 ValueAccessor0 (TreeType &tree)
 
 ValueAccessor0 (const ValueAccessor0 &other)
 
ValueAccessor0operator= (const ValueAccessor0 &other)
 
virtual ~ValueAccessor0 ()
 
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 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...
 
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 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...
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active but don't change its value. More...
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive but don't change 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 &)
 
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...
 
template<typename NodeT >
void eraseNode ()
 
LeafNodeTtouchLeaf (const Coord &xyz)
 
template<typename NodeT >
NodeT * probeNode (const Coord &xyz)
 
template<typename NodeT >
const NodeT * probeConstNode (const Coord &xyz) const
 
LeafNodeTprobeLeaf (const Coord &xyz)
 
const LeafNodeTprobeConstLeaf (const Coord &xyz) const
 
const LeafNodeTprobeLeaf (const Coord &xyz) const
 
virtual void clear ()
 Remove all nodes from this cache, then reinsert the root node. 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...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< _TreeType, IsSafe >
 ValueAccessorBase (_TreeType &tree)
 
 ValueAccessorBase (const ValueAccessorBase &other)
 
virtual ~ValueAccessorBase ()
 
_TreeType * getTree () const
 Return a pointer to the tree associated with this accessor. More...
 
_TreeType & tree () const
 Return a reference to the tree associated with this accessor. More...
 
ValueAccessorBaseoperator= (const ValueAccessorBase &other)
 

Additional Inherited Members

- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor0< TreeType, IsSafe >
typedef _TreeType TreeType
 
typedef TreeType::ValueType ValueType
 
typedef TreeType::RootNodeType RootNodeT
 
typedef TreeType::LeafNodeType LeafNodeT
 
typedef ValueAccessorBase
< TreeType, IsSafe > 
BaseT
 
- Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor0< TreeType, IsSafe >
static Index numCacheLevels ()
 Return the number of cache levels employed by this accessor. More...
 
- Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< _TreeType, IsSafe >
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 inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< _TreeType, IsSafe >
static const bool IsConstTree
 
- Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< _TreeType, IsSafe >
_TreeType * mTree
 

Detailed Description

template<typename TreeType, bool IsSafe>
class openvdb::OPENVDB_VERSION_NAME::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.

Definition at line 489 of file ValueAccessor.h.

Constructor & Destructor Documentation

template<typename TreeType , bool IsSafe>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex >::ValueAccessor ( TreeType tree)
inline

Definition at line 493 of file ValueAccessor.h.

template<typename TreeType , bool IsSafe>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex >::ValueAccessor ( const ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex > &  other)
inline

Definition at line 494 of file ValueAccessor.h.

template<typename TreeType , bool IsSafe>
virtual openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor< TreeType, IsSafe, 0, tbb::null_mutex >::~ValueAccessor ( )
inlinevirtual

Definition at line 495 of file ValueAccessor.h.


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