h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

StrokeVertexIterator Class Reference

#include <StrokeIterators.h>

List of all members.


Detailed Description

Class defining an iterator designed to iterate over the StrokeVertex of a Stroke. An instance of a StrokeVertexIterator can only be obtained from a Stroke by calling strokeVerticesBegin() or strokeVerticesEnd(). It is iterating over the same vertices as an Interface0DIterator. The difference resides in the object access. Indeed, an Interface0DIterator allows only an access to an Interface0D whereas we could need to access the specialized StrokeVertex type. In this case, one should use a StrokeVertexIterator. The castToInterface0DIterator() method is useful to get an Interface0DIterator from a StrokeVertexIterator in order to call any functions of the type UnaryFunction0D.
Attention:
In the scripting language, you must call instead of
 it2 = it1 
where it1 and it2 are 2 StrokeVertexIterator. Otherwise, incrementing it1 will also increment it2.


Public Member Functions

 StrokeVertexIterator ()
 StrokeVertexIterator (const StrokeVertexIterator &vi)
Interface0DIterator castToInterface0DIterator () const
StrokeVertexIteratoroperator= (const StrokeVertexIterator &vi)
virtual string getExactTypeName () const
virtual StrokeVertexoperator * ()
virtual StrokeVertexoperator-> ()
virtual StrokeVertexIteratoroperator++ ()
virtual StrokeVertexIterator operator++ (int)
virtual StrokeVertexIteratoroperator-- ()
virtual StrokeVertexIterator operator-- (int)
virtual void increment ()
virtual void decrement ()
bool isBegin () const
bool isEnd () const
virtual bool operator== (const Interface0DIteratorNested &it) const
virtual float t () const
virtual float u () const
virtual StrokeVertexIteratorcopy () const

Constructor & Destructor Documentation

StrokeVertexIterator  )  [inline]
 

Default constructor.

StrokeVertexIterator const StrokeVertexIterator vi  )  [inline]
 

Copy constructor.


Member Function Documentation

Interface0DIterator castToInterface0DIterator  )  const [inline]
 

Casts this StrokeVertexIterator into an Interface0DIterator. Useful for any call to a function of the type UnaryFunction0D.

virtual StrokeVertexIterator* copy  )  const [inline, virtual]
 

Cloning method

virtual void decrement  )  [inline, virtual]
 

Decrements.

virtual string getExactTypeName  )  const [inline, virtual]
 

Returns the string "StrokeVertexIterator".

virtual void increment  )  [inline, virtual]
 

Increments.

bool isBegin  )  const [inline]
 

Returns true if the pointed StrokeVertex is the first of the Stroke.

bool isEnd  )  const [inline]
 

Returns true if the pointed StrokeVertex is after the last StrokeVertex of the Stroke.

virtual StrokeVertex& operator *  )  [inline, virtual]
 

Returns a reference to the pointed StrokeVertex. In the scripting language, you must call "getObject()"instead.

virtual StrokeVertexIterator operator++ int   )  [inline, virtual]
 

Increments. In the scripting language, call "increment()".

virtual StrokeVertexIterator& operator++  )  [inline, virtual]
 

Increments. In the scripting language, call "increment()".

virtual StrokeVertexIterator operator-- int   )  [inline, virtual]
 

Decrements. In the scripting language, call "decrement()".

virtual StrokeVertexIterator& operator--  )  [inline, virtual]
 

Decrements. In the scripting language, call "decrement()".

virtual StrokeVertex* operator->  )  [inline, virtual]
 

Returns a pointer to the pointed StrokeVertex. Can't be called in the scripting language.

StrokeVertexIterator& operator= const StrokeVertexIterator vi  )  [inline]
 

operator=

Attention:
In the scripting language, you must call instead of
 it2 = it1 
where it1 and it2 are 2 StrokeVertexIterator. Otherwise, incrementing it1 will also increment it2.

virtual bool operator== const Interface0DIteratorNested &  it  )  const [inline, virtual]
 

operator ==

virtual float t  )  const [inline, virtual]
 

Returns the curvilinear abscissa of the current point

virtual float u  )  const [inline, virtual]
 

Returns the point's parameter in the stroke


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