MeVisLab Toolbox Reference
ml::CSOPathPointIterator Class Reference

#include <CSOPathPointIterator.h>

Public Member Functions

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

Static Public Attributes

static const unsigned int INVALID_INDEX
 

Detailed Description

Definition at line 25 of file CSOPathPointIterator.h.

Constructor & Destructor Documentation

◆ CSOPathPointIterator() [1/6]

ml::CSOPathPointIterator::CSOPathPointIterator ( )

Default constructor.

◆ CSOPathPointIterator() [2/6]

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

Constructor.

◆ CSOPathPointIterator() [3/6]

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

Constructor.

◆ CSOPathPointIterator() [4/6]

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

Constructor.

◆ CSOPathPointIterator() [5/6]

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

Constructor.

◆ CSOPathPointIterator() [6/6]

ml::CSOPathPointIterator::CSOPathPointIterator ( const CSOPathPointIterator rhs)

Copy constructor.

◆ ~CSOPathPointIterator()

ml::CSOPathPointIterator::~CSOPathPointIterator ( )
default

Default destructor.

Member Function Documentation

◆ getCSO() [1/2]

CSO* ml::CSOPathPointIterator::getCSO ( )
inline

Returns the cso.

Definition at line 94 of file CSOPathPointIterator.h.

◆ getCSO() [2/2]

const CSO* ml::CSOPathPointIterator::getCSO ( ) const
inline

Returns the cso.

Definition at line 92 of file CSOPathPointIterator.h.

◆ getPathIndex()

unsigned int ml::CSOPathPointIterator::getPathIndex ( ) const
inline

Returns the index of the current path.

Definition at line 97 of file CSOPathPointIterator.h.

◆ getPathPoints() [1/2]

CSOPathPoints* ml::CSOPathPointIterator::getPathPoints ( )
inline

Definition at line 104 of file CSOPathPointIterator.h.

◆ getPathPoints() [2/2]

const CSOPathPoints* ml::CSOPathPointIterator::getPathPoints ( ) const
inline

Definition at line 102 of file CSOPathPointIterator.h.

◆ getPointIndex()

unsigned int ml::CSOPathPointIterator::getPointIndex ( ) const
inline

Returns the index of the current point.

Definition at line 99 of file CSOPathPointIterator.h.

◆ getPos()

Vector3 ml::CSOPathPointIterator::getPos ( ) const
inline

Returns the current point.

Definition at line 107 of file CSOPathPointIterator.h.

◆ getPosValue()

const Vector4& ml::CSOPathPointIterator::getPosValue ( ) const
inline

Returns the current point including its value.

Definition at line 109 of file CSOPathPointIterator.h.

◆ getValue()

double ml::CSOPathPointIterator::getValue ( ) const
inline

Returns the value of the current point.

Definition at line 111 of file CSOPathPointIterator.h.

◆ isEnd()

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

References ml::CSOGeometry::INVALID_INDEX.

◆ makeEnd()

void ml::CSOPathPointIterator::makeEnd ( )

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

◆ next()

CSOPathPointIterator ml::CSOPathPointIterator::next ( ) const

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

◆ numPoints()

unsigned int ml::CSOPathPointIterator::numPoints ( ) const
inline

Returns the total number of points of the cso.

Definition at line 121 of file CSOPathPointIterator.h.

◆ numProcessedPoints()

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

References ml::mlAbs().

◆ numTotalProcessedPoints()

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

◆ operator!=()

bool ml::CSOPathPointIterator::operator!= ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ operator+()

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

Steps to the next point by the given offset.

◆ operator++() [1/2]

CSOPathPointIterator& ml::CSOPathPointIterator::operator++ ( )

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

◆ operator++() [2/2]

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

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

◆ operator+=()

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

Steps to the next point by the given offset.

◆ operator-()

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

Steps to the previous point by the given offset.

◆ operator--() [1/2]

CSOPathPointIterator& ml::CSOPathPointIterator::operator-- ( )

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

◆ operator--() [2/2]

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

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

◆ operator-=()

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

Steps to the previous point by the given offset.

◆ operator<()

bool ml::CSOPathPointIterator::operator< ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ operator<=()

bool ml::CSOPathPointIterator::operator<= ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ operator=()

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

Assignment operator.

◆ operator==()

bool ml::CSOPathPointIterator::operator== ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ operator>()

bool ml::CSOPathPointIterator::operator> ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ operator>=()

bool ml::CSOPathPointIterator::operator>= ( const CSOPathPointIterator rhs) const

Comparison operator.

◆ prev()

CSOPathPointIterator ml::CSOPathPointIterator::prev ( ) const

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

◆ resetCounters()

void ml::CSOPathPointIterator::resetCounters ( )
inline

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

Definition at line 132 of file CSOPathPointIterator.h.

◆ setPos()

void ml::CSOPathPointIterator::setPos ( const Vector3 p)
inline

Sets the current point to the given value.

Definition at line 114 of file CSOPathPointIterator.h.

◆ setPosValue()

void ml::CSOPathPointIterator::setPosValue ( const Vector4 p)
inline

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

Definition at line 116 of file CSOPathPointIterator.h.

◆ setValue()

void ml::CSOPathPointIterator::setValue ( const double &  v)
inline

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

Definition at line 118 of file CSOPathPointIterator.h.

Member Data Documentation

◆ INVALID_INDEX

const unsigned int ml::CSOPathPointIterator::INVALID_INDEX
static

Definition at line 31 of file CSOPathPointIterator.h.


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