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) |
void | operator= (const IteratorBase &other) |
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.
|
IteratorBase & | operator++ () |
| 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::v1_1_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
Member Function Documentation
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.
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.
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.
Advance to the next item in the parent node's table.
Return this iterator's position as an index into the parent node's table.
Return true
if this iterator is not yet exhausted.
bool operator!= |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inline |
Advance to the next item in the parent node's table.
void operator= |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
|
|
inline |
bool operator== |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inline |
Return a reference to the node over which this iterator is iterating.
- Exceptions
-
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.
Return true
if this iterator is not yet exhausted.
The documentation for this class was generated from the following file: