G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator Class Reference

#include <PointHashGrid.h>

Classes
class	CellObject

Public Member Functions
const CellObject &	operator* () const
const CellObject *	operator-> () const
	operator CellObject * () const
bool	operator!= (const CellIterator &other) const
bool	operator== (const CellIterator &other) const
CellIterator &	operator++ ()
CellIterator	operator++ (int)
bool	hasMore () const
bool	isValid () const

Private Member Functions
Cell &	cell ()
	CellIterator ()
	CellIterator (const ThisType *grid)
CellIterator &	operator= (const CellIterator &)

Private Attributes
bool	m_isEnd
const ThisType *	m_grid
CellTable::Iterator	m_tableIterator
const int	m_epoch
CellObject	m_indirection

Friends
class	ThisType

Detailed Description

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>
class G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator

Dereference to access the bounds() and size() [element count] of the underlying cell object.

Example:

for(PointHashGrid<Vector3>::CellIterator iter = grid.beginCells(); iter != grid.endCells(); ++iter) {    
entriesFound += iter->size();
}

Constructor & Destructor Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::CellIterator ( )

inlineprivate

End iterator. Note that the m_tableIterator is initialized to the end iterator of a temporary value! This is ok because we'll never look at the value of the m_tableIterator, since we're initializing the "end" Iterator.

 : 
 m_isEnd(true),
 m_grid(NULL),
 m_tableIterator( CellTable().end() ),
 m_epoch(0) {}

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::CellIterator ( const ThisType *  grid )

inlineprivate

 : 
 m_isEnd(false),
 m_grid(grid),
 m_tableIterator( grid->m_data.begin()),
 m_epoch(grid->m_epoch) {
 m_indirection.m_parent = this;
 m_isEnd = ! m_tableIterator.isValid();
 }

Here is the call graph for this function:

Member Function Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

Cell& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::cell ( )

inlineprivate

 {
 return m_tableIterator->value;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::hasMore ( ) const

inline

Deprecated:

Use isValid

 {
 return ! m_isEnd;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::isValid ( ) const

inline

 {
 return ! m_isEnd;
 }

Here is the caller graph for this function:

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator CellObject * ( ) const

inline

{ return &m_indirection; }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator!= ( const CellIterator &  other ) const

inline

 {
 // != is called more often than == during iteration
 return !(
 (m_isEnd && other.m_isEnd) ||
 ((m_isEnd == other.m_isEnd) && 
 (m_tableIterator != other.m_tableIterator)));
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const CellObject& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator* ( ) const

inline

{ return m_indirection; }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellIterator& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator++ ( )

inline

Preincrement

 {
 debugAssertM(m_epoch == m_grid->m_epoch, 
 "It is illegal to mutate the HashGrid while "
 "iterating through it.");
 ++m_tableIterator;
 m_isEnd = ! m_tableIterator.isValid();
 return *this;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellIterator G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator++ ( int  )

inline

Post increment (slower)

 {
 Iterator old = *this;
 ++(*this);
 return old;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const CellObject* G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator-> ( ) const

inline

{ return &m_indirection; }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellIterator& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator= ( const CellIterator &  )

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::operator== ( const CellIterator &  other ) const

inline

 {
 return !(*this != other);
 }

Friends And Related Function Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

friend class ThisType

friend

Member Data Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const int G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::m_epoch

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const ThisType* G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::m_grid

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellObject G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::m_indirection

private

Used to make the indirection work.

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::m_isEnd

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellTable::Iterator G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::CellIterator::m_tableIterator

private

---

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

• dep/g3dlite/include/G3D/PointHashGrid.h