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

Value accessor with one level of node caching. More...

#include <ValueAccessor.h>

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

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
 

Public Member Functions

 ValueAccessor1 (TreeType &tree)
 Constructor from a tree. More...
 
 ValueAccessor1 (const ValueAccessor1 &other)
 Copy constructor. More...
 
ValueAccessor1operator= (const ValueAccessor1 &other)
 Asignment operator. More...
 
 ~ValueAccessor1 () 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 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 &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 * probeConstNode (const Coord &xyz) const
 
const LeafNodeTprobeConstLeaf (const Coord &xyz) const
 
const LeafNodeTprobeLeaf (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>
class openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >

Value accessor with one level of node caching.

The node cache level is specified by L0 with the default value 0 (defined in the forward declaration) corresponding to a LeafNode.

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

Definition at line 90 of file ValueAccessor.h.

Member Typedef Documentation

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

Definition at line 1270 of file ValueAccessor.h.

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

Definition at line 1271 of file ValueAccessor.h.

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

Definition at line 1269 of file ValueAccessor.h.

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

Definition at line 1272 of file ValueAccessor.h.

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

Definition at line 1268 of file ValueAccessor.h.

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

Definition at line 1266 of file ValueAccessor.h.

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

Definition at line 1267 of file ValueAccessor.h.

Constructor & Destructor Documentation

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

Constructor from a tree.

Definition at line 1275 of file ValueAccessor.h.

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

Copy constructor.

Definition at line 1280 of file ValueAccessor.h.

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

Virtual destructor.

Member Function Documentation

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1481 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1490 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1561 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
template<typename NodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1473 of file ValueAccessor.h.

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

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

Definition at line 1457 of file ValueAccessor.h.

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

Return the value of the voxel at the given coordinates.

Definition at line 1307 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
int openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1342 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
template<typename NodeT >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1467 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1300 of file ValueAccessor.h.

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

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

Definition at line 1318 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1354 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1411 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1426 of file ValueAccessor.h.

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

Return the number of cache levels employed by this ValueAccessor.

Definition at line 1283 of file ValueAccessor.h.

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

Asignment operator.

Definition at line 1286 of file ValueAccessor.h.

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

Definition at line 1554 of file ValueAccessor.h.

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

Definition at line 1540 of file ValueAccessor.h.

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

Definition at line 1532 of file ValueAccessor.h.

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

Definition at line 1558 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
template<typename NodeT >
NodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1517 of file ValueAccessor.h.

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

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

Definition at line 1329 of file ValueAccessor.h.

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

Definition at line 1439 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1367 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1395 of file ValueAccessor.h.

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

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

Definition at line 1453 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1378 of file ValueAccessor.h.

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

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

Definition at line 1451 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
void openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1382 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe = true, Index L0 = 0>
LeafNodeT* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessor1< TreeType, IsSafe, L0 >::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 1503 of file ValueAccessor.h.

Friends And Related Function Documentation

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

Definition at line 1570 of file ValueAccessor.h.

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

Definition at line 1571 of file ValueAccessor.h.

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

Definition at line 1569 of file ValueAccessor.h.

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

Definition at line 1573 of file ValueAccessor.h.


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