HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter Class Reference

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

#include <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::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter

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

Definition at line 170 of file IndexIterator.h.

Constructor & Destructor Documentation

template<typename IteratorT, typename FilterT>
openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::ValueIndexIter ( const IteratorT &  iter)
inline

Definition at line 173 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::ValueIndexIter ( const ValueIndexIter other)
inline

Definition at line 184 of file IndexIterator.h.

Member Function Documentation

template<typename IteratorT, typename FilterT>
Index32 openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::end ( void  ) const
inline

Definition at line 191 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
Coord openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::getCoord ( ) const
inline

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

Definition at line 221 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
void openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::getCoord ( Coord &  xyz) const
inline

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

Definition at line 223 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::increment ( )
inline

Definition at line 218 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::isValueOn ( ) const
inline

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

Definition at line 226 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::next ( )
inline

Advance to the next (valid) item.

Definition at line 217 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator bool ( ) const
inline

Return true if this iterator is not yet exhausted.

Definition at line 203 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator!= ( const ValueIndexIter other) const
inline

Definition at line 233 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
Index32 openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator* ( void  )
inline

Returns the item to which this iterator is currently pointing.

Definition at line 199 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
Index32 openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator* ( void  ) const
inline

Definition at line 200 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
ValueIndexIter& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator++ ( )
inline

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

Definition at line 207 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
ValueIndexIter& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator= ( const ValueIndexIter )
default
template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::operator== ( const ValueIndexIter other) const
inline

Equality operators.

Definition at line 232 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
void openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::reset ( Index32  item,
Index32  end 
)
inline

Definition at line 193 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::test ( ) const
inline

Definition at line 204 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>
const IteratorT& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::ValueIndexIter::valueIter ( ) const
inline

Return the const value iterator.

Definition at line 229 of file IndexIterator.h.


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