InternalNode< _ChildNodeType, Log2Dim >::ChildIter< NodeT, ChildT, MaskIterT, TagT > Struct Template Reference

#include <openvdb/tree/InternalNode.h>

Inherits SparseIteratorBase< MaskIterT, ChildIter< NodeT, ChildT, MaskIterT, TagT >, NodeT, ChildT >.

Public Types
using	NodeType = NodeT
using	ValueType = ChildT
using	NonConstNodeType = typename std::remove_const< NodeT >::type
using	NonConstValueType = typename std::remove_const< ChildT >::type

Public Member Functions
	ChildIter ()
	ChildIter (const MaskIterT &iter, NodeT *parent)
ChildT &	getItem (Index pos) const
void	setItem (Index pos, const ChildT &c) const
ChildT &	operator* () const
	Return a reference to the item to which this iterator is pointing. More...
ChildT *	operator-> () const
	Return a pointer to the item to which this iterator is pointing. More...
ChildT &	getValue () const
	Return the item to which this iterator is pointing. More...
void	setValue (const ChildT &value) const
	Set the value of the item to which this iterator is pointing. (Not valid for const iterators.) More...
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...

Static Public Attributes
static const bool	IsSparseIterator
static const bool	IsDenseIterator

Member Typedef Documentation

using NodeType = NodeT

inherited

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

inherited

using NonConstValueType = typename std::remove_const<ChildT >::type

inherited

using ValueType = ChildT

inherited

Constructor & Destructor Documentation

ChildIter ( )

inline

ChildIter ( const MaskIterT &  iter, NodeT *  parent  )

inline

Member Function Documentation

Coord getCoord ( ) const

inlineinherited

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

void getCoord ( Coord &  xyz ) const

inlineinherited

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

ChildT& getItem ( Index  pos ) const

inline

NodeT* getParentNode ( ) const

inlineinherited

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

ChildT & getValue ( ) const

inlineinherited

Return the item to which this iterator is pointing.

void increment ( )

inlineinherited

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

void increment ( Index  n )

inlineinherited

Advance n items in the parent node's table.

bool isValueOn ( ) const

inlineinherited

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 modifyValue ( const ModifyOp &  op ) const

inlineinherited

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

bool next ( )

inlineinherited

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

Index offset ( ) const

inlineinherited

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

operator bool ( ) const

inlineinherited

Return true if this iterator is not yet exhausted.

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

inlineinherited

ChildT & operator* ( ) const

inlineinherited

Return a reference to the item to which this iterator is pointing.

IteratorBase& operator++ ( )

inlineinherited

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

ChildT * operator-> ( ) const

inlineinherited

Return a pointer to the item to which this iterator is pointing.

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

inlineinherited

NodeT& parent ( ) const

inlineinherited

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

Exceptions

ValueError

if there is no parent node.

Index pos ( ) const

inlineinherited

Identical to offset.

void setItem ( Index  pos, const ChildT &  c  ) const

inline

void setValue ( const ChildT &  value ) const

inlineinherited

Set the value of the item to which this iterator is pointing. (Not valid for const iterators.)

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.

void setValueOn ( bool  on = true ) const

inlineinherited

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

bool test ( ) const

inlineinherited

Return true if this iterator is not yet exhausted.

Member Data Documentation

const bool IsDenseIterator

staticinherited

const bool IsSparseIterator

staticinherited