Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CatmullRomTo Class Reference

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

Inherits CardinalSplineTo.

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...
 
virtual CatmullRomToreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
var reverse ()
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 Returns a new action that performs the exact reverse of the action. More...
 
- Public Member Functions inherited from 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 (const Vec2 &newPos)
 It will update the target position and change the _previousPosition to newPos. More...
 
PointArraygetPoints ()
 Return a PointArray. 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
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 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 amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
var getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var 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...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
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
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 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...
 
local setOriginalTarget ( local 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...
 
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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 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...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
Refcopy () const
 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...
 
var create ( var dt, var points)
 Creates an action with a Cardinal Spline array of points and tension. More...
 
local create ( local dt, local 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...
 
var create ( var duration, var points, var tension)
 Creates an action with a Cardinal Spline array of points and tension. More...
 
local create ( local duration, local points, local 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
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _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. 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
 
var initWithDuration ( var d)
 initializes the action
 
local initWithDuration ( local d)
 initializes the action
 

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

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

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

Parameters
dtIn seconds.
pointsAn PointArray.
When this function bound to js or lua,the input params are changed.
In js: var create(var dt,var table).
In lua: local create(local dt, local table).
var create ( var  dt,
var  points 
)
static

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

Parameters
dtIn seconds.
pointsAn PointArray.
When this function bound to js or lua,the input params are changed.
In js: var create(var dt,var table).
In lua: local create(local dt, local table).
local create ( local  dt,
local  points 
)
static

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

Parameters
dtIn seconds.
pointsAn PointArray.
When this function bound to js or lua,the input params are changed.
In js: var create(var dt,var table).
In lua: local create(local dt, local table).
bool initWithDuration ( float  dt,
PointArray points 
)

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

Parameters
dtIn seconds.
pointsAn PointArray.
var initWithDuration ( var  dt,
var  points 
)

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

Parameters
dtIn seconds.
pointsAn PointArray.
local initWithDuration ( local  dt,
local  points 
)

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

Parameters
dtIn seconds.
pointsAn PointArray.
virtual CatmullRomTo* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CardinalSplineTo.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CardinalSplineTo.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CardinalSplineTo.

virtual CatmullRomTo* reverse ( void  ) 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.

Reimplemented from CardinalSplineTo.

var reverse (   )
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.

Reimplemented from CardinalSplineTo.

local reverse (   )
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.

Reimplemented from CardinalSplineTo.


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