OpenVDB  12.0.0
Public Member Functions | List of all members
IndexIter< IteratorT, FilterT >::ValueIndexIter Class Reference

A forward iterator over array indices from a value iterator (such as ValueOnCIter) More...

#include <openvdb/points/IndexIterator.h>

Public Member Functions

 ValueIndexIter (const IteratorT &iter)
 
 ValueIndexIter (const ValueIndexIter &other)
 
ValueIndexIteroperator= (const ValueIndexIter &)=default
 
Index32 end () const
 
void reset (Index32 item, Index32 end)
 
Index32 operator* ()
 Returns the item to which this iterator is currently pointing. More...
 
Index32 operator* () const
 
 operator bool () const
 Return true if this iterator is not yet exhausted. More...
 
bool test () const
 
ValueIndexIteroperator++ ()
 Advance to the next (valid) item (prefix). More...
 
bool next ()
 Advance to the next (valid) item. More...
 
bool increment ()
 
Coord getCoord () const
 Return the coordinates of the item to which the value iterator is pointing. More...
 
void getCoord (Coord &xyz) const
 Return in xyz the coordinates of the item to which the value iterator is pointing. More...
 
bool isValueOn () const
 Return true if this iterator is pointing to an active value. More...
 
const IteratorT & valueIter () const
 Return the const value iterator. More...
 
bool operator== (const ValueIndexIter &other) const
 Equality operators. More...
 
bool operator!= (const ValueIndexIter &other) const
 

Detailed Description

template<typename IteratorT, typename FilterT>
class openvdb::v12_0::points::IndexIter< IteratorT, FilterT >::ValueIndexIter

A forward iterator over array indices from a value iterator (such as ValueOnCIter)

Constructor & Destructor Documentation

ValueIndexIter ( const IteratorT &  iter)
inline
ValueIndexIter ( const ValueIndexIter other)
inline

Member Function Documentation

Index32 end ( ) const
inline
Coord getCoord ( ) const
inline

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

void getCoord ( Coord &  xyz) const
inline

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

bool increment ( )
inline
bool isValueOn ( ) const
inline

Return true if this iterator is pointing to an active value.

bool next ( )
inline

Advance to the next (valid) item.

operator bool ( ) const
inline

Return true if this iterator is not yet exhausted.

bool operator!= ( const ValueIndexIter other) const
inline
Index32 operator* ( )
inline

Returns the item to which this iterator is currently pointing.

Index32 operator* ( ) const
inline
ValueIndexIter& operator++ ( )
inline

Advance to the next (valid) item (prefix).

ValueIndexIter& operator= ( const ValueIndexIter )
default
bool operator== ( const ValueIndexIter other) const
inline

Equality operators.

void reset ( Index32  item,
Index32  end 
)
inline
bool test ( ) const
inline
const IteratorT& valueIter ( ) const
inline

Return the const value iterator.