Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
CatmullRomBy Class Reference

An action that moves the target with a CatmullRom curve by a certain distance. More...

Inherits CardinalSplineBy.

Public Member Functions

bool initWithDuration (float dt, PointArray *points)
 Initializes the action with a duration and an array of points. More...
 
local initWithDuration ( local dt, local points)
 Initializes the action with a duration and an array of points. More...
 
virtual CatmullRomByclone () const override
 override Action.
 
virtual CatmullRomByreverse () const override
 override Action.
 
local reverse ()
 override Action.
 
- Public Member Functions inherited from CardinalSplineBy
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 updatePosition (Vec2 &newPos) override
 It will update the target position and change the _previousPosition to newPos More...
 
local updatePosition ( local newPos)
 It will update the target position and change the _previousPosition to newPos 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 control points. More...
 
var initWithDuration ( var duration, var points, var tension)
 Initializes the action with a duration and an array of control points. More...
 
local initWithDuration ( local duration, local points, local tension)
 Initializes the action with a duration and an array of control points. More...
 
PointArraygetPoints ()
 Return the control point array. More...
 
virtual void update (float time) override
- 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 amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 override Action.
 
local isDone ()
 override Action.
 
virtual void step (float dt) override
 Called every frame with its delta time, dt in seconds. More...
 
var step ( var dt)
 Called every frame with its delta time, dt in seconds. More...
 
local step ( local dt)
 Called every frame with its delta time, dt in seconds. More...
 
- 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 void stop ()
 Called after the action that has finished. More...
 
NodegetTarget () const
 Return the current target. More...
 
void setTarget (Node *target)
 The setter function for the target property. More...
 
var setTarget ( var target)
 The setter function for the target property. More...
 
local setTarget ( local target)
 The setter function for the target property. More...
 
NodegetOriginalTarget () const
 Return the original Target. More...
 
var getOriginalTarget ()
 Return the original Target. More...
 
local getOriginalTarget ()
 Return the original Target. More...
 
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
var setOriginalTarget ( var 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...
 
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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Returns a flag field that is used to group the actions easily. More...
 
var setFlags ( var flags)
 Returns a flag field that is used to group the actions easily. More...
 
local setFlags ( local flags)
 Returns a flag field that is used to group the actions easily. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref.
 

Static Public Member Functions

static CatmullRomBycreate (float dt, PointArray *points)
 Creates an CatmullRomBy action with an array of control points and tension. More...
 
local create ( local dt, local points)
 Creates an CatmullRomBy action with an array of control points and tension. More...
 
- Static Public Member Functions inherited from CardinalSplineBy
static CardinalSplineBycreate (float duration, PointArray *points, float tension)
 Creates an CardinalSplineBy action with a Cardinal Spline array of control points and tension. More...
 
local create ( local duration, local points, local tension)
 Creates an CardinalSplineBy action with a Cardinal Spline array of control points and tension. More...
 
- Static Public Member Functions inherited from CardinalSplineTo
static CardinalSplineTocreate (float duration, PointArray *points, float tension)
 Creates an CardinalSplineTo action with a Cardinal Spline array of control points and tension. More...
 
var create ( var duration, var points, var tension)
 Creates an CardinalSplineTo action with a Cardinal Spline array of control points and tension. More...
 
local create ( local duration, local points, local tension)
 Creates an CardinalSplineTo action with a Cardinal Spline array of control 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.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions.
 
var INVALID_TAG = -1
 Default tag used for all the actions.
 
local INVALID_TAG = -1
 Default tag used for all the actions.
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action with the duration. More...
 
var initWithDuration ( var d)
 initializes the action with the duration. More...
 
local initWithDuration ( local d)
 initializes the action with the duration. More...
 

Detailed Description

An action that moves the target with a CatmullRom curve by a certain distance.

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 CatmullRomBy* create ( float  dt,
PointArray points 
)
static

Creates an CatmullRomBy action with an array of control points and tension.

Duration in seconds. An control point array.

var create ( var  dt,
var  points 
)
static

Creates an CatmullRomBy action with an array of control points and tension.

Duration in seconds. An control point array.

local create ( local  dt,
local  points 
)
static

Creates an CatmullRomBy action with an array of control points and tension.

Duration in seconds. An control point array.

bool initWithDuration ( float  dt,
PointArray points 
)

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

Duration in seconds. An control point array.

var initWithDuration ( var  dt,
var  points 
)

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

Duration in seconds. An control point array.

local initWithDuration ( local  dt,
local  points 
)

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

Duration in seconds. An control point array.


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