Procedural::KochanekBartelsSpline2 Class Reference

Builds a shape from a Kochanek Bartels spline. More...

#include <ProceduralShapeGenerators.h>

Inheritance diagram for Procedural::KochanekBartelsSpline2:

Public Types
typedef KochanekBartelsSplineControlPoint< Ogre::Vector2 >	ControlPoint

Public Member Functions
KochanekBartelsSpline2 &	addPoint (Ogre::Real x, Ogre::Real y)
	Adds a control point. More...
KochanekBartelsSpline2 &	addPoint (Ogre::Vector2 p)
	Adds a control point. More...
const ControlPoint &	safeGetPoint (unsigned int i) const
	Safely gets a control point. More...
KochanekBartelsSpline2 &	addPoint (Ogre::Vector2 p, Ogre::Real t, Ogre::Real b, Ogre::Real c)
	Adds a control point to the spline. More...
const size_t	getPointCount () const
	Gets the number of control points. More...
Shape	realizeShape ()
	Builds a shape from control points. More...
KochanekBartelsSpline2 &	setOutSide (Side outSide)
	Sets the out side of the shape. More...
Side	getOutSide () const
	Gets the out side of the shape. More...
KochanekBartelsSpline2 &	setNumSeg (unsigned int numSeg)
	Sets the number of segments between 2 control points. More...
KochanekBartelsSpline2 &	close ()
	Closes the spline. More...

Protected Attributes
unsigned int	mNumSeg
	The number of segments between 2 control points. More...
bool	mClosed
	Whether the shape will be closed or not. More...
Side	mOutSide
	The "out" side of the shape. More...

Detailed Description

Builds a shape from a Kochanek Bartels spline.

More details here : http://en.wikipedia.org/wiki/Kochanek%E2%80%93Bartels_spline

Member Typedef Documentation

ControlPoint

typedef KochanekBartelsSplineControlPoint<Ogre::Vector2> Procedural::KochanekBartelsSpline2::ControlPoint

Member Function Documentation

addPoint() [1/3]

KochanekBartelsSpline2& Procedural::KochanekBartelsSpline2::addPoint	(	Ogre::Real	x,
		Ogre::Real	y
	)

Adds a control point.

addPoint() [2/3]

KochanekBartelsSpline2& Procedural::KochanekBartelsSpline2::addPoint

(

Ogre::Vector2

p

)

Adds a control point.

addPoint() [3/3]

KochanekBartelsSpline2& Procedural::KochanekBartelsSpline2::addPoint	(	Ogre::Vector2	p,
		Ogre::Real	t,
		Ogre::Real	b,
		Ogre::Real	c
	)

Adds a control point to the spline.

Parameters

p	Point position
t	Tension +1 = Tight -1 = Round
b	Bias +1 = Post-shoot -1 = Pre-shoot
c	Continuity +1 = Inverted Corners -1 = Box Corners

close()

KochanekBartelsSpline2 & Procedural::BaseSpline2< KochanekBartelsSpline2 >::close

inherited

Closes the spline.

getOutSide()

Side Procedural::BaseSpline2< KochanekBartelsSpline2 >::getOutSide

inherited

Gets the out side of the shape.

getPointCount()

const size_t Procedural::KochanekBartelsSpline2::getPointCount

(

)

const

Gets the number of control points.

realizeShape()

Shape Procedural::KochanekBartelsSpline2::realizeShape

(

)

Builds a shape from control points.

safeGetPoint()

const ControlPoint& Procedural::KochanekBartelsSpline2::safeGetPoint

(

unsigned int

i

)

const

Safely gets a control point.

References Procedural::Utils::cap(), and Procedural::Utils::modulo().

setNumSeg()

KochanekBartelsSpline2 & Procedural::BaseSpline2< KochanekBartelsSpline2 >::setNumSeg ( unsigned int  numSeg )

inherited

Sets the number of segments between 2 control points.

Exceptions

Ogre::InvalidParametersException

Minimum of numSeg is 1

setOutSide()

KochanekBartelsSpline2 & Procedural::BaseSpline2< KochanekBartelsSpline2 >::setOutSide ( Side  outSide )

inherited

Sets the out side of the shape.

Member Data Documentation

mClosed

bool Procedural::BaseSpline2< KochanekBartelsSpline2 >::mClosed

protectedinherited

Whether the shape will be closed or not.

mNumSeg

unsigned int Procedural::BaseSpline2< KochanekBartelsSpline2 >::mNumSeg

protectedinherited

The number of segments between 2 control points.

mOutSide

Side Procedural::BaseSpline2< KochanekBartelsSpline2 >::mOutSide

protectedinherited

The "out" side of the shape.

---

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

• ProceduralShapeGenerators.h