openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT > Class Template Reference

A forward iterator over array indices with filtering IteratorT can be either IndexIter or ValueIndexIter (or some custom index iterator) FilterT should be a struct or class with a valid() method than can be evaluated per index Here's a simple filter example that only accepts even indices: More...

#include <IndexIterator.h>

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

Public Member Functions
	IndexIter (const IteratorT &iterator, const FilterT &filter)
	IndexIter (const IndexIter &other)
IndexIter &	operator= (const IndexIter &other)
Index32	end () const
void	reset (Index32 begin, Index32 end)
	Reset the begining and end of the iterator. More...
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
IndexIter &	operator++ ()
	Advance to the next (valid) item (prefix). More...
IndexIter	operator++ (int)
	Advance to the next (valid) item (postfix). More...
bool	next ()
	Advance to the next (valid) item. More...
bool	increment ()
const FilterT &	filter () const
	Return the const filter. More...
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 the value iterator is pointing to an active value. More...
bool	operator== (const IndexIter &other) const
	Equality operators. More...
bool	operator!= (const IndexIter &other) const

Detailed Description

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

A forward iterator over array indices with filtering IteratorT can be either IndexIter or ValueIndexIter (or some custom index iterator) FilterT should be a struct or class with a valid() method than can be evaluated per index Here's a simple filter example that only accepts even indices:

struct EvenIndexFilter { bool valid(const Index32 offset) const { return (offset % 2) == 0; } };

Definition at line 139 of file IndexIterator.h.

Constructor & Destructor Documentation

template<typename IteratorT, typename FilterT>

openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::IndexIter ( const IteratorT &  iterator, const FilterT &  filter  )

inline

Definition at line 215 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::IndexIter ( const IndexIter< IteratorT, FilterT > &  other )

inline

Definition at line 227 of file IndexIterator.h.

Member Function Documentation

template<typename IteratorT, typename FilterT>

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

inline

Definition at line 249 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

const FilterT& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::filter ( ) const

inline

Return the const filter.

Definition at line 290 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

Coord openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::getCoord ( ) const

inline

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

Definition at line 293 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

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

inline

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

Definition at line 295 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::increment ( )

inline

Definition at line 287 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::isValueOn ( ) const

inline

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

Definition at line 298 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::next ( )

inline

Advance to the next (valid) item.

Definition at line 286 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator bool ( ) const

inline

Return true if this iterator is not yet exhausted.

Definition at line 264 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator!= ( const IndexIter< IteratorT, FilterT > &  other ) const

inline

Definition at line 302 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

Index32 openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator* ( )

inline

Returns the item to which this iterator is currently pointing.

Definition at line 260 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

Index32 openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator* ( ) const

inline

Definition at line 261 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

IndexIter& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator++ ( )

inline

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

Definition at line 268 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

IndexIter openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator++ ( int  )

inline

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

Definition at line 279 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

IndexIter& openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator= ( const IndexIter< IteratorT, FilterT > &  other )

inline

Definition at line 236 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::operator== ( const IndexIter< IteratorT, FilterT > &  other ) const

inline

Equality operators.

Definition at line 301 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

void openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::reset ( Index32  begin, Index32  end  )

inline

Reset the begining and end of the iterator.

Definition at line 252 of file IndexIterator.h.

template<typename IteratorT, typename FilterT>

bool openvdb::OPENVDB_VERSION_NAME::points::IndexIter< IteratorT, FilterT >::test ( ) const

inline

Definition at line 265 of file IndexIterator.h.

---

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

• openvdb/points/IndexIterator.h