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

ViewEdge Class Reference

#include <ViewMap.h>

Inheritance diagram for ViewEdge:

Interface1D List of all members.

Detailed Description

Class defining a ViewEdge. A ViewEdge in an edge of the image graph. it connnects two ViewVertex. It is made by connecting a set of FEdges.


Public Member Functions

virtual string getExactTypeName () const
virtual Id getId () const
virtual Nature::EdgeNature getNature () const
 ViewEdge ()
virtual ~ViewEdge ()
ViewVertex * A ()
ViewVertex * B ()
FEdge * fedgeA ()
FEdge * fedgeB ()
ViewShape * viewShape ()
ViewShape * aShape ()
bool isClosed ()
unsigned getChainingTimeStamp ()
void SetA (ViewVertex *iA)
void SetB (ViewVertex *iB)
void SetNature (Nature::EdgeNature iNature)
void SetFEdgeA (FEdge *iFEdge)
void SetFEdgeB (FEdge *iFEdge)
void SetShape (ViewShape *iVShape)
void SetId (const Id &id)
void UpdateFEdges ()
void SetaShape (ViewShape *iShape)
void SetQI (int qi)
void setChainingTimeStamp (unsigned ts)
real getLength2D () const
virtual Interface0DIterator verticesBegin ()
virtual Interface0DIterator verticesEnd ()
virtual Interface0DIterator pointsBegin (float t=0.f)
virtual Interface0DIterator pointsEnd (float t=0.f)

Public Attributes

void * userdata

Protected Member Functions

 ViewEdge (ViewEdge &iBrother)
virtual ViewEdge * dupplicate ()

Friends

class ViewShape

Constructor & Destructor Documentation

ViewEdge (   )  [inline]
 

Default constructor.

ViewEdge (  ViewEdge &  iBrother  )  [inline, protected]
 

Copy constructor.

virtual ~ViewEdge (   )  [inline, virtual]
 

Destructor.

Member Function Documentation

ViewVertex* A (   )  [inline]
 

Returns the first ViewVertex.

ViewShape* aShape (   )  [inline]
 

Returns the shape that is occluded by the ViewShape to which this ViewEdge belongs to. If no object is occluded, 0 is returned.

Returns:
The occluded ViewShape.

ViewVertex* B (   )  [inline]
 

Returns the second ViewVertex.

virtual ViewEdge* dupplicate (   )  [inline, protected, virtual]
 

Cloning method.

FEdge* fedgeA (   )  [inline]
 

Returns the first FEdge that constitues this ViewEdge.

FEdge* fedgeB (   )  [inline]
 

Returns the last FEdge that constitues this ViewEdge.

unsigned getChainingTimeStamp (   )  [inline]
 

Returns the time stamp of this ViewEdge.

virtual string getExactTypeName (   )  const [inline, virtual]
 

Returns the string "ViewEdge" .

Reimplemented from Interface1D.

virtual Id getId (   )  const [inline, virtual]
 

Returns the Id of the vertex .

Reimplemented from Interface1D.

real getLength2D (   )  const [virtual]
 

Returns the 2D length of the Viewedge.

Reimplemented from Interface1D.

virtual Nature::EdgeNature getNature (   )  const [inline, virtual]
 

Returns the nature of the ViewEdge.

Reimplemented from Interface1D.

bool isClosed (   )  [inline]
 

Tells whether this ViewEdge forms a closed loop or not.

virtual Interface0DIterator pointsBegin (  float  t = 0.f  )  [virtual]
 

Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. The returned Interface0DIterator points on the first Point of the ViewEdge.

Parameters:
t the sampling value.

Implements Interface1D.

virtual Interface0DIterator pointsEnd (  float  t = 0.f  )  [virtual]
 

Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. The returned Interface0DIterator points after the last Point of the ViewEdge.

Parameters:
t the sampling value.

Implements Interface1D.

void SetA (  ViewVertex *  iA  )  [inline]
 

Sets the first ViewVertex of the ViewEdge.

void SetaShape (  ViewShape *  iShape  )  [inline]
 

Sets the occluded ViewShape

void SetB (  ViewVertex *  iB  )  [inline]
 

Sets the last ViewVertex of the ViewEdge.

void setChainingTimeStamp (  unsigned  ts  )  [inline]
 

Sets the time stamp value.

void SetFEdgeA (  FEdge *  iFEdge  )  [inline]
 

Sets the first FEdge of the ViewEdge.

void SetFEdgeB (  FEdge *  iFEdge  )  [inline]
 

Sets the last FEdge of the ViewEdge.

void SetId (  const Id &  id  )  [inline]
 

Sets the ViewEdge id.

void SetNature (  Nature::EdgeNature  iNature  )  [inline]
 

Sets the nature of the ViewEdge.

void SetQI (  int  qi  )  [inline]
 

Sets the quantitative invisibility value.

void SetShape (  ViewShape *  iVShape  )  [inline]
 

Sets the ViewShape to which this ViewEdge belongs to.

void UpdateFEdges (   ) 
 

Sets Viewedge to this for all embedded fedges

virtual Interface0DIterator verticesBegin (   )  [virtual]
 

Returns an Interface0DIterator to iterate over the SVertex constituing the embedding of this ViewEdge. The returned Interface0DIterator points to the first SVertex of the ViewEdge.

Implements Interface1D.

virtual Interface0DIterator verticesEnd (   )  [virtual]
 

Returns an Interface0DIterator to iterate over the SVertex constituing the embedding of this ViewEdge. The returned Interface0DIterator points after the last SVertex of the ViewEdge.

Implements Interface1D.

ViewShape* viewShape (   )  [inline]
 

Returns the ViewShape to which this ViewEdge belongs to .

Member Data Documentation

void* userdata
 

A field that can be used by the user to store any data. This field must be reseted afterwards using ResetUserData().

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