OpenVDB 10.0.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
ValueAccessorRW< TreeType, IsSafe > Class Template Reference

This accessor is thread-safe (at the cost of speed) for both reading and writing to a tree. That is, multiple threads may safely access a single, shared ValueAccessorRW. More...

#include <openvdb/tree/ValueAccessor.h>

Inheritance diagram for ValueAccessorRW< TreeType, IsSafe >:
ValueAccessor< _TreeType, IsSafe, CacheLevels, MutexType > ValueAccessorBase< TreeType, IsSafe >

Public Types

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

Public Member Functions

 ValueAccessorRW (TreeType &tree)
 
bool isCached (const Coord &xyz) const
 Return true if nodes along the path to the given voxel have been cached.
 
const ValueTypegetValue (const Coord &xyz) const
 Return the value of the voxel at the given coordinates.
 
bool isValueOn (const Coord &xyz) const
 Return the active state of the voxel at the given coordinates.
 
bool probeValue (const Coord &xyz, ValueType &value) const
 Return the active state of the voxel as well as its value.
 
int getValueDepth (const Coord &xyz) const
 
bool isVoxel (const Coord &xyz) 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.
 
void setValueOn (const Coord &xyz, const ValueType &value)
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active but don't change its value.
 
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.
 
void setValueOff (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as inactive.
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive but don't change its value.
 
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.
 
template<typename ModifyOp >
void modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the voxel at the given coordinates.
 
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.
 
template<typename NodeType >
NodeType * getNode ()
 Return the cached node of type NodeType. [Mainly for internal use].
 
template<typename NodeType >
void insertNode (const Coord &xyz, NodeType &node)
 
template<typename NodeType >
void eraseNode ()
 
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.
 
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.
 
LeafNodeTtouchLeaf (const Coord &xyz)
 Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels.
 
template<typename NodeT >
NodeT * probeNode (const Coord &xyz)
 Return a pointer to the node of the specified type that contains voxel (x, y, z), or nullptr if no such node exists.
 
template<typename NodeT >
const NodeT * probeNode (const Coord &xyz) const
 
template<typename NodeT >
const NodeT * probeConstNode (const Coord &xyz) const
 
LeafNodeTprobeLeaf (const Coord &xyz)
 Return a pointer to the leaf node that contains voxel (x, y, z), or nullptr if no such node exists.
 
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.
 
TreeTypegetTree () const
 Return a pointer to the tree associated with this accessor.
 
TreeTypetree () const
 Return a reference to the tree associated with this accessor.
 

Static Public Member Functions

static Index numCacheLevels ()
 Return the number of cache levels employed by this accessor.
 
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).
 

Static Public Attributes

static constexpr bool BypassLeafAPI
 
static const bool IsConstTree
 

Protected Attributes

TreeTypemTree
 

Detailed Description

template<typename TreeType, bool IsSafe = true>
class openvdb::v10_0::tree::ValueAccessorRW< TreeType, IsSafe >

This accessor is thread-safe (at the cost of speed) for both reading and writing to a tree. That is, multiple threads may safely access a single, shared ValueAccessorRW.

Warning
Since the mutex-locking employed by the ValueAccessorRW can seriously impair performance of multithreaded applications, it is recommended that, instead, each thread be assigned its own (non-mutex protected) accessor.

Member Typedef Documentation

◆ BaseT

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using BaseT = ValueAccessorBase<TreeType, IsSafe>
inherited

◆ LeafNodeT

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using LeafNodeT = typename TreeType::LeafNodeType
inherited

◆ LockT

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using LockT = typename MutexType::scoped_lock
inherited

◆ RootNodeT

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using RootNodeT = typename TreeType::RootNodeType
inherited

◆ TreeType

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using TreeType = _TreeType
inherited

◆ ValueType

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
using ValueType = typename RootNodeT::ValueType
inherited

Constructor & Destructor Documentation

◆ ValueAccessorRW()

template<typename TreeType , bool IsSafe = true>
ValueAccessorRW ( TreeType tree)
inline

Member Function Documentation

◆ addLeaf()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ addTile()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ clear()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
void clear ( )
inlineoverridevirtualinherited

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

Implements ValueAccessorBase< TreeType, IsSafe >.

◆ eraseNode()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeType >
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]

◆ getNode()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeType >
NodeType * getNode ( )
inlineinherited

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

◆ getTree()

template<typename TreeType , bool IsSafe>
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).

◆ getValue()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
const ValueType & getValue ( const Coord xyz) const
inlineinherited

Return the value of the voxel at the given coordinates.

◆ getValueDepth()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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).

◆ insertNode()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeType >
void insertNode ( const Coord xyz,
NodeType &  node 
)
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]

◆ isCached()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
bool isCached ( const Coord xyz) const
inlineinherited

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

◆ isSafe()

template<typename TreeType , bool IsSafe>
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).

◆ isValueOn()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
bool isValueOn ( const Coord xyz) const
inlineinherited

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

◆ isVoxel()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ modifyValue()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename ModifyOp >
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.

◆ modifyValueAndActiveState()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename ModifyOp >
void modifyValueAndActiveState ( const Coord xyz,
const ModifyOp &  op 
)
inlineinherited

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

◆ numCacheLevels()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
static Index numCacheLevels ( )
inlinestaticinherited

Return the number of cache levels employed by this accessor.

◆ probeConstLeaf()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
const LeafNodeT * probeConstLeaf ( const Coord xyz) const
inlineinherited

◆ probeConstNode()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeT >
const NodeT * probeConstNode ( const Coord xyz) const
inlineinherited

◆ probeLeaf() [1/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
LeafNodeT * probeLeaf ( const Coord xyz)
inlineinherited

Return a pointer to the leaf node that contains voxel (x, y, z), or nullptr if no such node exists.

◆ probeLeaf() [2/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
const LeafNodeT * probeLeaf ( const Coord xyz) const
inlineinherited

◆ probeNode() [1/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeT >
NodeT * probeNode ( const Coord xyz)
inlineinherited

Return a pointer to the node of the specified type that contains voxel (x, y, z), or nullptr if no such node exists.

◆ probeNode() [2/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
template<typename NodeT >
const NodeT * probeNode ( const Coord xyz) const
inlineinherited

◆ probeValue()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
bool probeValue ( const Coord xyz,
ValueType value 
) const
inlineinherited

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

◆ setActiveState()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ setValue()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ setValueOff() [1/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
void setValueOff ( const Coord xyz)
inlineinherited

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

◆ setValueOff() [2/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ setValueOn() [1/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
void setValueOn ( const Coord xyz)
inlineinherited

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

◆ setValueOn() [2/2]

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
void setValueOn ( const Coord xyz,
const ValueType value 
)
inlineinherited

◆ setValueOnly()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
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.

◆ touchLeaf()

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
LeafNodeT * touchLeaf ( const Coord xyz)
inlineinherited

Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels.

Use this method to preallocate a static tree topology over which to safely perform multithreaded processing.

◆ tree()

template<typename TreeType , bool IsSafe>
TreeType & tree ( ) const
inlineinherited

Return a reference to the tree associated with this accessor.

Member Data Documentation

◆ BypassLeafAPI

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
constexpr bool BypassLeafAPI
staticconstexprinherited
Initial value:
= CacheLevels >= 1 &&
std::is_same<typename LeafNodeT::Buffer::StorageType

◆ IsConstTree

template<typename _TreeType , bool IsSafe = true, Index CacheLevels = _TreeType::DEPTH-1, typename MutexType = tbb::null_mutex>
const bool IsConstTree
staticinherited

◆ mTree

template<typename TreeType , bool IsSafe>
TreeType* mTree
protectedinherited