ml::CSOPathPointIterator Class Reference

#include <CSOPathPointIterator.h>

List of all members.

Public Member Functions
	CSOPathPointIterator ()
	Default constructor.
	CSOPathPointIterator (CSO *cso, unsigned int startPathIndex=0, unsigned int startPointIndex=0)
	Constructor.
	CSOPathPointIterator (CSO *cso, CSOPathPoints *pathPoints, unsigned int startPathIndex, unsigned int startPointIndex=0)
	Constructor.
	CSOPathPointIterator (CSO *cso, CSOPathPoints *pathPoints, unsigned int startPointIndex=0)
	Constructor.
	CSOPathPointIterator (CSO *cso, CSOSeedPoint *startSeedPoint)
	Constructor.
	CSOPathPointIterator (const CSOPathPointIterator &rhs)
	Copy constructor.
	~CSOPathPointIterator ()
	Default destructor.
CSOPathPointIterator &	operator++ ()
	Steps to the next point on the cso (prefix).
CSOPathPointIterator	operator++ (int dummy)
	Steps to the next point on the cso (postfix).
CSOPathPointIterator &	operator-- ()
	Steps to the previous point on the cso (prefix).
CSOPathPointIterator	operator-- (int dummy)
	Steps to the previous point on the cso (postfix).
CSOPathPointIterator &	operator+= (int offset)
	Steps to the next point by the given offest.
CSOPathPointIterator &	operator-= (int offset)
	Steps to the previous point by the given offest.
CSOPathPointIterator	operator+ (int offset) const
	Steps to the next point by the given offest.
CSOPathPointIterator	operator- (int offset) const
	Steps to the previous point by the given offest.
CSOPathPointIterator &	operator= (const CSOPathPointIterator &rhs)
	Assignment operator.
bool	operator== (const CSOPathPointIterator &rhs) const
	Comparison operator.
bool	operator!= (const CSOPathPointIterator &rhs) const
	Comparison operator.
bool	operator> (const CSOPathPointIterator &rhs) const
	Comparison operator.
bool	operator>= (const CSOPathPointIterator &rhs) const
	Comparison operator.
bool	operator< (const CSOPathPointIterator &rhs) const
	Comparison operator.
bool	operator<= (const CSOPathPointIterator &rhs) const
	Comparison operator.
const CSO *	getCSO () const
	Returns the cso.
CSO *	getCSO ()
	Returns the cso.
unsigned int	getPathIndex () const
	Returns the index of the current path.
unsigned int	getPointIndex () const
	Returns the index of the current point.
const CSOPathPoints *	getPathPoints () const
CSOPathPoints *	getPathPoints ()
Vector3	getPos () const
	Returns the current point.
const Vector4 &	getPosValue () const
	Returns the current point including its value.
double	getValue () const
	Returns the value of the current point.
void	setPos (const Vector3 &p)
	Sets the current point to the given value.
void	setPosValue (const Vector4 &p)
	Sets the current point and its value to the given value.
void	setValue (const double &v)
	Sets the value of the current point to the given value.
unsigned int	numPoints () const
	Returns the total number of points of the cso.
unsigned int	numProcessedPoints () const
	Returns the number of processed points (relative to the start).
unsigned int	numTotalProcessedPoints () const
	Returns the total number of processed points (i.e.
void	makeEnd ()
	Makes this iterator pointing to the "end" of the cso.
bool	isEnd () const
	Returns if this iterator points to the end of the cso.
CSOPathPointIterator	next () const
	Returns an iterator to the next path point if available and otherwise a CSOPathPointIteratorEnd.
CSOPathPointIterator	prev () const
	Returns an iterator to the prev path point if available and otherwise a CSOPathPointIteratorEnd.
Static Public Attributes
static const unsigned int	INVALID_INDEX

---

Detailed Description

Definition at line 20 of file CSOPathPointIterator.h.

---

Constructor & Destructor Documentation

ml::CSOPathPointIterator::CSOPathPointIterator

(

)

Default constructor.

ml::CSOPathPointIterator::CSOPathPointIterator	(	CSO *	cso,
		unsigned int	startPathIndex = 0,
		unsigned int	startPointIndex = 0
	)

Constructor.

ml::CSOPathPointIterator::CSOPathPointIterator	(	CSO *	cso,
		CSOPathPoints *	pathPoints,
		unsigned int	startPathIndex,
		unsigned int	startPointIndex = 0
	)

Constructor.

ml::CSOPathPointIterator::CSOPathPointIterator	(	CSO *	cso,
		CSOPathPoints *	pathPoints,
		unsigned int	startPointIndex = 0
	)

Constructor.

ml::CSOPathPointIterator::CSOPathPointIterator	(	CSO *	cso,
		CSOSeedPoint *	startSeedPoint
	)

Constructor.

ml::CSOPathPointIterator::CSOPathPointIterator

(

const CSOPathPointIterator &

rhs

)

Copy constructor.

ml::CSOPathPointIterator::~CSOPathPointIterator

(

)

[inline]

Default destructor.

Definition at line 44 of file CSOPathPointIterator.h.

---

Member Function Documentation

CSO* ml::CSOPathPointIterator::getCSO

(

)

[inline]

Returns the cso.

Definition at line 89 of file CSOPathPointIterator.h.

const CSO* ml::CSOPathPointIterator::getCSO

(

)

const [inline]

Returns the cso.

Definition at line 87 of file CSOPathPointIterator.h.

unsigned int ml::CSOPathPointIterator::getPathIndex

(

)

const [inline]

Returns the index of the current path.

Definition at line 92 of file CSOPathPointIterator.h.

CSOPathPoints* ml::CSOPathPointIterator::getPathPoints

(

)

[inline]

Definition at line 99 of file CSOPathPointIterator.h.

const CSOPathPoints* ml::CSOPathPointIterator::getPathPoints

(

)

const [inline]

Definition at line 97 of file CSOPathPointIterator.h.

unsigned int ml::CSOPathPointIterator::getPointIndex

(

)

const [inline]

Returns the index of the current point.

Definition at line 94 of file CSOPathPointIterator.h.

Vector3 ml::CSOPathPointIterator::getPos

(

)

const [inline]

Returns the current point.

Definition at line 102 of file CSOPathPointIterator.h.

const Vector4& ml::CSOPathPointIterator::getPosValue

(

)

const [inline]

Returns the current point including its value.

Definition at line 104 of file CSOPathPointIterator.h.

double ml::CSOPathPointIterator::getValue

(

)

const [inline]

Returns the value of the current point.

Definition at line 106 of file CSOPathPointIterator.h.

bool ml::CSOPathPointIterator::isEnd

(

)

const [inline]

Returns if this iterator points to the end of the cso.

I.e. all points have been processed or the end of the cso has been reached.

Definition at line 130 of file CSOPathPointIterator.h.

void ml::CSOPathPointIterator::makeEnd

(

)

Makes this iterator pointing to the "end" of the cso.

CSOPathPointIterator ml::CSOPathPointIterator::next

(

)

const

Returns an iterator to the next path point if available and otherwise a CSOPathPointIteratorEnd.

unsigned int ml::CSOPathPointIterator::numPoints

(

)

const [inline]

Returns the total number of points of the cso.

Definition at line 116 of file CSOPathPointIterator.h.

unsigned int ml::CSOPathPointIterator::numProcessedPoints

(

)

const [inline]

Returns the number of processed points (relative to the start).

The maximum value returned by this function is equal numPoints()+1.

Definition at line 119 of file CSOPathPointIterator.h.

References ml::mlAbs().

unsigned int ml::CSOPathPointIterator::numTotalProcessedPoints

(

)

const [inline]

Returns the total number of processed points (i.e.

using both increments and decrements). The number returned by this function might be much larger than numPoints() when mixing up increments and decrements.

Definition at line 122 of file CSOPathPointIterator.h.

bool ml::CSOPathPointIterator::operator!=

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

CSOPathPointIterator ml::CSOPathPointIterator::operator+

(

int

offset

)

const

Steps to the next point by the given offest.

CSOPathPointIterator ml::CSOPathPointIterator::operator++

(

int

dummy

)

Steps to the next point on the cso (postfix).

CSOPathPointIterator& ml::CSOPathPointIterator::operator++

(

)

Steps to the next point on the cso (prefix).

CSOPathPointIterator& ml::CSOPathPointIterator::operator+=

(

int

offset

)

Steps to the next point by the given offest.

CSOPathPointIterator ml::CSOPathPointIterator::operator-

(

int

offset

)

const

Steps to the previous point by the given offest.

CSOPathPointIterator ml::CSOPathPointIterator::operator--

(

int

dummy

)

Steps to the previous point on the cso (postfix).

CSOPathPointIterator& ml::CSOPathPointIterator::operator--

(

)

Steps to the previous point on the cso (prefix).

CSOPathPointIterator& ml::CSOPathPointIterator::operator-=

(

int

offset

)

Steps to the previous point by the given offest.

bool ml::CSOPathPointIterator::operator<

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

bool ml::CSOPathPointIterator::operator<=

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

CSOPathPointIterator& ml::CSOPathPointIterator::operator=

(

const CSOPathPointIterator &

rhs

)

Assignment operator.

bool ml::CSOPathPointIterator::operator==

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

bool ml::CSOPathPointIterator::operator>

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

bool ml::CSOPathPointIterator::operator>=

(

const CSOPathPointIterator &

rhs

)

const

Comparison operator.

CSOPathPointIterator ml::CSOPathPointIterator::prev

(

)

const

Returns an iterator to the prev path point if available and otherwise a CSOPathPointIteratorEnd.

void ml::CSOPathPointIterator::setPos

(

const Vector3 &

p

)

[inline]

Sets the current point to the given value.

Definition at line 109 of file CSOPathPointIterator.h.

void ml::CSOPathPointIterator::setPosValue

(

const Vector4 &

p

)

[inline]

Sets the current point and its value to the given value.

Definition at line 111 of file CSOPathPointIterator.h.

void ml::CSOPathPointIterator::setValue

(

const double &

v

)

[inline]

Sets the value of the current point to the given value.

Definition at line 113 of file CSOPathPointIterator.h.

---

Member Data Documentation

const unsigned int ml::CSOPathPointIterator::INVALID_INDEX [static]

Definition at line 26 of file CSOPathPointIterator.h.

---

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

• MeVisLab/Standard/Sources/ML/MLCSO/CSOTools/CSOPathPointIterator.h