cocos2d-x  3.5
 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...
 
virtual CatmullRomToreverse () const override
 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...
 
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 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 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...
 

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...
 
- Protected Attributes inherited from CardinalSplineTo
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...
 

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.

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.

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: 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.

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: 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.

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: lcaol 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* 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 CardinalSplineTo.

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 CardinalSplineTo.

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 CardinalSplineTo.


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