CardinalSplineTo Class Reference

Inherits ActionInterval.

Inherited by CardinalSplineBy, and CatmullRomTo.

Public Member Functions
virtual	~CardinalSplineTo ()
	@js NA @lua NA
	CardinalSplineTo ()
	@js ctor @lua NA
bool	initWithDuration (float duration, PointArray *points, float tension)
	Initializes the action with a duration and an array of points. More...
virtual void	updatePosition (const Vec2 &newPos)
	It will update the target position and change the _previousPosition to newPos. More...
PointArray *	getPoints ()
	Return a PointArray. More...
void	setPoints (PointArray *points)
	@js NA @lua NA
virtual CardinalSplineTo *	clone () const override
	Returns a clone of action. More...
virtual CardinalSplineTo *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...
virtual void	update (float time) override
Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run. More...
void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction. More...
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...
virtual bool	isDone () const override
	Return true if the action has finished. More...
virtual void	step (float dt) override
Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action. More...
void	setDuration (float duration)
	Set duration in seconds of the action. More...
Public Member Functions inherited from Action
virtual std::string	description () const
	@js NA @lua NA
virtual void	stop ()
	Called after the action has finished. More...
Node *	getTarget () const
	Return certain target. More...
void	setTarget (Node *target)
	The action will modify the target properties. More...
Node *	getOriginalTarget () const
	Return a original Target. More...
void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...
int	getTag () const
	Returns a tag that is used to identify the action easily. More...
void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...
void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

Static Public Member Functions
static CardinalSplineTo *	create (float duration, PointArray *points, float tension)
	Creates an action with a Cardinal Spline array of points and tension. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.
Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

Detailed Description

Cardinal Spline path. http://en.wikipedia.org/wiki/Cubic_Hermite_spline#Cardinal_spline

Member Function Documentation

create()

static CardinalSplineTo* create ( float  duration, PointArray *  points, float  tension  )

static

Creates an action with a Cardinal Spline array of points and tension.

Parameters

duration	In seconds.
points	An PointArray.
tension	Goodness of fit. When this function bound to js or lua,the input params are changed. In js: var create(var t,var table) In lua: local create(local t, local table)

initWithDuration()

bool initWithDuration	(	float	duration,
		PointArray *	points,
		float	tension
	)

Initializes the action with a duration and an array of points.

Parameters

duration	In seconds.
points	An PointArray.
tension	Goodness of fit.

updatePosition()

virtual void updatePosition ( const Vec2 &  newPos )

virtual

It will update the target position and change the _previousPosition to newPos.

Parameters

newPos

The new position.

Reimplemented in CardinalSplineBy.

getPoints()

PointArray* getPoints ( )

inline

Return a PointArray.

Returns

A PointArray.

clone()

virtual CardinalSplineTo* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

reverse()

virtual CardinalSplineTo* reverse ( ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns

A new action that performs the exact reverse of the action. @js NA

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

startWithTarget()

virtual void startWithTarget ( Node *  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from ActionInterval.

Reimplemented in CardinalSplineBy.

update()

virtual void update ( float  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from Action.

---

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

• CCActionCatmullRom.h