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

Curve Class Reference

#include <Curve.h>

Inheritance diagram for Curve:

Interface1D Chain List of all members.

Detailed Description

Base class for curves made of CurvePoints. SVertex is the type of the initial curve vertices. A Chain is a specialization of a Curve.


Public Member Functions

 Curve ()
 Curve (const Id &id)
 Curve (const Curve &iBrother)
virtual ~Curve ()
void push_vertex_back (Vertex *iVertex)
void push_vertex_back (SVertex *iVertex)
void push_vertex_front (Vertex *iVertex)
void push_vertex_front (SVertex *iVertex)
bool empty () const
real getLength2D () const
virtual Id getId () const
unsigned int nSegments () const
point_iterator points_begin (float step=0)
virtual Interface0DIterator verticesBegin ()
virtual Interface0DIterator verticesEnd ()
virtual Interface0DIterator pointsBegin (float t=0.f)
virtual Interface0DIterator pointsEnd (float t=0.f)

Constructor & Destructor Documentation

Curve (   )  [inline]
 

Default Constructor.

Curve (  const Id &  id  )  [inline]
 

Builds a Curve from its id

Curve (  const Curve &  iBrother  )  [inline]
 

Copy Constructor.

virtual ~Curve (   )  [virtual]
 

Destructor.

Member Function Documentation

bool empty (   )  const [inline]
 

Returns true is the Curve doesn't have any Vertex yet.

virtual Id getId (   )  const [inline, virtual]
 

Returns the Id of the 1D element .

Reimplemented from Interface1D.

real getLength2D (   )  const [inline, virtual]
 

Returns the 2D length of the Curve.

Reimplemented from Interface1D.

unsigned int nSegments (   )  const [inline]
 

Returns the number of segments in the oplyline constituing the Curve.

point_iterator points_begin (  float  step = 0  ) 
 

angle in radians

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

Returns an Interface0DIterator pointing onto the first point of the Curve and that can iterate over the points of the Curve at any resolution. At each iteration a virtual temporary CurvePoint is created.

Implements Interface1D.

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

Returns an Interface0DIterator pointing after the last point of the Curve and that can iterate over the points of the Curve at any resolution. At each iteration a virtual temporary CurvePoint is created.

Implements Interface1D.

void push_vertex_back (  SVertex *  iVertex  )  [inline]
 

Adds a single vertex (SVertex) at the end of the Curve

void push_vertex_back (  Vertex *  iVertex  )  [inline]
 

Adds a single vertex (CurvePoint) at the end of the Curve

void push_vertex_front (  SVertex *  iVertex  )  [inline]
 

Adds a single vertex (SVertex) at the front of the Curve

void push_vertex_front (  Vertex *  iVertex  )  [inline]
 

Adds a single vertex (CurvePoint) at the front of the Curve

virtual Interface0DIterator verticesBegin (   )  [virtual]
 

Returns an Interface0DIterator pointing onto the first vertex of the Curve and that can iterate over the vertices of the Curve.

Implements Interface1D.

virtual Interface0DIterator verticesEnd (   )  [virtual]
 

Returns an Interface0DIterator pointing after the last vertex of the Curve and that can iterate over the vertices of the Curve.

Implements Interface1D.

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