UT_PointGridIterator< T > Class Template Reference

Iteration over a range of keys returned from a UT_PointGrid query. More...

#include <UT_PointGrid.h>

Classes
struct	UT_PointGridSequence

Public Types
typedef T::indextype	indextype
typedef T::keytype	keytype

Public Member Functions
	UT_PointGridIterator ()
exint	entries () const
	The total number of keys over which this iterator will iterate. More...
exint	numSequences () const
bool	isValid () const
	Test to see whether the iterator is valid. More...
void	rewind ()
bool	atEnd () const
void	advance ()
keytype	getValue () const
keytype	operator* () const

Protected Types
typedef UT_ValArray < UT_PointGridSequence >	queuetype

Protected Member Functions
	UT_PointGridIterator (const UT_PointGrid< T > *grid, queuetype &queue)
void	advanceSequence ()

Protected Attributes
queuetype *	mySequences
indextype	myCurIdx
indextype	myCurEnd
exint	myCurSequence
const UT_PointGrid< T > *	myGrid

Friends
class	UT_PointGrid< T >

Detailed Description

template<typename T>
class UT_PointGridIterator< T >

Iteration over a range of keys returned from a UT_PointGrid query.

An iterator is used to iterate over the results of a query into UT_PointGrid. of a given range. The UT_PointGrid query functions return iterators already rewound, so in most cases there is no need for an explicit rewind() call.

Definition at line 30 of file UT_PointGrid.h.

Member Typedef Documentation

template<typename T>

typedef T::indextype UT_PointGridIterator< T >::indextype

Definition at line 33 of file UT_PointGrid.h.

template<typename T>

typedef T::keytype UT_PointGridIterator< T >::keytype

Definition at line 34 of file UT_PointGrid.h.

template<typename T>

typedef UT_ValArray<UT_PointGridSequence> UT_PointGridIterator< T >::queuetype

protected

Definition at line 72 of file UT_PointGrid.h.

Constructor & Destructor Documentation

template<typename T >

UT_PointGridIterator< T >::UT_PointGridIterator

(

)

Definition at line 25 of file UT_PointGridImpl.h.

template<typename T >

UT_PointGridIterator< T >::UT_PointGridIterator ( const UT_PointGrid< T > *  grid, queuetype &  queue  )

protected

Definition at line 31 of file UT_PointGridImpl.h.

Member Function Documentation

template<typename T >

void UT_PointGridIterator< T >::advance

(

)

Standard iterator methods.

Definition at line 73 of file UT_PointGridImpl.h.

template<typename T >

void UT_PointGridIterator< T >::advanceSequence ( )

protected

Definition at line 57 of file UT_PointGridImpl.h.

template<typename T >

bool UT_PointGridIterator< T >::atEnd

(

)

const

Standard iterator methods.

Definition at line 50 of file UT_PointGridImpl.h.

template<typename T >

exint UT_PointGridIterator< T >::entries

(

)

const

The total number of keys over which this iterator will iterate.

Definition at line 89 of file UT_PointGridImpl.h.

template<typename T >

UT_PointGridIterator< T >::keytype UT_PointGridIterator< T >::getValue

(

)

const

Query state of the iterator

Definition at line 81 of file UT_PointGridImpl.h.

template<typename T>

bool UT_PointGridIterator< T >::isValid ( ) const

inline

Test to see whether the iterator is valid.

Definition at line 62 of file UT_PointGrid.h.

template<typename T>

exint UT_PointGridIterator< T >::numSequences ( ) const

inline

The total number of occupied point grid voxels over which this iterator will iterate.

Definition at line 59 of file UT_PointGrid.h.

template<typename T>

keytype UT_PointGridIterator< T >::operator* ( ) const

inline

Query state of the iterator

Definition at line 51 of file UT_PointGrid.h.

template<typename T >

void UT_PointGridIterator< T >::rewind

(

)

Standard iterator methods.

Definition at line 40 of file UT_PointGridImpl.h.

Friends And Related Function Documentation

template<typename T>

friend class UT_PointGrid< T >

friend

Definition at line 84 of file UT_PointGrid.h.

Member Data Documentation

template<typename T>

indextype UT_PointGridIterator< T >::myCurEnd

protected

Definition at line 81 of file UT_PointGrid.h.

template<typename T>

indextype UT_PointGridIterator< T >::myCurIdx

protected

Definition at line 80 of file UT_PointGrid.h.

template<typename T>

exint UT_PointGridIterator< T >::myCurSequence

protected

Definition at line 82 of file UT_PointGrid.h.

template<typename T>

const UT_PointGrid<T>* UT_PointGridIterator< T >::myGrid

protected

Definition at line 83 of file UT_PointGrid.h.

template<typename T>

queuetype* UT_PointGridIterator< T >::mySequences

protected

Definition at line 79 of file UT_PointGrid.h.

---

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

• UT/UT_PointGrid.h
• UT/UT_PointGridImpl.h