OpenVDB  5.2.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
NodeIteratorBase< _TreeT, RootChildOnIterT > Class Template Reference

Base class for tree-traversal iterators over all nodes. More...

#include <TreeIterator.h>

Public Types

using TreeT = _TreeT
 
using RootIterT = RootChildOnIterT
 
using RootNodeT = typename RootIterT::NodeType
 
using NCRootNodeT = typename RootIterT::NonConstNodeType
 
using InvTreeT = typename iter::InvertedTree< NCRootNodeT, ROOT_LEVEL >::Type
 
using RootIterTraits = IterTraits< NCRootNodeT, RootIterT >
 

Public Member Functions

 NodeIteratorBase ()
 
 NodeIteratorBase (TreeT &)
 
 NodeIteratorBase (const NodeIteratorBase &other)
 
NodeIteratorBaseoperator= (const NodeIteratorBase &other)
 
void setMinDepth (Index minDepth)
 Specify the depth of the highest level of the tree to which to ascend (depth 0 = root). More...
 
Index getMinDepth () const
 Return the depth of the highest level of the tree to which this iterator ascends. More...
 
void setMaxDepth (Index maxDepth)
 Specify the depth of the lowest level of the tree to which to descend (depth 0 = root). More...
 
Index getMaxDepth () const
 Return the depth of the lowest level of the tree to which this iterator ascends. More...
 
bool next ()
 Advance to the next tile or voxel value. More...
 
void increment ()
 Advance the iterator to the next leaf node. More...
 
NodeIteratorBaseoperator++ ()
 
void increment (Index n)
 Increment the iterator n times. More...
 
Index getLevel () const
 Return the level in the tree (0 = leaf) of the node to which this iterator is currently pointing. More...
 
Index getDepth () const
 Return the depth in the tree (0 = root) of the node to which this iterator is currently pointing. More...
 
Coord getCoord () const
 Return the global coordinates of the voxel or tile to which this iterator is currently pointing. More...
 
bool getBoundingBox (CoordBBox &bbox) const
 Return in bbox the axis-aligned bounding box of the voxel or tile to which this iterator is currently pointing. More...
 
CoordBBox getBoundingBox () const
 Return the axis-aligned bounding box of the voxel or tile to which this iterator is currently pointing. More...
 
TreeTgetTree () const
 
std::string summary () const
 
bool test () const
 Return true if this iterator is not yet exhausted. More...
 
 operator bool () const
 Return true if this iterator is not yet exhausted. More...
 
template<typename NodeT >
void getNode (NodeT *&node) const
 Return the node to which the iterator is pointing. More...
 
template<typename NodeT >
void getNode (const NodeT *&node) const
 Return the node to which the iterator is pointing. More...
 

Static Public Member Functions

static Index getLeafDepth ()
 

Static Public Attributes

static const Index ROOT_LEVEL = RootNodeT::LEVEL
 
static const Index LEAF_LEVEL = 0
 
static const Index ROOT_DEPTH = 0
 
static const Index LEAF_DEPTH = ROOT_LEVEL
 

Detailed Description

template<typename _TreeT, typename RootChildOnIterT>
class openvdb::v5_2::tree::NodeIteratorBase< _TreeT, RootChildOnIterT >

Base class for tree-traversal iterators over all nodes.

Member Typedef Documentation

using NCRootNodeT = typename RootIterT::NonConstNodeType
using RootIterT = RootChildOnIterT
using RootNodeT = typename RootIterT::NodeType
using TreeT = _TreeT

Constructor & Destructor Documentation

NodeIteratorBase ( )
inline
NodeIteratorBase ( TreeT tree)
inline
NodeIteratorBase ( const NodeIteratorBase< _TreeT, RootChildOnIterT > &  other)
inline

Member Function Documentation

bool getBoundingBox ( CoordBBox &  bbox) const
inline

Return in bbox the axis-aligned bounding box of the voxel or tile to which this iterator is currently pointing.

Returns
false if the bounding box is empty.
CoordBBox getBoundingBox ( ) const
inline

Return the axis-aligned bounding box of the voxel or tile to which this iterator is currently pointing.

Coord getCoord ( ) const
inline

Return the global coordinates of the voxel or tile to which this iterator is currently pointing.

Index getDepth ( ) const
inline

Return the depth in the tree (0 = root) of the node to which this iterator is currently pointing.

static Index getLeafDepth ( )
inlinestatic
Index getLevel ( ) const
inline

Return the level in the tree (0 = leaf) of the node to which this iterator is currently pointing.

Index getMaxDepth ( ) const
inline

Return the depth of the lowest level of the tree to which this iterator ascends.

Index getMinDepth ( ) const
inline

Return the depth of the highest level of the tree to which this iterator ascends.

void getNode ( NodeT *&  node) const
inline

Return the node to which the iterator is pointing.

Note
This iterator doesn't have the usual dereference operators (* and ->), because they would have to be overloaded by the returned node type.
void getNode ( const NodeT *&  node) const
inline

Return the node to which the iterator is pointing.

Note
This iterator doesn't have the usual dereference operators (* and ->), because they would have to be overloaded by the returned node type.
TreeT* getTree ( ) const
inline
void increment ( )
inline

Advance the iterator to the next leaf node.

void increment ( Index  n)
inline

Increment the iterator n times.

bool next ( )
inline

Advance to the next tile or voxel value.

Returns
true if this iterator is not yet exhausted.
operator bool ( ) const
inline

Return true if this iterator is not yet exhausted.

NodeIteratorBase& operator++ ( )
inline
NodeIteratorBase< TreeT, RootChildOnIterT > & operator= ( const NodeIteratorBase< _TreeT, RootChildOnIterT > &  other)
inline
void setMaxDepth ( Index  maxDepth)
inline

Specify the depth of the lowest level of the tree to which to descend (depth 0 = root).

void setMinDepth ( Index  minDepth)
inline

Specify the depth of the highest level of the tree to which to ascend (depth 0 = root).

std::string summary ( ) const
inline
bool test ( ) const
inline

Return true if this iterator is not yet exhausted.

Member Data Documentation

const Index LEAF_DEPTH = ROOT_LEVEL
static
const Index LEAF_LEVEL = 0
static
const Index ROOT_DEPTH = 0
static
const Index ROOT_LEVEL = RootNodeT::LEVEL
static

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