HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT > Struct Template Reference

#include <LeafNodeMask.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >:

Public Types

using BaseT = SparseIteratorBase< MaskIterT, ValueIter, NodeT, ValueT >
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::tree::SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT >, NodeT, ValueT >
using NodeType = NodeT
 
using ValueType = ValueT
 
using NonConstNodeType = typename std::remove_const< NodeT >::type
 
using NonConstValueType = typename std::remove_const< ValueT >::type
 

Public Member Functions

 ValueIter ()
 
 ValueIter (const MaskIterT &iter, NodeT *parent)
 
const bool & getItem (Index pos) const
 
const bool & getValue () const
 
void setItem (Index pos, bool value) const
 
void setValue (bool value) const
 
template<typename ModifyOp >
void modifyItem (Index n, const ModifyOp &op) const
 
template<typename ModifyOp >
void modifyValue (const ModifyOp &op) const
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT >, NodeT, ValueT >
 SparseIteratorBase ()
 
 SparseIteratorBase (const MaskIterT &iter, NodeT *parent)
 
ValueT & getItem (Index) const
 Return the item at the given index in the parent node's table. More...
 
void setItem (Index, const ValueT &) const
 Set the value of the item at the given index in the parent node's table. More...
 
ValueT & operator* () const
 Return a reference to the item to which this iterator is pointing. More...
 
ValueT * operator-> () const
 Return a pointer to the item to which this iterator is pointing. More...
 
ValueT & getValue () const
 Return the item to which this iterator is pointing. More...
 
void setValue (const ValueT &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...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tree::IteratorBase< MaskIterT, NodeT >
 IteratorBase ()
 
 IteratorBase (const MaskIterT &iter, NodeT *parent)
 
 IteratorBase (const IteratorBase &)=default
 
IteratorBaseoperator= (const IteratorBase &)=default
 
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...
 
IteratorBaseoperator++ ()
 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...
 
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...
 

Additional Inherited Members

- Static Public Attributes inherited from openvdb::OPENVDB_VERSION_NAME::tree::SparseIteratorBase< MaskIterT, ValueIter< MaskIterT, NodeT, ValueT >, NodeT, ValueT >
static const bool IsSparseIterator
 
static const bool IsDenseIterator
 

Detailed Description

template<Index Log2Dim>
template<typename MaskIterT, typename NodeT, typename ValueT>
struct openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >

Definition at line 613 of file LeafNodeMask.h.

Member Typedef Documentation

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
using openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::BaseT = SparseIteratorBase<MaskIterT, ValueIter, NodeT, ValueT>

Definition at line 618 of file LeafNodeMask.h.

Constructor & Destructor Documentation

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::ValueIter ( )
inline

Definition at line 620 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::ValueIter ( const MaskIterT &  iter,
NodeT *  parent 
)
inline

Definition at line 621 of file LeafNodeMask.h.

Member Function Documentation

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
const bool& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::getItem ( Index  pos) const
inline

Definition at line 623 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
const bool& openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::getValue ( ) const
inline

Definition at line 624 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::modifyItem ( Index  n,
const ModifyOp &  op 
) const
inline

Definition at line 633 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
template<typename ModifyOp >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::modifyValue ( const ModifyOp &  op) const
inline

Definition at line 636 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::setItem ( Index  pos,
bool  value 
) const
inline

Definition at line 627 of file LeafNodeMask.h.

template<Index Log2Dim>
template<typename MaskIterT , typename NodeT , typename ValueT >
void openvdb::OPENVDB_VERSION_NAME::tree::LeafNode< ValueMask, Log2Dim >::ValueIter< MaskIterT, NodeT, ValueT >::setValue ( bool  value) const
inline

Definition at line 629 of file LeafNodeMask.h.


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