cocos2d-x  3.0-alpha0
 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 Object 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...
 
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...
 
local getElapsed ()
 how many seconds had elapsed since the actions started to run. More...
 
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 return true if the action has finished More...
 
local isDone ()
 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
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
float getDuration (void) 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
 Action (void)
 ctor ()
 Action ()
virtual ~Action (void)
const char * description () const
virtual void stop (void)
 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 (void) const
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget (void) const
local getOriginalTarget ()
void setOriginalTarget (Node *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void) const
void setTag (int nTag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
CC_DEPRECATED_ATTRIBUTE Objectcopy () const
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. 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

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- 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 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.

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)
bool initWithDuration ( float  dt,
PointArray 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.


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