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

ValueAccessor with no mutex and no node caching. More...

#include <openvdb/tree/ValueAccessor.h>

Inheritance diagram for ValueAccessor0< _TreeType, IsSafe >:
ValueAccessorBase< _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

 ValueAccessor0 (TreeType &tree)
 
 ValueAccessor0 (const ValueAccessor0 &other)
 
ValueAccessor0operator= (const ValueAccessor0 &other)
 
 ~ValueAccessor0 () override=default
 
bool isCached (const Coord &) 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 and, in value, the value of the voxel at the given coordinates.
 
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 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.
 
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.
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active but don't change its value.
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive but don't change its value.
 
template<typename NodeT >
NodeT * getNode ()
 Return the cached node of type NodeType. [Mainly for internal use].
 
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.
 
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.
 
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
 
void clear () override
 Remove all nodes from this cache, then reinsert the root node.
 
_TreeType * getTree () const
 Return a pointer to the tree associated with this accessor.
 
_TreeType & tree () 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 = false
 
static const bool IsConstTree
 

Protected Attributes

_TreeType * mTree
 

Friends

template<typename >
class Tree
 

Detailed Description

template<typename _TreeType, bool IsSafe>
class openvdb::v10_0::tree::ValueAccessor0< _TreeType, IsSafe >

ValueAccessor with no mutex and no node caching.

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

Member Typedef Documentation

◆ BaseT

template<typename _TreeType , bool IsSafe>
using BaseT = ValueAccessorBase<TreeType, IsSafe>

◆ LeafNodeT

template<typename _TreeType , bool IsSafe>
using LeafNodeT = typename TreeType::LeafNodeType

◆ RootNodeT

template<typename _TreeType , bool IsSafe>
using RootNodeT = typename TreeType::RootNodeType

◆ TreeType

template<typename _TreeType , bool IsSafe>
using TreeType = _TreeType

◆ ValueType

template<typename _TreeType , bool IsSafe>
using ValueType = typename TreeType::ValueType

Constructor & Destructor Documentation

◆ ValueAccessor0() [1/2]

template<typename _TreeType , bool IsSafe>
ValueAccessor0 ( TreeType tree)
inline

◆ ValueAccessor0() [2/2]

template<typename _TreeType , bool IsSafe>
ValueAccessor0 ( const ValueAccessor0< _TreeType, IsSafe > &  other)
inline

◆ ~ValueAccessor0()

template<typename _TreeType , bool IsSafe>
~ValueAccessor0 ( )
overridedefault

Member Function Documentation

◆ addLeaf()

template<typename _TreeType , bool IsSafe>
void addLeaf ( LeafNodeT leaf)
inline

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>
void addTile ( Index  level,
const Coord xyz,
const ValueType value,
bool  state 
)
inline

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>
void clear ( )
inlineoverridevirtual

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

Implements ValueAccessorBase< _TreeType, IsSafe >.

◆ eraseNode()

template<typename _TreeType , bool IsSafe>
template<typename NodeT >
void eraseNode ( )
inline

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>
template<typename NodeT >
NodeT * getNode ( )
inline

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

◆ getTree()

_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>
const ValueType & getValue ( const Coord xyz) const
inline

Return the value of the voxel at the given coordinates.

◆ getValueDepth()

template<typename _TreeType , bool IsSafe>
int getValueDepth ( const Coord xyz) const
inline

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>
template<typename NodeT >
void insertNode ( const Coord ,
NodeT &   
)
inline

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>
bool isCached ( const Coord ) const
inline

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

◆ 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>
bool isValueOn ( const Coord xyz) const
inline

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

◆ isVoxel()

template<typename _TreeType , bool IsSafe>
bool isVoxel ( const Coord xyz) const
inline

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>
template<typename ModifyOp >
void 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.

See Tree::modifyValue() for details.

◆ modifyValueAndActiveState()

template<typename _TreeType , bool IsSafe>
template<typename ModifyOp >
void modifyValueAndActiveState ( const Coord xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

◆ numCacheLevels()

template<typename _TreeType , bool IsSafe>
static Index numCacheLevels ( )
inlinestatic

Return the number of cache levels employed by this accessor.

◆ operator=()

template<typename _TreeType , bool IsSafe>
ValueAccessor0 & operator= ( const ValueAccessor0< _TreeType, IsSafe > &  other)
inline

◆ probeConstLeaf()

template<typename _TreeType , bool IsSafe>
const LeafNodeT * probeConstLeaf ( const Coord xyz) const
inline

◆ probeConstNode()

template<typename _TreeType , bool IsSafe>
template<typename NodeT >
const NodeT * probeConstNode ( const Coord xyz) const
inline

◆ probeLeaf() [1/2]

template<typename _TreeType , bool IsSafe>
LeafNodeT * probeLeaf ( const Coord xyz)
inline

◆ probeLeaf() [2/2]

template<typename _TreeType , bool IsSafe>
const LeafNodeT * probeLeaf ( const Coord xyz) const
inline

◆ probeNode()

template<typename _TreeType , bool IsSafe>
template<typename NodeT >
NodeT * probeNode ( const Coord xyz)
inline

◆ probeValue()

template<typename _TreeType , bool IsSafe>
bool probeValue ( const Coord xyz,
ValueType value 
) const
inline

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

◆ setActiveState()

template<typename _TreeType , bool IsSafe>
void setActiveState ( const Coord xyz,
bool  on = true 
)
inline

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

◆ setValue()

template<typename _TreeType , bool IsSafe>
void setValue ( const Coord xyz,
const ValueType value 
)
inline

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

◆ setValueOff() [1/2]

template<typename _TreeType , bool IsSafe>
void setValueOff ( const Coord xyz)
inline

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

◆ setValueOff() [2/2]

template<typename _TreeType , bool IsSafe>
void setValueOff ( const Coord xyz,
const ValueType value 
)
inline

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

◆ setValueOn() [1/2]

template<typename _TreeType , bool IsSafe>
void setValueOn ( const Coord xyz)
inline

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

◆ setValueOn() [2/2]

template<typename _TreeType , bool IsSafe>
void setValueOn ( const Coord xyz,
const ValueType value 
)
inline

◆ setValueOnly()

template<typename _TreeType , bool IsSafe>
void setValueOnly ( const Coord xyz,
const ValueType value 
)
inline

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

◆ touchLeaf()

template<typename _TreeType , bool IsSafe>
LeafNodeT * touchLeaf ( const Coord xyz)
inline

◆ tree()

_TreeType & tree ( ) const
inlineinherited

Return a reference to the tree associated with this accessor.

Friends And Related Symbol Documentation

◆ Tree

template<typename _TreeType , bool IsSafe>
template<typename >
friend class Tree
friend

Member Data Documentation

◆ BypassLeafAPI

template<typename _TreeType , bool IsSafe>
constexpr bool BypassLeafAPI = false
staticconstexpr

◆ IsConstTree

const bool IsConstTree
staticinherited

◆ mTree

_TreeType * mTree
protectedinherited