HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 > Class Template Reference

Value accessor with two levels of node caching. More...

#include <ValueAccessor.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >:

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 >
 
using InvTreeT = typename RootNodeT::NodeChainType
 
using NodeT0 = typename hboost::mpl::at< InvTreeT, hboost::mpl::int_< L0 >>::type
 
using NodeT1 = typename hboost::mpl::at< InvTreeT, hboost::mpl::int_< L1 >>::type
 

Public Member Functions

 ValueAccessor2 (TreeType &tree)
 Constructor from a tree. More...
 
 ValueAccessor2 (const ValueAccessor2 &other)
 Copy constructor. More...
 
ValueAccessor2operator= (const ValueAccessor2 &other)
 Asignment operator. More...
 
 ~ValueAccessor2 () override=default
 Virtual destructor. More...
 
bool isCached (const Coord &xyz) const
 
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 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...
 
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 without changing its value. More...
 
void setValueOn (const Coord &xyz)
 Mark the voxel at the given coordinates as active without changing its value. More...
 
void setValueOff (const Coord &xyz)
 Mark the voxel at the given coordinates as inactive 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 &xyz, NodeT &node)
 
template<typename NodeT >
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. 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...
 
LeafNodeTtouchLeaf (const Coord &xyz)
 
template<typename NodeT >
NodeT * probeNode (const Coord &xyz)
 
LeafNodeTprobeLeaf (const Coord &xyz)
 
template<typename NodeT >
const NodeT * probeConstLeaf (const Coord &xyz) const
 
const LeafNodeTprobeConstLeaf (const Coord &xyz) const
 
const LeafNodeTprobeLeaf (const Coord &xyz) const
 
template<typename NodeT >
const NodeT * probeConstNode (const Coord &xyz) const
 
void clear () override
 Remove all the cached nodes and invalidate the corresponding hash-keys. 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)
 

Static Public Member Functions

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

Friends

template<typename >
class RootNode
 
template<typename , Index >
class InternalNode
 
template<typename , Index >
class LeafNode
 
template<typename >
class Tree
 

Additional Inherited Members

- 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 = true, Index L0 = 0, Index L1 = 1>
class openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >

Value accessor with two levels of node caching.

The node cache levels are specified by L0 and L1 with the default values 0 and 1 (defined in the forward declaration) corresponding to a LeafNode and its parent InternalNode.

Note
This class is for experts only and should rarely be used directly. Instead use ValueAccessor with its default template arguments.

Definition at line 92 of file ValueAccessor.h.

Member Typedef Documentation

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::BaseT = ValueAccessorBase<TreeType, IsSafe>

Definition at line 1638 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::InvTreeT = typename RootNodeT::NodeChainType

Definition at line 1639 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::LeafNodeT = typename TreeType::LeafNodeType

Definition at line 1637 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::NodeT0 = typename hboost::mpl::at<InvTreeT, hboost::mpl::int_<L0>>::type

Definition at line 1640 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::NodeT1 = typename hboost::mpl::at<InvTreeT, hboost::mpl::int_<L1>>::type

Definition at line 1641 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::RootNodeT = typename TreeType::RootNodeType

Definition at line 1636 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::TreeType = _TreeType

Definition at line 1634 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
using openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::ValueType = typename TreeType::ValueType

Definition at line 1635 of file ValueAccessor.h.

Constructor & Destructor Documentation

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::ValueAccessor2 ( TreeType tree)
inline

Constructor from a tree.

Definition at line 1644 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::ValueAccessor2 ( const ValueAccessor2< TreeType, IsSafe, L0, L1 > &  other)
inline

Copy constructor.

Definition at line 1649 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::~ValueAccessor2 ( )
overridedefault

Virtual destructor.

Member Function Documentation

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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.

Definition at line 1883 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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.

Definition at line 1896 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::clear ( void  )
inlineoverridevirtual

Remove all the cached nodes and invalidate the corresponding hash-keys.

Implements openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< _TreeType, IsSafe >.

Definition at line 2018 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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]

Definition at line 1875 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::getNode ( void  )
inline

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

Definition at line 1859 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
const ValueType& openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::getValue ( const Coord &  xyz) const
inline

Return the value of the voxel at the given coordinates.

Definition at line 1676 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
int openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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).

Definition at line 1720 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::insertNode ( const Coord &  xyz,
NodeT &  node 
)
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]

Definition at line 1869 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::isCached ( const Coord &  xyz) const
inline

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

Definition at line 1669 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::isValueOn ( const Coord &  xyz) const
inline

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

Definition at line 1690 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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.

Definition at line 1735 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::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.

Definition at line 1804 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::modifyValueAndActiveState ( const Coord &  xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

Definition at line 1822 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
static Index openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::numCacheLevels ( )
inlinestatic

Return the number of cache levels employed by this ValueAccessor.

Definition at line 1652 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
ValueAccessor2& openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::operator= ( const ValueAccessor2< TreeType, IsSafe, L0, L1 > &  other)
inline

Asignment operator.

Definition at line 1655 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
const NodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeConstLeaf ( const Coord &  xyz) const
inline
Returns
a const pointer to the node of the specified type that contains voxel (x, y, z) and if it doesn't exist, return nullptr.

Definition at line 1960 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
const LeafNodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeConstLeaf ( const Coord &  xyz) const
inline
Returns
a const pointer to the leaf node that contains voxel (x, y, z) and if it doesn't exist, return nullptr.

Definition at line 1984 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
const NodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeConstNode ( const Coord &  xyz) const
inline
Returns
a const pointer to the node of the specified type that contains voxel (x, y, z) and if it doesn't exist, return nullptr.

Definition at line 1993 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
LeafNodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeLeaf ( const Coord &  xyz)
inline
Returns
a pointer to the leaf node that contains voxel (x, y, z) and if it doesn't exist, return nullptr.

Definition at line 1955 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
const LeafNodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeLeaf ( const Coord &  xyz) const
inline

Definition at line 1988 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename NodeT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeNode ( const Coord &  xyz)
inline
Returns
a pointer to the node of the specified type that contains voxel (x, y, z) and if it doesn't exist, return nullptr.

Definition at line 1929 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::probeValue ( const Coord &  xyz,
ValueType value 
) const
inline

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

Definition at line 1704 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setActiveState ( const Coord &  xyz,
bool  on = true 
)
inline

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

Definition at line 1838 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValue ( const Coord &  xyz,
const ValueType value 
)
inline

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

Definition at line 1751 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValueOff ( const Coord &  xyz,
const ValueType value 
)
inline

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

Definition at line 1785 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValueOff ( const Coord &  xyz)
inline

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

Definition at line 1855 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValueOn ( const Coord &  xyz,
const ValueType value 
)
inline

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

Definition at line 1765 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValueOn ( const Coord &  xyz)
inline

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

Definition at line 1853 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::setValueOnly ( const Coord &  xyz,
const ValueType value 
)
inline

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

Definition at line 1769 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
LeafNodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor2< TreeType, IsSafe, L0, L1 >::touchLeaf ( const Coord &  xyz)
inline
Returns
the leaf node that contains voxel (x, y, z) and if it doesn't exist, create it, 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.

Definition at line 1913 of file ValueAccessor.h.

Friends And Related Function Documentation

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename , Index >
friend class InternalNode
friend

Definition at line 2029 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename , Index >
friend class LeafNode
friend

Definition at line 2030 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename >
friend class RootNode
friend

Definition at line 2028 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0, Index L1 = 1>
template<typename >
friend class Tree
friend

Definition at line 2032 of file ValueAccessor.h.


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