#include <CSOPathPointIterator.h>

Public Member Functions
	CSOPathPointConstIterator ()
	Default constructor.

	CSOPathPointConstIterator (const CSO *cso, unsigned int startPathIndex=0, unsigned int startPointIndex=0)
	Constructor.

	CSOPathPointConstIterator (const CSO cso, const CSOPathPoints pathPoints, unsigned int startPathIndex, unsigned int startPointIndex=0)
	Constructor.

	CSOPathPointConstIterator (const CSO cso, const CSOPathPoints pathPoints, unsigned int startPointIndex=0)
	Constructor.

	CSOPathPointConstIterator (const CSO cso, const CSOSeedPoint startSeedPoint)
	Constructor.

	CSOPathPointConstIterator (const CSOPathPointConstIterator &rhs)
	Copy constructor.

	~CSOPathPointConstIterator ()=default
	Default destructor.

CSOPathPointConstIterator &	operator++ ()
	Steps to the next point on the CSO (prefix).

CSOPathPointConstIterator	operator++ (int dummy)
	Steps to the next point on the CSO (postfix).

CSOPathPointConstIterator &	operator-- ()
	Steps to the previous point on the CSO (prefix).

CSOPathPointConstIterator	operator-- (int dummy)
	Steps to the previous point on the CSO (postfix).

CSOPathPointConstIterator &	operator+= (int offset)
	Steps to the next point by the given offset.

CSOPathPointConstIterator &	operator-= (int offset)
	Steps to the previous point by the given offset.

CSOPathPointConstIterator	operator+ (int offset) const
	Steps to the next point by the given offset.

CSOPathPointConstIterator	operator- (int offset) const
	Steps to the previous point by the given offset.

CSOPathPointConstIterator &	operator= (const CSOPathPointConstIterator &rhs)
	Assignment operator.

bool	operator== (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

bool	operator!= (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

bool	operator> (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

bool	operator>= (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

bool	operator< (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

bool	operator<= (const CSOPathPointConstIterator &rhs) const
	Comparison operator.

const CSO *	getCSO () const
	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

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.

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	resetCounters ()
	Resets the internal counters that define the number of processed points.

void	makeEnd ()
	Makes this iterator pointing to the "end" of the CSO.

bool	isEnd () const
	Returns whether this iterator points to the end of the CSO.

CSOPathPointConstIterator	next () const
	Returns an iterator to the next path point if available and otherwise a CSOPathPointIteratorEnd.

CSOPathPointConstIterator	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 186 of file CSOPathPointIterator.h.

Constructor & Destructor Documentation

◆ CSOPathPointConstIterator() [1/6]

ml::CSOPathPointConstIterator::CSOPathPointConstIterator ( )

Default constructor.

◆ CSOPathPointConstIterator() [2/6]

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

Constructor.

◆ CSOPathPointConstIterator() [3/6]

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

Constructor.

◆ CSOPathPointConstIterator() [4/6]

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

Constructor.

◆ CSOPathPointConstIterator() [5/6]

ml::CSOPathPointConstIterator::CSOPathPointConstIterator	(	const CSO *	cso,
		const CSOSeedPoint *	startSeedPoint )

Constructor.

◆ CSOPathPointConstIterator() [6/6]

ml::CSOPathPointConstIterator::CSOPathPointConstIterator ( const CSOPathPointConstIterator & rhs )

Copy constructor.

◆ ~CSOPathPointConstIterator()

ml::CSOPathPointConstIterator::~CSOPathPointConstIterator ( )

default

Default destructor.

Member Function Documentation

◆ getCSO()

const CSO * ml::CSOPathPointConstIterator::getCSO ( ) const

inline

Returns the CSO.

Definition at line 253 of file CSOPathPointIterator.h.

◆ getPathIndex()

unsigned int ml::CSOPathPointConstIterator::getPathIndex ( ) const

inline

Returns the index of the current path.

Definition at line 256 of file CSOPathPointIterator.h.

◆ getPathPoints()

const CSOPathPoints * ml::CSOPathPointConstIterator::getPathPoints ( ) const

inline

Definition at line 261 of file CSOPathPointIterator.h.

◆ getPointIndex()

unsigned int ml::CSOPathPointConstIterator::getPointIndex ( ) const

inline

Returns the index of the current point.

Definition at line 258 of file CSOPathPointIterator.h.

◆ getPos()

Vector3 ml::CSOPathPointConstIterator::getPos ( ) const

inline

Returns the current point.

Definition at line 264 of file CSOPathPointIterator.h.

◆ getPosValue()

const Vector4 & ml::CSOPathPointConstIterator::getPosValue ( ) const

inline

Returns the current point including its value.

Definition at line 266 of file CSOPathPointIterator.h.

◆ getValue()

double ml::CSOPathPointConstIterator::getValue ( ) const

inline

Returns the value of the current point.

Definition at line 268 of file CSOPathPointIterator.h.

◆ isEnd()

bool ml::CSOPathPointConstIterator::isEnd ( ) const

inline

Returns whether 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 290 of file CSOPathPointIterator.h.

◆ makeEnd()

void ml::CSOPathPointConstIterator::makeEnd ( )

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

◆ next()

CSOPathPointConstIterator ml::CSOPathPointConstIterator::next ( ) const

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

◆ numPoints()

unsigned int ml::CSOPathPointConstIterator::numPoints ( ) const

inline

Returns the total number of points of the CSO.

Definition at line 271 of file CSOPathPointIterator.h.

◆ numProcessedPoints()

unsigned int ml::CSOPathPointConstIterator::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 274 of file CSOPathPointIterator.h.

References ml::mlAbs().

◆ numTotalProcessedPoints()

unsigned int ml::CSOPathPointConstIterator::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 277 of file CSOPathPointIterator.h.

◆ operator!=()

bool ml::CSOPathPointConstIterator::operator!= ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ operator+()

CSOPathPointConstIterator ml::CSOPathPointConstIterator::operator+ ( int offset ) const

Steps to the next point by the given offset.

◆ operator++() [1/2]

CSOPathPointConstIterator & ml::CSOPathPointConstIterator::operator++ ( )

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

◆ operator++() [2/2]

CSOPathPointConstIterator ml::CSOPathPointConstIterator::operator++ ( int dummy )

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

◆ operator+=()

CSOPathPointConstIterator & ml::CSOPathPointConstIterator::operator+= ( int offset )

Steps to the next point by the given offset.

◆ operator-()

CSOPathPointConstIterator ml::CSOPathPointConstIterator::operator- ( int offset ) const

Steps to the previous point by the given offset.

◆ operator--() [1/2]

CSOPathPointConstIterator & ml::CSOPathPointConstIterator::operator-- ( )

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

◆ operator--() [2/2]

CSOPathPointConstIterator ml::CSOPathPointConstIterator::operator-- ( int dummy )

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

◆ operator-=()

CSOPathPointConstIterator & ml::CSOPathPointConstIterator::operator-= ( int offset )

Steps to the previous point by the given offset.

◆ operator<()

bool ml::CSOPathPointConstIterator::operator< ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ operator<=()

bool ml::CSOPathPointConstIterator::operator<= ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ operator=()

CSOPathPointConstIterator & ml::CSOPathPointConstIterator::operator= ( const CSOPathPointConstIterator & rhs )

Assignment operator.

◆ operator==()

bool ml::CSOPathPointConstIterator::operator== ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ operator>()

bool ml::CSOPathPointConstIterator::operator> ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ operator>=()

bool ml::CSOPathPointConstIterator::operator>= ( const CSOPathPointConstIterator & rhs ) const

Comparison operator.

◆ prev()

CSOPathPointConstIterator ml::CSOPathPointConstIterator::prev ( ) const

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

◆ resetCounters()

void ml::CSOPathPointConstIterator::resetCounters ( )

inline

Resets the internal counters that define the number of processed points.

Definition at line 282 of file CSOPathPointIterator.h.

Member Data Documentation

◆ INVALID_INDEX

const unsigned int ml::CSOPathPointConstIterator::INVALID_INDEX

static

Definition at line 192 of file CSOPathPointIterator.h.

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

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

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CSOPathPointConstIterator() [1/6]

◆ CSOPathPointConstIterator() [2/6]

◆ CSOPathPointConstIterator() [3/6]

◆ CSOPathPointConstIterator() [4/6]

◆ CSOPathPointConstIterator() [5/6]

◆ CSOPathPointConstIterator() [6/6]

◆ ~CSOPathPointConstIterator()

Member Function Documentation

◆ getCSO()

◆ getPathIndex()

◆ getPathPoints()

◆ getPointIndex()

◆ getPos()

◆ getPosValue()

◆ getValue()

◆ isEnd()

◆ makeEnd()

◆ next()

◆ numPoints()

◆ numProcessedPoints()

◆ numTotalProcessedPoints()

◆ operator!=()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ prev()

◆ resetCounters()

Member Data Documentation

◆ INVALID_INDEX