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

StrokeVertex Class Reference

#include <Stroke.h>

Inheritance diagram for StrokeVertex:

CurvePoint Interface0D List of all members.

Detailed Description

Class to define a stroke vertex.


Public Member Functions

virtual string getExactTypeName () const
 StrokeVertex ()
 StrokeVertex (const StrokeVertex &iBrother)
 StrokeVertex (SVertex *iSVertex)
 StrokeVertex (CurvePoint *iPoint)
 StrokeVertex (StrokeVertex *iA, StrokeVertex *iB, float t3)
 StrokeVertex (SVertex *iSVertex, const StrokeAttribute &iAttribute)
virtual ~StrokeVertex ()
StrokeVertex & operator= (const StrokeVertex &iBrother)
real x () const
real y () const
Vec2f getPoint ()
real operator[] (const int i) const
const StrokeAttribute & attribute () const
StrokeAttribute & attribute ()
float curvilinearAbscissa () const
float strokeLength () const
float u () const
void SetX (real x)
void SetY (real y)
void SetPoint (real x, real y)
void SetPoint (const Vec2f &p)
real & operator[] (const int i)
void SetAttribute (const StrokeAttribute &iAttribute)
void SetCurvilinearAbscissa (float iAbscissa)
void SetStrokeLength (float iLength)

Constructor & Destructor Documentation

StrokeVertex (   ) 
 

default constructor

StrokeVertex (  const StrokeVertex &  iBrother  ) 
 

Copy constructor

StrokeVertex (  SVertex *  iSVertex  ) 
 

Builds a stroke vertex from a SVertex

StrokeVertex (  CurvePoint *  iPoint  ) 
 

Builds a stroke vertex from a CurvePoint

StrokeVertex (  StrokeVertex *  iA,
StrokeVertex *  iB,
float  t3
) 
 

Builds Stroke Vertex from 2 stroke vertices and an interpolation parameter

StrokeVertex (  SVertex *  iSVertex,
const StrokeAttribute &  iAttribute
) 
 

Builds a stroke from a view vertex and an attribute

virtual ~StrokeVertex (   )  [virtual]
 

destructor

Member Function Documentation

StrokeAttribute& attribute (   )  [inline]
 

Returns a non-const reference to the StrokeAttribute of this StrokeVertex

const StrokeAttribute& attribute (   )  const [inline]
 

Returns the StrokeAttribute for this StrokeVertex

float curvilinearAbscissa (   )  const [inline]
 

Returns the curvilinear abscissa

virtual string getExactTypeName (   )  const [inline, virtual]
 

Returns the string "StrokeVertex"

Reimplemented from CurvePoint.

Vec2f getPoint (   )  [inline]
 

Returns the 2D point coordinates as a Vec2d

StrokeVertex& operator= (  const StrokeVertex &  iBrother  ) 
 

operator =

real& operator[] (  const int  i  )  [inline]
 

Returns a reference to the ith 2D point coordinate (i=0 or 1)

real operator[] (  const int  i  )  const [inline]
 

Returns the ith 2D point coordinate (i=0 or 1)

void SetAttribute (  const StrokeAttribute &  iAttribute  )  [inline]
 

Sets the attribute.

void SetCurvilinearAbscissa (  float  iAbscissa  )  [inline]
 

Sets the curvilinear abscissa of this StrokeVertex in the Stroke

void SetPoint (  const Vec2f &  p  )  [inline]
 

Sets the 2D x and y values

void SetPoint (  real  x,
real  y
)  [inline]
 

Sets the 2D x and y values

void SetStrokeLength (  float  iLength  )  [inline]
 

Sets the Stroke's length (it's only a value stored by the Stroke Vertex, it won't change the real Stroke's length.)

void SetX (  real  x  )  [inline]
 

Sets the 2D x value

void SetY (  real  y  )  [inline]
 

Sets the 2D y value

float strokeLength (   )  const [inline]
 

Returns the length of the Stroke to which this StrokeVertex belongs

float u (   )  const [inline]
 

Returns the curvilinear abscissa of this StrokeVertex in the Stroke

real x (   )  const [inline]
 

Returns the 2D point x coordinate

real y (   )  const [inline]
 

Returns the 2D point y coordinate

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