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

Interface1D Class Reference

#include <Interface1D.h>

Inheritance diagram for Interface1D:

Curve FEdge Stroke ViewEdge Chain FEdgeSharp FEdgeSmooth List of all members.

Detailed Description

Base class for any 1D element.


Public Member Functions

 Interface1D ()
virtual string getExactTypeName () const
virtual Interface0DIterator verticesBegin ()=0
virtual Interface0DIterator verticesEnd ()=0
virtual Interface0DIterator pointsBegin (float t=0.f)=0
virtual Interface0DIterator pointsEnd (float t=0.f)=0
virtual real getLength2D () const
virtual Id getId () const
virtual Nature::EdgeNature getNature () const
virtual unsigned getTimeStamp () const
void setTimeStamp (unsigned iTimeStamp)

Constructor & Destructor Documentation

Interface1D  )  [inline]
 

Default constructor


Member Function Documentation

virtual string getExactTypeName  )  const [inline, virtual]
 

Returns the string "Interface1D" .

Reimplemented in FEdge, ViewEdge, and Stroke.

virtual Id getId  )  const [inline, virtual]
 

Returns the Id of the 1D element .

Reimplemented in FEdge, ViewEdge, Stroke, and Curve.

virtual real getLength2D  )  const [inline, virtual]
 

Returns the 2D length of the 1D element.

Reimplemented in FEdge, ViewEdge, Stroke, and Curve.

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

Returns the nature of the 1D element.

Reimplemented in FEdge, and ViewEdge.

virtual unsigned getTimeStamp  )  const [inline, virtual]
 

Returns the time stamp of the 1D element. Mainly used for selection.

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

Returns an iterator over the Interface1D points, pointing to the first point. The difference with verticesBegin() is that here we can iterate over points of the 1D element at a any given sampling. Indeed, for each iteration, a virtual point is created.

Parameters:
t The sampling with which we want to iterate over points of this 1D element.

Implemented in FEdge, ViewEdge, Stroke, and Curve.

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

Returns an iterator over the Interface1D points, pointing after the last point. The difference with verticesEnd() is that here we can iterate over points of the 1D element at a any given sampling. Indeed, for each iteration, a virtual point is created.

Parameters:
t The sampling with which we want to iterate over points of this 1D element.

Implemented in FEdge, ViewEdge, Stroke, and Curve.

void setTimeStamp unsigned  iTimeStamp  )  [inline]
 

Sets the time stamp for the 1D element.

virtual Interface0DIterator verticesBegin  )  [pure virtual]
 

Returns an iterator over the Interface1D vertices, pointing to the first vertex.

Implemented in FEdge, ViewEdge, Stroke, and Curve.

virtual Interface0DIterator verticesEnd  )  [pure virtual]
 

Returns an iterator over the Interface1D vertices, pointing after the last vertex.

Implemented in FEdge, ViewEdge, Stroke, and Curve.


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