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

#include <LeafNode.h>

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

Public Types

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

Public Member Functions

 ValueIter ()
 
 ValueIter (const MaskIterT &iter, NodeT *parent)
 
ValueT & getItem (Index pos) const
 
ValueT & getValue () const
 
void setItem (Index pos, const ValueT &value) const
 
void setValue (const ValueT &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, TagT >, 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, TagT >, NodeT, ValueT >
static const bool IsSparseIterator
 
static const bool IsDenseIterator
 

Detailed Description

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

Definition at line 232 of file LeafNode.h.

Member Typedef Documentation

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

Definition at line 238 of file LeafNode.h.

Constructor & Destructor Documentation

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

Definition at line 240 of file LeafNode.h.

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

Definition at line 241 of file LeafNode.h.

Member Function Documentation

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

Definition at line 243 of file LeafNode.h.

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

Definition at line 244 of file LeafNode.h.

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

Definition at line 259 of file LeafNode.h.

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

Definition at line 262 of file LeafNode.h.

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

Definition at line 247 of file LeafNode.h.

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

Definition at line 252 of file LeafNode.h.


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