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

#include <PointHashGrid.h>

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

Private Member Functions
void	advanceCell ()
void	advance ()
	BoxIterator ()
	BoxIterator (const ThisType *grid, bool exact, const AABox &box)
const Value &	value () const
const Vector3 &	position () const
BoxIterator &	operator= (const BoxIterator &)

Private Attributes
bool	m_isEnd
const ThisType *	m_grid
Vector3int32	m_lo
Vector3int32	m_hi
bool	m_exact
AABox	m_box
Vector3int32	m_current
Cell *	m_cell
int	m_arrayIndex
const int	m_epoch

Friends
class	ThisType
class	SphereIterator

Constructor & Destructor Documentation

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

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

inlineprivate

End iterator

: m_isEnd(true), m_grid(NULL), m_exact(true), m_current(0,0,0), m_cell(NULL), m_arrayIndex(0), m_epoch(0) {}

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

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::BoxIterator ( const ThisType *  grid, bool  exact, const AABox &  box  )

inlineprivate

Begin iterator

 : 
 m_isEnd(false),
 m_grid(grid),
 m_exact(exact),
 m_box(box),
 m_current(-1, 0 ,0),
 m_cell(NULL),
 m_arrayIndex(0),
 m_epoch(grid->m_epoch) { 

 m_grid->getCellCoord(box.low(), m_lo);
 m_grid->getCellCoord(box.high(), m_hi);
 
 // Get to the first value
 m_current = m_lo;
 // Back up one so that advancing takes us to the first
 --m_current.x;
 advance();
 }

Here is the call graph for this function:

Member Function Documentation

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

void G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::advance ( )

inlineprivate

Advance to the next value

 {
 debugAssert(! m_isEnd);

 do {
 ++m_arrayIndex;
 bool inConstructor = (m_cell == NULL);
 if (inConstructor || m_arrayIndex >= m_cell->size()) {
 advanceCell();
 m_arrayIndex = 0;

 if (m_isEnd) {
 // Ran out of values
 return;
 }
 debugAssert(m_cell != NULL);
 }

 // Advance until we have a value that can be returned, either
 // because we don't care about exactness or because it is 
 // guaranteed to be within the box.
 } while (m_exact && ! m_box.contains(position()));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

void G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::advanceCell ( )

inlineprivate

Called from advance()

 {
 do {
 ++m_current.x;
 if (m_current.x > m_hi.x) {
 m_current.x = m_lo.x;
 ++m_current.y;
 if (m_current.y > m_hi.y) {
 m_current.y = m_lo.y;
 ++m_current.z;
 if (m_current.z > m_hi.z) {
 m_isEnd = true;
 return;
 }
 }
 }

 // Pick up the new cell
 m_cell = m_grid->m_data.getPointer(m_current);
 // Keep advancing if the cell does not exist
 } while ((m_cell == NULL) || (m_cell->size() == 0));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::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 >::BoxIterator::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 >::BoxIterator::operator Value * ( ) const

inline

{ return &value(); }

Here is the call graph for this function:

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

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

inline

 {
 if (other.m_isEnd && m_isEnd) {
 return false;
 } else {
 return (m_isEnd != other.m_isEnd) ||
 (m_cell != other.m_cell) || 
 (m_arrayIndex != other.m_arrayIndex);
 }
 }

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

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

inline

{ return value(); }

Here is the call graph for this function:

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

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

inline

Preincrement

 {
 debugAssert(! m_isEnd);
 debugAssertM(m_epoch == m_grid->m_epoch, 
 "It is illegal to mutate the HashGrid "
 "while iterating through it.");

 advance();

 return *this;
 }

Here is the call graph for this function:

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

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

inline

Post increment (slower)

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

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

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

inline

{ return &value(); }

Here is the call graph for this function:

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

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

private

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

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

inline

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

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

const Vector3& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::position ( ) const

inlineprivate

Used by SphereIterator::advance()

 {
 debugAssert(! m_isEnd);
 return (*m_cell)[m_arrayIndex].position;
 }

Here is the caller graph for this function:

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

const Value& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::value ( ) const

inlineprivate

 {
 debugAssert(! m_isEnd);
 return (*m_cell)[m_arrayIndex].value;
 }

Here is the caller graph for this function:

Friends And Related Function Documentation

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

friend class SphereIterator

friend

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>>

int G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_arrayIndex

private

Index within m_cell of the current value

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

AABox G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_box

private

The underlying box in 3D space

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

Cell* G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_cell

private

The current cell.

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

Vector3int32 G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_current

private

The iterator winds through the 3D grid between m_lo and (m_lo + m_extent) in Z,Y,X-major order. This is the index keeping track of how far it has come

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

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

private

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

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_exact

private

If true, test values against m_box before returning them.

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

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

private

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

Vector3int32 G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_hi

private

Upper bound on the boxes covered, inclusive.

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

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

private

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

Vector3int32 G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::BoxIterator::m_lo

private

Lower bound on the boxes covered, inclusive.

---

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

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