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

ActionTween. More...

#include <CCActionTween.h>

Inheritance diagram for ActionTween:
ActionInterval FiniteTimeAction Action Object Clonable

Public Member Functions

bool initWithDuration (float duration, const char *key, float from, float to)
 initializes the action with the property name (key), and the from and to parameters. More...
 
void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
void update (float dt) override
 called once per frame. More...
 
ActionTweenreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
ActionTweenclone () const override
 returns a clone of action 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 ActionTweencreate (float duration, const char *key, float from, float to)
 creates an initializes the action with the property name (key), and the from and to parameters. More...
 

Protected Attributes

std::string _key
float _from
float _to
float _delta
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
var _target
 The "target". More...
 
local _target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
var _reference
 count of references More...
 
local _reference
 count of references More...
 
unsigned int _autoReleaseCount
 count of autorelease More...
 
var _autoReleaseCount
 count of autorelease More...
 
local _autoReleaseCount
 count of autorelease 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...
 

Detailed Description

ActionTween.

ActionTween is an action that lets you update any property of an object. For example, if you want to modify the "width" property of a target from 200 to 300 in 2 seconds, then:

auto modifyWidth = ActionTween::create(2, "width", 200, 300);
target->runAction(modifyWidth);

Another example: ScaleTo action could be rewritten using PropertyAction:

// scaleA and scaleB are equivalents
auto scaleA = ScaleTo::create(2, 3); // (duration, to)
auto scaleB = ActionTween::create(2, "scale", 1, 3); // (duration, key, from, to)
Since
v0.99.2

Member Function Documentation

ActionTween* clone ( ) const
overridevirtual

returns a clone of action

Implements ActionInterval.

static ActionTween* create ( float  duration,
const char *  key,
float  from,
float  to 
)
static

creates an initializes the action with the property name (key), and the from and to parameters.

bool initWithDuration ( float  duration,
const char *  key,
float  from,
float  to 
)

initializes the action with the property name (key), and the from and to parameters.

ActionTween* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInterval.

void startWithTarget ( Node target)
overridevirtual

called before the action start. It will also set the target.

Reimplemented from ActionInterval.

void update ( float  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

Member Data Documentation

float _delta
protected
float _from
protected
std::string _key
protected
float _to
protected

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