OpenVDB  5.2.0
Public Member Functions | List of all members
IteratorBase< MaskIterT, NodeT > Class Template Reference

Base class for iterators over internal and leaf nodes. More...

#include <Iterator.h>

Inherited by DenseIteratorBase< MaskIterT, IterT, NodeT, SetItemT, UnsetItemT >, SparseIteratorBase< MaskIterT, IterT, NodeT, ItemT >, SparseIteratorBase< MaskIterT, ChildIter< MaskIterT, NodeT >, NodeT, bool >, SparseIteratorBase< MaskIterT, ChildIter< MaskIterT, NodeT, TagT >, NodeT, ValueType >, SparseIteratorBase< MaskIterT, ChildIter< NodeT, ChildT, MaskIterT, TagT >, NodeT, ChildT >, SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT >, NodeT, ValueT >, SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT, TagT >, NodeT, ValueT >, and SparseIteratorBase< MaskIterT, ValueIter< NodeT, ValueT, MaskIterT, TagT >, NodeT, ValueT >.

Public Member Functions

 IteratorBase ()
 
 IteratorBase (const MaskIterT &iter, NodeT *parent)
 
 IteratorBase (const IteratorBase &)=default
 
IteratorBaseoperator= (const IteratorBase &)=default
 
bool operator== (const IteratorBase &other) const
 
bool operator!= (const IteratorBase &other) const
 
NodeT * getParentNode () const
 Return a pointer to the node (if any) over which this iterator is iterating. More...
 
NodeT & parent () const
 Return a reference to the node over which this iterator is iterating. More...
 
Index offset () const
 Return this iterator's position as an index into the parent node's table. More...
 
Index pos () const
 Identical to offset. More...
 
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...
 
bool next ()
 Advance to the next item in the parent node's table. More...
 
void increment ()
 Advance to the next item in the parent node's table. More...
 
IteratorBaseoperator++ ()
 Advance to the next item in the parent node's table. More...
 
void increment (Index n)
 Advance n items in the parent node's table. More...
 
bool isValueOn () const
 Return true if this iterator is pointing to an active value. Return false if it is pointing to either an inactive value or a child node. More...
 
void setValueOn (bool on=true) const
 If this iterator is pointing to a value, set the value's active state. Otherwise, do nothing. More...
 
void setValueOff () const
 If this iterator is pointing to a value, mark the value as inactive. More...
 
Coord getCoord () const
 Return the coordinates of the item to which this iterator is pointing. More...
 
void getCoord (Coord &xyz) const
 Return in xyz the coordinates of the item to which this iterator is pointing. More...
 

Detailed Description

template<typename MaskIterT, typename NodeT>
class openvdb::v5_2::tree::IteratorBase< MaskIterT, NodeT >

Base class for iterators over internal and leaf nodes.

This class is typically not instantiated directly, since it doesn't provide methods to dereference the iterator. Those methods (operator*(), setValue(), etc.) are implemented in the sparse and dense iterator subclasses.

Constructor & Destructor Documentation

IteratorBase ( )
inline
IteratorBase ( const MaskIterT &  iter,
NodeT *  parent 
)
inline
IteratorBase ( const IteratorBase< MaskIterT, NodeT > &  )
default

Member Function Documentation

Coord getCoord ( ) const
inline

Return the coordinates of the item to which this iterator is pointing.

void getCoord ( Coord &  xyz) const
inline

Return in xyz the coordinates of the item to which this iterator is pointing.

NodeT* getParentNode ( ) const
inline

Return a pointer to the node (if any) over which this iterator is iterating.

void increment ( )
inline

Advance to the next item in the parent node's table.

void increment ( Index  n)
inline

Advance n items in the parent node's table.

bool isValueOn ( ) const
inline

Return true if this iterator is pointing to an active value. Return false if it is pointing to either an inactive value or a child node.

bool next ( )
inline

Advance to the next item in the parent node's table.

Index offset ( ) const
inline

Return this iterator's position as an index into the parent node's table.

operator bool ( ) const
inline

Return true if this iterator is not yet exhausted.

bool operator!= ( const IteratorBase< MaskIterT, NodeT > &  other) const
inline
IteratorBase& operator++ ( )
inline

Advance to the next item in the parent node's table.

IteratorBase& operator= ( const IteratorBase< MaskIterT, NodeT > &  )
default
bool operator== ( const IteratorBase< MaskIterT, NodeT > &  other) const
inline
NodeT& parent ( ) const
inline

Return a reference to the node over which this iterator is iterating.

Exceptions
ValueErrorif there is no parent node.
Index pos ( ) const
inline

Identical to offset.

void setValueOff ( ) const
inline

If this iterator is pointing to a value, mark the value as inactive.

If this iterator is pointing to a child node, then the current item in the parent node's table is required to be inactive. In that case, this method has no effect.

void setValueOn ( bool  on = true) const
inline

If this iterator is pointing to a value, set the value's active state. Otherwise, do nothing.

bool test ( ) const
inline

Return true if this iterator is not yet exhausted.


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