ViewEdgeIterator Class Reference
#include <ViewMapIterators.h>
Inheritance diagram for ViewEdgeIterator:
List of all members.
Detailed Description
Base class for iterators over ViewEdges of the
ViewMap Graph. Basically the "increment()" operator of this class should be able to take the decision of "where" (on which
ViewEdge) to go when pointing on a given
ViewEdge. ::Caution::: the dereferencing operator returns a *pointer* to the pointed
ViewEdge.
Constructor & Destructor Documentation
|
Builds a ViewEdgeIterator from a starting ViewEdge and its orientation. - Parameters:
-
| begin | The ViewEdge from where to start the iteration. |
| orientation | If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin. |
|
Member Function Documentation
void changeOrientation |
( |
|
) |
[inline] |
|
|
Changes the current orientation. |
virtual void decrement |
( |
|
) |
[inline, virtual] |
|
|
Returns the first ViewEdge used for the iteration. |
virtual string getExactTypeName |
( |
|
) |
const [inline, virtual] |
|
bool getOrientation |
( |
|
) |
const [inline] |
|
|
Gets the orientation of the pointed ViewEdge in the iteration. |
virtual void increment |
( |
|
) |
[inline, virtual] |
|
virtual bool isBegin |
( |
|
) |
const [inline, virtual] |
|
|
Returns true if the pointed ViewEdge is the first one used for the iteration. |
virtual bool isEnd |
( |
|
) |
const [inline, virtual] |
|
|
Returns true if the pointed ViewEdge* equals 0. |
virtual ViewEdge* operator * |
( |
|
) |
[inline, virtual] |
|
|
Returns a *pointer* to the pointed ViewEdge. |
|
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()". |
void setBegin |
( |
ViewEdge * |
begin |
) |
[inline] |
|
|
Sets the first ViewEdge used for the iteration. |
void setCurrentEdge |
( |
ViewEdge * |
edge |
) |
[inline] |
|
void setOrientation |
( |
bool |
orientation |
) |
[inline] |
|
|
Sets the orientation of the pointed ViewEdge in the iteration. |
The documentation for this class was generated from the following file: