cocos2d-x  3.0-rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CatmullRomTo Class Reference

An action that moves the target with a CatmullRom curve to a destination point. More...

#include <CCActionCatmullRom.h>

Inheritance diagram for CatmullRomTo:
CardinalSplineTo ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

bool initWithDuration (float dt, PointArray *points)
 initializes the action with a duration and an array of points More...
 
virtual CatmullRomToclone () const override
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
virtual CatmullRomToreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
var reverse ()
 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...
 
- Public Member Functions inherited from CardinalSplineTo
virtual ~CardinalSplineTo ()
 CardinalSplineTo ()
bool initWithDuration (float duration, PointArray *points, float tension)
 initializes the action with a duration and an array of points More...
 
virtual void updatePosition (Point &newPos)
PointArraygetPoints ()
void setPoints (PointArray *points)
virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
virtual void update (float time) override
 called once per frame. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
- 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
virtual void stop ()
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
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
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Static Public Member Functions

static CatmullRomTocreate (float dt, PointArray *points)
 creates an action with a Cardinal Spline array of points and tension More...
 
- Static Public Member Functions inherited from CardinalSplineTo
static CardinalSplineTocreate (float duration, PointArray *points, float tension)
 creates an action with a Cardinal Spline array of points and tension More...
 

Additional Inherited Members

- 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 ActionInterval
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
- Protected Attributes inherited from CardinalSplineTo
PointArray_points
 Array of control points. More...
 
float _deltaT
float _tension
Point _previousPosition
Point _accumulatedDiff

Detailed Description

An action that moves the target with a CatmullRom curve to a destination point.

A Catmull Rom is a Cardinal Spline with a tension of 0.5. http://en.wikipedia.org/wiki/Cubic_Hermite_spline#Catmull.E2.80.93Rom_spline

Member Function Documentation

virtual CatmullRomTo* clone ( ) const
overridevirtual

returns a clone of action

Reimplemented from CardinalSplineTo.

var clone ( )
overridevirtual

returns a clone of action

Reimplemented from CardinalSplineTo.

local clone ( )
overridevirtual

returns a clone of action

Reimplemented from CardinalSplineTo.

static CatmullRomTo* create ( float  dt,
PointArray points 
)
static

creates an action with a Cardinal Spline array of points and tension

when this function bound to js or lua,the input params are changed
in js: var create(var dt,var table)
in lua: lcaol create(local dt, local table)
var create ( var  dt,
var  points 
)
static

creates an action with a Cardinal Spline array of points and tension

when this function bound to js or lua,the input params are changed
in js: var create(var dt,var table)
in lua: lcaol create(local dt, local table)
local create ( local  dt,
local  points 
)
static

creates an action with a Cardinal Spline array of points and tension

when this function bound to js or lua,the input params are changed
in js: var create(var dt,var table)
in lua: lcaol create(local dt, local table)
bool initWithDuration ( float  dt,
PointArray points 
)

initializes the action with a duration and an array of points

var initWithDuration ( var  dt,
var  points 
)

initializes the action with a duration and an array of points

local initWithDuration ( local  dt,
local  points 
)

initializes the action with a duration and an array of points

virtual CatmullRomTo* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from CardinalSplineTo.

var reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from CardinalSplineTo.

local reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from CardinalSplineTo.


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