OpenVDB 11.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
IteratorBase< MaskIterT, NodeT > Class Template Reference

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

#include <openvdb/tree/Iterator.h>

Inheritance diagram for IteratorBase< MaskIterT, NodeT >:
DenseIteratorBase< MaskDenseIterator, DenseIter< NodeT, ChildT, ValueT, TagT >, NodeT, ChildT, ValueT > DenseIteratorBase< MaskDenseIterator, DenseIter< NodeT, ValueT, TagT >, NodeT, void, ValueT > DenseIteratorBase< MaskDenseIter, DenseIter< NodeT, ValueT >, NodeT, void, ValueT > SparseIteratorBase< MaskIterT, ChildIter< NodeT, ChildT, MaskIterT, TagT >, NodeT, ChildT > SparseIteratorBase< MaskIterT, ValueIter< NodeT, ValueT, MaskIterT, TagT >, NodeT, ValueT > SparseIteratorBase< MaskIterT, ChildIter< MaskIterT, NodeT, TagT >, NodeT, ValueType > SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT, TagT >, NodeT, ValueT > SparseIteratorBase< MaskIterT, ChildIter< MaskIterT, NodeT >, NodeT, bool > SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT >, NodeT, ValueT > DenseIteratorBase< MaskIterT, IterT, NodeT, SetItemT, UnsetItemT > SparseIteratorBase< MaskIterT, IterT, NodeT, ItemT >

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.
 
NodeT & parent () const
 Return a reference to the node over which this iterator is iterating.
 
Index offset () const
 Return this iterator's position as an index into the parent node's table.
 
Index pos () const
 Identical to offset.
 
bool test () const
 Return true if this iterator is not yet exhausted.
 
 operator bool () const
 Return true if this iterator is not yet exhausted.
 
bool next ()
 Advance to the next item in the parent node's table.
 
void increment ()
 Advance to the next item in the parent node's table.
 
IteratorBaseoperator++ ()
 Advance to the next item in the parent node's table.
 
void increment (Index n)
 Advance n items in the parent node's table.
 
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.
 
void setValueOn (bool on=true) const
 If this iterator is pointing to a value, set the value's active state. Otherwise, do nothing.
 
void setValueOff () const
 If this iterator is pointing to a value, mark the value as inactive.
 
Coord getCoord () const
 Return the coordinates of the item to which this iterator is pointing.
 
void getCoord (Coord &xyz) const
 Return in xyz the coordinates of the item to which this iterator is pointing.
 

Detailed Description

template<typename MaskIterT, typename NodeT>
class openvdb::v11_0::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() [1/3]

template<typename MaskIterT , typename NodeT >
IteratorBase ( )
inline

◆ IteratorBase() [2/3]

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

◆ IteratorBase() [3/3]

template<typename MaskIterT , typename NodeT >
IteratorBase ( const IteratorBase< MaskIterT, NodeT > & )
default

Member Function Documentation

◆ getCoord() [1/2]

template<typename MaskIterT , typename NodeT >
Coord getCoord ( ) const
inline

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

◆ getCoord() [2/2]

template<typename MaskIterT , typename NodeT >
void getCoord ( Coord & xyz) const
inline

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

◆ getParentNode()

template<typename MaskIterT , typename NodeT >
NodeT * getParentNode ( ) const
inline

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

◆ increment() [1/2]

template<typename MaskIterT , typename NodeT >
void increment ( )
inline

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

◆ increment() [2/2]

template<typename MaskIterT , typename NodeT >
void increment ( Index n)
inline

Advance n items in the parent node's table.

◆ isValueOn()

template<typename MaskIterT , typename NodeT >
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.

◆ next()

template<typename MaskIterT , typename NodeT >
bool next ( )
inline

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

◆ offset()

template<typename MaskIterT , typename NodeT >
Index offset ( ) const
inline

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

◆ operator bool()

template<typename MaskIterT , typename NodeT >
operator bool ( ) const
inline

Return true if this iterator is not yet exhausted.

◆ operator!=()

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

◆ operator++()

template<typename MaskIterT , typename NodeT >
IteratorBase & operator++ ( )
inline

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

◆ operator=()

template<typename MaskIterT , typename NodeT >
IteratorBase & operator= ( const IteratorBase< MaskIterT, NodeT > & )
default

◆ operator==()

template<typename MaskIterT , typename NodeT >
bool operator== ( const IteratorBase< MaskIterT, NodeT > & other) const
inline

◆ parent()

template<typename MaskIterT , typename NodeT >
NodeT & parent ( ) const
inline

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

Exceptions
ValueErrorif there is no parent node.

◆ pos()

template<typename MaskIterT , typename NodeT >
Index pos ( ) const
inline

Identical to offset.

◆ setValueOff()

template<typename MaskIterT , typename NodeT >
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.

◆ setValueOn()

template<typename MaskIterT , typename NodeT >
void setValueOn ( bool on = true) const
inline

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

◆ test()

template<typename MaskIterT , typename NodeT >
bool test ( ) const
inline

Return true if this iterator is not yet exhausted.