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 where it1 and it2 are 2 StrokeVertexIterator. Otherwise, incrementing it1 will also increment it2.
Constructor & Destructor Documentation
Member Function Documentation
virtual void decrement |
( |
|
) |
[inline, virtual] |
|
virtual string getExactTypeName |
( |
|
) |
const [inline, virtual] |
|
|
Returns the string "StrokeVertexIterator". |
virtual void increment |
( |
|
) |
[inline, virtual] |
|
bool isBegin |
( |
|
) |
const [inline] |
|
bool isEnd |
( |
|
) |
const [inline] |
|
|
Returns a reference to the pointed StrokeVertex. In the scripting language, you must call "getObject()"instead. |
|
Increments. In the scripting language, call "increment()". |
|
Increments. In the scripting language, call "increment()". |
|
Decrements. In the scripting language, call "decrement()". |
|
Decrements. In the scripting language, call "decrement()". |
|
Returns a pointer to the pointed StrokeVertex. Can't be called in the scripting language. |
|
operator= - Attention:
- In the scripting language, you must call instead of where it1 and it2 are 2 StrokeVertexIterator. Otherwise, incrementing it1 will also increment it2.
|
virtual bool operator== |
( |
const Interface0DIteratorNested & |
it |
) |
const [inline, virtual] |
|
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: