Base class for sparse iterators over internal and leaf nodes.
More...
#include <Iterator.h>
Inherits IteratorBase< MaskIterT, NodeT >.
|
| SparseIteratorBase () |
|
| SparseIteratorBase (const MaskIterT &iter, NodeT *parent) |
|
ItemT & | getItem (Index) const |
| Return the item at the given index in the parent node's table. More...
|
|
void | setItem (Index, const ItemT &) const |
| Set the value of the item at the given index in the parent node's table. More...
|
|
ItemT & | operator * () const |
| Return a reference to the item to which this iterator is pointing. More...
|
|
ItemT * | operator-> () const |
| Return a pointer to the item to which this iterator is pointing. More...
|
|
ItemT & | getValue () const |
| Return the item to which this iterator is pointing. More...
|
|
void | setValue (const ItemT &value) const |
| Set the value of the item to which this iterator is pointing. (Not valid for const iterators.) More...
|
|
template<typename ModifyOp > |
void | modifyValue (const ModifyOp &op) const |
| Apply a functor to the item to which this iterator is pointing. (Not valid for const iterators.) More...
|
|
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...
|
|
void | increment (Index n) |
| Advance n items in the parent node's table. More...
|
|
IteratorBase & | operator++ () |
| Advance to the next item 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...
|
|
template<typename MaskIterT, typename IterT, typename NodeT, typename ItemT>
struct openvdb::v6_0::tree::SparseIteratorBase< MaskIterT, IterT, NodeT, ItemT >
Base class for sparse iterators over internal and leaf nodes.
◆ NodeType
◆ NonConstNodeType
◆ NonConstValueType
◆ ValueType
◆ SparseIteratorBase() [1/2]
◆ SparseIteratorBase() [2/2]
◆ getCoord() [1/2]
Return the coordinates of the item to which this iterator is pointing.
◆ getCoord() [2/2]
void getCoord |
( |
Coord & |
xyz | ) |
const |
|
inlineinherited |
Return in xyz the coordinates of the item to which this iterator is pointing.
◆ getItem()
ItemT& getItem |
( |
Index |
| ) |
const |
Return the item at the given index in the parent node's table.
- Note
- All subclasses must implement this accessor.
◆ getParentNode()
NodeT* getParentNode |
( |
| ) |
const |
|
inlineinherited |
Return a pointer to the node (if any) over which this iterator is iterating.
◆ getValue()
ItemT& getValue |
( |
| ) |
const |
|
inline |
Return the item to which this iterator is pointing.
◆ increment() [1/2]
Advance to the next item in the parent node's table.
◆ increment() [2/2]
void increment |
( |
Index |
n | ) |
|
|
inlineinherited |
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.
◆ modifyValue()
void modifyValue |
( |
const ModifyOp & |
op | ) |
const |
|
inline |
Apply a functor to the item to which this iterator is pointing. (Not valid for const iterators.)
- Parameters
-
op | a functor of the form void op(ValueType&) const that modifies its argument in place |
- See also
- Tree::modifyValue()
◆ 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 *()
ItemT& operator * |
( |
| ) |
const |
|
inline |
Return a reference to the item to which this iterator is pointing.
◆ operator bool()
Return true
if this iterator is not yet exhausted.
◆ operator!=()
bool operator!= |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inlineinherited |
◆ operator++()
Advance to the next item in the parent node's table.
◆ operator->()
ItemT* operator-> |
( |
| ) |
const |
|
inline |
Return a pointer to the item to which this iterator is pointing.
◆ operator==()
bool operator== |
( |
const IteratorBase< MaskIterT, NodeT > & |
other | ) |
const |
|
inlineinherited |
◆ parent()
Return a reference to the node over which this iterator is iterating.
- Exceptions
-
◆ pos()
◆ setItem()
void setItem |
( |
Index |
, |
|
|
const ItemT & |
|
|
) |
| const |
Set the value of the item at the given index in the parent node's table.
- Note
- All non-const iterator subclasses must implement this accessor.
◆ setValue()
void setValue |
( |
const ItemT & |
value | ) |
const |
|
inline |
Set the value of the item to which this iterator is pointing. (Not valid for const iterators.)
◆ setValueOff()
void setValueOff |
( |
| ) |
const |
|
inlineinherited |
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 |
|
inlineinherited |
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.
◆ IsDenseIterator
const bool IsDenseIterator = false |
|
static |
◆ IsSparseIterator
const bool IsSparseIterator = true |
|
static |
The documentation for this struct was generated from the following file: