OpenVDB 7.0.0

Public Types | Public Member Functions | Static Public Attributes | List of all members
LeafNode< bool, Log2Dim >::DenseIter< NodeT, ValueT > Struct Template Reference

`#include <LeafNodeBool.h>`

Inherits DenseIteratorBase< MaskDenseIter, DenseIter< NodeT, ValueT >, NodeT, void, ValueT >.

## Public Types
using | BaseT = DenseIteratorBase< MaskDenseIter, DenseIter, NodeT, void, ValueT >
using | NonConstValueT = typename BaseT::NonConstValueType
using | NodeType = NodeT
using | ValueType = ValueT
using | ChildNodeType = void
using | NonConstNodeType = typename std::remove_const< NodeT >::type
using | NonConstValueType = typename std::remove_const< ValueT >::type
using | NonConstChildNodeType = typename std::remove_const< void >::type

## Public Member Functions
| DenseIter ()
| DenseIter (const MaskDenseIter &iter, NodeT *parent)
bool | getItem (Index pos, void *&child, NonConstValueT &value) const
void | unsetItem (Index pos, const ValueT &val) const
bool | getItem (Index, void *&child, NonConstValueType &value) const
| Return `true` if the item at the given index in the parent node's table is a set value and return either the set value in child or the unset value in value. More...
void | setItem (Index, void *) const
| Set the value of the item at the given index in the parent node's table. More...
bool | isChildNode () const
| Return `true` if this iterator is pointing to a child node. More...
void * | probeChild (NonConstValueType &value) const
| If this iterator is pointing to a child node, return a pointer to the node. Otherwise, return nullptr and, in value, the value to which this iterator is pointing. More...
bool | probeChild (void *&child, NonConstValueType &value) const
| If this iterator is pointing to a child node, return `true` and return a pointer to the child node in child. Otherwise, return `false` and return the value to which this iterator is pointing in value. More...
bool | probeValue (NonConstValueType &value) const
| Return `true` if this iterator is pointing to a value and return the value in value. Otherwise, return `false`. More...
void | setChild (void *child) const
| Replace with the given child node the item in the parent node's table to which this iterator is pointing. More...
void | setValue (const ValueT &value) const
| Replace with the given value the item in the parent node's table to which this iterator is pointing. 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...

## Static Public Attributes
static const bool | IsSparseIterator
static const bool | IsDenseIterator

## Member Typedef Documentation

## ◆ BaseT

using BaseT = DenseIteratorBase<MaskDenseIter, DenseIter, NodeT, void, ValueT>

## ◆ ChildNodeType

using ChildNodeType = void
| inherited

## ◆ NodeType

using NodeType = NodeT
| inherited

## ◆ NonConstChildNodeType

using NonConstChildNodeType = typename std::remove_const<void >::type
| inherited

## ◆ NonConstNodeType

using NonConstNodeType = typename std::remove_const<NodeT>::type
| inherited

## ◆ NonConstValueT

using NonConstValueT = typename BaseT::NonConstValueType

## ◆ NonConstValueType

using NonConstValueType = typename std::remove_const<ValueT >::type
| inherited

## ◆ ValueType

using ValueType = ValueT
| inherited

## Constructor & Destructor Documentation

## ◆ DenseIter() [1/2]

DenseIter | ( |  | ) |
| inline

## ◆ DenseIter() [2/2]

DenseIter | ( | const MaskDenseIter & | iter,
|  | NodeT * | parent
| ) |  |
| inline

## Member Function Documentation

## ◆ getCoord() [1/2]

Coord getCoord | ( |  | ) | const
| inline inherited

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

## ◆ getCoord() [2/2]

void getCoord | ( | Coord & | xyz | ) | const
| inline inherited

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

## ◆ getItem() [1/2]

bool getItem | ( | Index | pos,
|  | void *& | child,
|  | NonConstValueT & | value
| ) |  | const
| inline

## ◆ getItem() [2/2]

bool getItem | ( | Index | ,
|  | void *& | child,
|  | NonConstValueType & | value
| ) |  | const
| inherited

Return `true` if the item at the given index in the parent node's table is a set value and return either the set value in child or the unset value in value.

Note
  All subclasses must implement this accessor.

## ◆ getParentNode()

NodeT* getParentNode | ( |  | ) | const
| inline inherited

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

## ◆ increment() [1/2]

void increment | ( |  | ) |
| inline inherited

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

## ◆ increment() [2/2]

void increment | ( | Index | n | ) |
| inline inherited

Advance n items in the parent node's table.

## ◆ isChildNode()

bool isChildNode | ( |  | ) | const
| inline inherited

Return `true` if this iterator is pointing to a child node.

## ◆ isValueOn()

bool isValueOn | ( |  | ) | const
| inline inherited

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()

bool next | ( |  | ) |
| inline inherited

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

## ◆ offset()

Index offset | ( |  | ) | const
| inline inherited

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

## ◆ operator bool()

operator bool | ( |  | ) | const
| inline inherited

Return `true` if this iterator is not yet exhausted.

## ◆ operator!=()

bool operator!= | ( | const IteratorBase< MaskDenseIter, NodeT > & | other | ) | const
| inline inherited

## ◆ operator++()

IteratorBase& operator++ | ( |  | ) |
| inline inherited

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

## ◆ operator==()

bool operator== | ( | const IteratorBase< MaskDenseIter, NodeT > & | other | ) | const
| inline inherited

## ◆ parent()

NodeT& parent | ( |  | ) | const
| inline inherited

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

Exceptions

  ValueError | if there is no parent node.

## ◆ pos()

Index pos | ( |  | ) | const
| inline inherited

Identical to offset.

## ◆ probeChild() [1/2]

void * probeChild | ( | NonConstValueType & | value | ) | const
| inline inherited

If this iterator is pointing to a child node, return a pointer to the node. Otherwise, return nullptr and, in value, the value to which this iterator is pointing.

## ◆ probeChild() [2/2]

bool probeChild | ( | void *& | child,
|  | NonConstValueType & | value
| ) |  | const
| inline inherited

If this iterator is pointing to a child node, return `true` and return a pointer to the child node in child. Otherwise, return `false` and return the value to which this iterator is pointing in value.

## ◆ probeValue()

bool probeValue | ( | NonConstValueType & | value | ) | const
| inline inherited

Return `true` if this iterator is pointing to a value and return the value in value. Otherwise, return `false`.

## ◆ setChild()

void setChild | ( | void * | child | ) | const
| inline inherited

Replace with the given child node the item in the parent node's table to which this iterator is pointing.

## ◆ setItem()

void setItem | ( | Index | ,
|  | void * |
| ) |  | const
| inherited

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 ValueT & | value | ) | const
| inline inherited

Replace with the given value the item in the parent node's table to which this iterator is pointing.

## ◆ setValueOff()

void setValueOff | ( |  | ) | const
| inline inherited

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 inherited

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

## ◆ test()

bool test | ( |  | ) | const
| inline inherited

Return `true` if this iterator is not yet exhausted.

## ◆ unsetItem()

void unsetItem | ( | Index | pos,
|  | const ValueT & | val
| ) |  | const
| inline

## Member Data Documentation

## ◆ IsDenseIterator

const bool IsDenseIterator
| static inherited

## ◆ IsSparseIterator

const bool IsSparseIterator
| static inherited

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

- LeafNodeBool.h