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 >.
template<typename MaskIterT, typename NodeT>
class openvdb::v6_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.
◆ IteratorBase() [1/3]
◆ IteratorBase() [2/3]
◆ IteratorBase() [3/3]
◆ getCoord() [1/2]
Return the coordinates of the item to which this iterator is pointing.
◆ getCoord() [2/2]
void getCoord |
( |
Coord & |
xyz | ) |
const |
|
inline |
Return in xyz the coordinates of the item to which this iterator is pointing.
◆ getParentNode()
NodeT* getParentNode |
( |
| ) |
const |
|
inline |
Return a pointer to the node (if any) over which this iterator is iterating.
◆ increment() [1/2]
Advance to the next item in the parent node's table.
◆ increment() [2/2]
void increment |
( |
Index |
n | ) |
|
|
inline |
Advance n items in the parent node's table.
◆ isValueOn()
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()
Advance to the next item in the parent node's table.
◆ offset()
Return this iterator's position as an index into the parent node's table.
◆ operator bool()
Return true
if this iterator is not yet exhausted.
◆ operator!=()
bool operator!= |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inline |
◆ operator++()
Advance to the next item in the parent node's table.
◆ operator=()
◆ operator==()
bool operator== |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inline |
◆ parent()
Return a reference to the node over which this iterator is iterating.
- Exceptions
-
◆ pos()
◆ setValueOff()
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()
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()
Return true
if this iterator is not yet exhausted.
The documentation for this class was generated from the following file: