sftools::CurveInfo Struct Reference

Holds all informations used to compute the points of a curve. More...

#include <Curve.hpp>

Collaboration diagram for sftools::CurveInfo:

Static Public Member Functions
static CurveInfo	elipse (float a, float b, float begin, float end, unsigned int pointCount)
	Build a CurveInfo that represents an elipse.
static CurveInfo	circle (float r, float begin, float end, unsigned int pointCount)
	Build a CurveInfo that represents a circle.
static CurveInfo	sine (float a, float b, float begin, float end, unsigned int pointCount)
	Build a CurveInfo that represents a sine.
static CurveInfo	cosine (float a, float b, float begin, float end, unsigned int pointCount)
	Build a CurveInfo that represents a cosine.
static CurveInfo	astroid (float a, float begin, float end, unsigned int pointCount)
	Build a CurveInfo that represents an astroid.

Public Attributes
CurveFunction	f
	Curve's function.
float	begin
	First value of the curve's parameter.
float	end
	Last value of the curve's parameter.
unsigned int	pointCount
	"Resolution" of the curve

Detailed Description

Holds all informations used to compute the points of a curve.

The curve's points are computed with f(p) where p is in the range [begin, end]. PointCount defines the "resolution" or "accuracy" of the computation.

See Also

Curve

Definition at line 54 of file Curve.hpp.

Member Function Documentation

static CurveInfo sftools::CurveInfo::astroid ( float  a, float  begin, float  end, unsigned int  pointCount  )

inlinestatic

Build a CurveInfo that represents an astroid.

Parameters

a	half astroid-size
begin	start angle in radian
end	end angle in radian
pointCount	"resolution" or "accuracy" of the computation.

Definition at line 132 of file Curve.hpp.

References begin, end, and f.

static CurveInfo sftools::CurveInfo::circle ( float  r, float  begin, float  end, unsigned int  pointCount  )

inlinestatic

Build a CurveInfo that represents a circle.

Parameters

r	radius
begin	start angle in radian
end	end angle in radian
pointCount	"resolution" or "accuracy" of the computation.

Definition at line 83 of file Curve.hpp.

References elipse().

static CurveInfo sftools::CurveInfo::cosine ( float  a, float  b, float  begin, float  end, unsigned int  pointCount  )

inlinestatic

Build a CurveInfo that represents a cosine.

Parameters

a	x-axis factor
b	y-axis factor
begin	start angle in radian
end	end angle in radian
pointCount	"resolution" or "accuracy" of the computation.

Definition at line 115 of file Curve.hpp.

References begin, end, and f.

static CurveInfo sftools::CurveInfo::elipse ( float  a, float  b, float  begin, float  end, unsigned int  pointCount  )

inlinestatic

Build a CurveInfo that represents an elipse.

Parameters

a	semi-major axis
b	semi-minor axis
begin	start angle in radian
end	end angle in radian
pointCount	"resolution" or "accuracy" of the computation.

Definition at line 66 of file Curve.hpp.

References begin, end, and f.

Referenced by circle().

static CurveInfo sftools::CurveInfo::sine ( float  a, float  b, float  begin, float  end, unsigned int  pointCount  )

inlinestatic

Build a CurveInfo that represents a sine.

Parameters

a	x-axis factor
b	y-axis factor
begin	start angle in radian
end	end angle in radian
pointCount	"resolution" or "accuracy" of the computation.

Definition at line 97 of file Curve.hpp.

References begin, end, and f.

Member Data Documentation

float sftools::CurveInfo::begin

First value of the curve's parameter.

Definition at line 143 of file Curve.hpp.

Referenced by astroid(), cosine(), elipse(), and sine().

float sftools::CurveInfo::end

Last value of the curve's parameter.

Definition at line 144 of file Curve.hpp.

Referenced by astroid(), cosine(), elipse(), and sine().

CurveFunction sftools::CurveInfo::f

Curve's function.

Definition at line 142 of file Curve.hpp.

Referenced by astroid(), cosine(), elipse(), and sine().

unsigned int sftools::CurveInfo::pointCount

"Resolution" of the curve

Definition at line 145 of file Curve.hpp.

---

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

• Curve.hpp