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

ViewEdgeIterator Class Reference

#include <ViewMapIterators.h>

Inheritance diagram for ViewEdgeIterator:

ChainingIterator ChainPredicateIterator ChainSilhouetteIterator 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.


Public Member Functions

 ViewEdgeIterator (ViewEdge *begin=0, bool orientation=true)
 ViewEdgeIterator (const ViewEdgeIterator &it)
virtual string getExactTypeName () const
ViewEdgegetCurrentEdge ()
void setCurrentEdge (ViewEdge *edge)
ViewEdgegetBegin ()
void setBegin (ViewEdge *begin)
bool getOrientation () const
void setOrientation (bool orientation)
void changeOrientation ()
virtual ViewEdgeoperator * ()
virtual ViewEdgeIteratoroperator++ ()
virtual ViewEdgeIterator operator++ (int)
virtual void increment ()
virtual ViewEdgeIteratoroperator-- ()
virtual ViewEdgeIterator operator-- (int)
virtual void decrement ()
virtual bool isBegin () const
virtual bool isEnd () const
virtual bool operator== (ViewEdgeIterator &it) const
virtual bool operator!= (ViewEdgeIterator &it) const

Constructor & Destructor Documentation

ViewEdgeIterator ViewEdge begin = 0,
bool  orientation = true
[inline]
 

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.

ViewEdgeIterator const ViewEdgeIterator it  )  [inline]
 

Copy constructor


Member Function Documentation

void changeOrientation  )  [inline]
 

Changes the current orientation.

virtual void decrement  )  [inline, virtual]
 

decrements.

Reimplemented in ChainingIterator.

ViewEdge* getBegin  )  [inline]
 

Returns the first ViewEdge used for the iteration.

ViewEdge* getCurrentEdge  )  [inline]
 

Returns the current pointed ViewEdge.

virtual string getExactTypeName  )  const [inline, virtual]
 

Returns the string "ViewEdgeIterator"

Reimplemented in ChainingIterator, ChainSilhouetteIterator, and ChainPredicateIterator.

bool getOrientation  )  const [inline]
 

Gets the orientation of the pointed ViewEdge in the iteration.

virtual void increment  )  [inline, virtual]
 

increments.

Reimplemented in ChainingIterator.

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.

virtual bool operator!= ViewEdgeIterator it  )  const [inline, virtual]
 

operator !=

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

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

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

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

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

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

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

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

virtual bool operator== ViewEdgeIterator it  )  const [inline, virtual]
 

operator ==

void setBegin ViewEdge begin  )  [inline]
 

Sets the first ViewEdge used for the iteration.

void setCurrentEdge ViewEdge edge  )  [inline]
 

Sets the current pointed ViewEdge.

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: