cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CardinalSplineTo Class Reference

Cardinal Spline path. More...

#include <CCActionCatmullRom.h>

Inheritance diagram for CardinalSplineTo:
ActionInterval FiniteTimeAction Action Ref Clonable CardinalSplineBy CatmullRomTo CatmullRomBy

Public Member Functions

virtual ~CardinalSplineTo ()
 CardinalSplineTo ()
bool initWithDuration (float duration, PointArray *points, float tension)
 Initializes the action with a duration and an array of points. More...
 
var initWithDuration ( var duration, var points, var tension)
 Initializes the action with a duration and an array of points. More...
 
local initWithDuration ( local duration, local points, local tension)
 Initializes the action with a duration and an array of points. More...
 
virtual void updatePosition (Vec2 &newPos)
 It will update the target position and change the _previousPosition to newPos. More...
 
PointArraygetPoints ()
 Return a PointArray. More...
 
void setPoints (PointArray *points)
virtual CardinalSplineToclone () const override
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
virtual CardinalSplineToreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
local reverse ()
 Returns a new action that performs the exactly the reverse action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
var startWithTarget ( var target)
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void update (float time) override
var update ( var time)
local update ( local time)
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 How many seconds had elapsed since the actions started to run. More...
 
var getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
local getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
 Sets the ampliture rate, extension in GridAction. More...
 
local setAmplitudeRate ( local amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
local isDone ()
 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...
 
var getDuration ()
 Get duration in seconds of the action. More...
 
local getDuration ()
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
var setDuration ( var duration)
 Set duration in seconds of the action. More...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual void stop ()
 Called after the action has finished. More...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 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...
 
var getTag ()
 Returns a tag that is used to identify the action easily. More...
 
local getTag ()
 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...
 
var setTag ( var tag)
 Changes the tag that is used to identify the action easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the action easily. More...
 
virtual ~Action ()
var ~Action ()
local ~Action ()
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 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 ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static CardinalSplineTocreate (float duration, PointArray *points, float tension)
 Creates an action with a Cardinal Spline array of points and tension. More...
 

Protected Attributes

PointArray_points
 Array of control points. More...
 
float _deltaT
float _tension
Vec2 _previousPosition
Vec2 _accumulatedDiff
- Protected Attributes inherited from ActionInterval
float _elapsed
var _elapsed
local _elapsed
bool _firstTick
var _firstTick
local _firstTick
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Constructor & Destructor Documentation

virtual ~CardinalSplineTo ( )
virtual
var ctor ( )

Member Function Documentation

virtual CardinalSplineTo* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

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

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness 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: lcaol create(local t, local table)
var create ( var  duration,
var  points,
var  tension 
)
static

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness 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: lcaol create(local t, local table)
local create ( local  duration,
local  points,
local  tension 
)
static

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness 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: lcaol create(local t, local table)
PointArray* getPoints ( )
inline

Return a PointArray.

Returns
A PointArray.
var getPoints ( )
inline

Return a PointArray.

Returns
A PointArray.
local getPoints ( )
inline

Return a PointArray.

Returns
A PointArray.
bool initWithDuration ( float  duration,
PointArray points,
float  tension 
)

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness of fit.
var initWithDuration ( var  duration,
var  points,
var  tension 
)

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness of fit.
local initWithDuration ( local  duration,
local  points,
local  tension 
)

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

Parameters
durationIn seconds.
pointAn PointArray.
tensionGoodness of fit.
virtual CardinalSplineTo* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

var reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

local reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in CatmullRomBy, CatmullRomTo, and CardinalSplineBy.

void setPoints ( PointArray points)
inline
virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in CardinalSplineBy.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in CardinalSplineBy.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in CardinalSplineBy.

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

var update ( var  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

local update ( local  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

virtual void updatePosition ( Vec2 newPos)
virtual

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

Parameters
newPosThe new position.

Reimplemented in CardinalSplineBy.

var updatePosition ( var  newPos)
virtual

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

Parameters
newPosThe new position.

Reimplemented in CardinalSplineBy.

local updatePosition ( local  newPos)
virtual

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

Parameters
newPosThe new position.

Reimplemented in CardinalSplineBy.

Member Data Documentation

Vec2 _accumulatedDiff
protected
var _accumulatedDiff
protected
local _accumulatedDiff
protected
float _deltaT
protected
var _deltaT
protected
local _deltaT
protected
PointArray* _points
protected

Array of control points.

var _points
protected

Array of control points.

local _points
protected

Array of control points.

Vec2 _previousPosition
protected
var _previousPosition
protected
local _previousPosition
protected
float _tension
protected
var _tension
protected
local _tension
protected

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