cocos2d-x  2.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCActionTween Class Reference

CCActionTween. More...

#include <CCActionTween.h>

Inheritance diagram for CCActionTween:
CCActionInterval CCFiniteTimeAction CCAction CCObject CCCopying

Public Member Functions

bool initWithDuration (float aDuration, const char *key, float from, float to)
 initializes the action with the property name (key), and the from and to parameters. More...
 
void startWithTarget (CCNode *pTarget)
 called before the action start. It will also set the target. More...
 
void update (float dt)
 called once per frame. More...
 
var update ( var dt)
 called once per frame. More...
 
local update ( local dt)
 called once per frame. More...
 
CCActionIntervalreverse ()
 returns a reversed action More...
 
local reverse ()
 returns a reversed action More...
 
- Public Member Functions inherited from CCActionInterval
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...
 
bool initWithDuration (float d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
virtual bool isDone (void)
 returns true if the action has finished More...
 
local isDone ()
 returns true if the action has finished More...
 
virtual CCObjectcopyWithZone (CCZone *pZone)
virtual void step (float dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
var step ( var dt)
 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...
 
void setAmplitudeRate (float amp)
var setAmplitudeRate ( var amp)
local setAmplitudeRate ( local amp)
float getAmplitudeRate (void)
var getAmplitudeRate ()
local getAmplitudeRate ()
- Public Member Functions inherited from CCFiniteTimeAction
 CCFiniteTimeAction ()
virtual ~CCFiniteTimeAction ()
float getDuration (void)
 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 CCAction
 CCAction (void)
 ctor ()
 CCAction ()
virtual ~CCAction (void)
const char * description ()
virtual void stop (void)
 called after the action has finished. More...
 
CCNodegetTarget (void)
var getTarget ()
local getTarget ()
void setTarget (CCNode *pTarget)
 The action will modify the target properties. More...
 
local setTarget ( local pTarget)
 The action will modify the target properties. More...
 
CCNodegetOriginalTarget (void)
local getOriginalTarget ()
void setOriginalTarget (CCNode *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void)
var getTag ()
local getTag ()
void setTag (int nTag)
var setTag ( var nTag)
local setTag ( local nTag)
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)

Static Public Member Functions

static CCActionTweencreate (float aDuration, const char *key, float from, float to)
 creates an initializes the action with the property name (key), and the from and to parameters. More...
 
var create ( var aDuration, var key, var from, var to)
 creates an initializes the action with the property name (key), and the from and to parameters. More...
 
local create ( local aDuration, local key, local from, local to)
 creates an initializes the action with the property name (key), and the from and to parameters. More...
 
- Static Public Member Functions inherited from CCActionInterval
static CCActionIntervalcreate (float d)
 creates the action More...
 
- Static Public Member Functions inherited from CCAction
static CCActioncreate ()
 Create an action. More...
 
var create ()
 Create an action. More...
 
local create ()
 Create an action. More...
 

Public Attributes

std::string m_strKey
var m_strKey
local m_strKey
float m_fFrom
var m_fFrom
local m_fFrom
float m_fTo
var m_fTo
local m_fTo
float m_fDelta
var m_fDelta
local m_fDelta
- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Additional Inherited Members

- Protected Attributes inherited from CCActionInterval
float m_elapsed
bool m_bFirstTick
var m_bFirstTick
local m_bFirstTick
- Protected Attributes inherited from CCFiniteTimeAction
float m_fDuration
 duration in seconds More...
 
- Protected Attributes inherited from CCAction
CCNodem_pOriginalTarget
CCNodem_pTarget
 The "target". More...
 
local m_pTarget
 The "target". More...
 
int m_nTag
 The action tag. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Detailed Description

CCActionTween.

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

id modifyWidth = [CCActionTween actionWithDuration:2 key:"width" from:200 to:300]; [target runAction:modifyWidth];

Another example: CCScaleTo action could be rewritten using CCPropertyAction:

scaleA and scaleB are equivalents id scaleA = [CCScaleTo actionWithDuration:2 scale:3]; id scaleB = [CCActionTween actionWithDuration:2 key:"scale" from:1 to:3];

Since
v0.99.2

Member Function Documentation

static CCActionTween* create ( float  aDuration,
const char *  key,
float  from,
float  to 
)
static

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

var create ( var  aDuration,
var  key,
var  from,
var  to 
)
static

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

local create ( local  aDuration,
local  key,
local  from,
local  to 
)
static

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

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

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

var initWithDuration ( var  aDuration,
var  key,
var  from,
var  to 
)

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

local initWithDuration ( local  aDuration,
local  key,
local  from,
local  to 
)

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

CCActionInterval* reverse ( )
virtual

returns a reversed action

Reimplemented from CCActionInterval.

var reverse ( )
virtual

returns a reversed action

Reimplemented from CCActionInterval.

local reverse ( )
virtual

returns a reversed action

Reimplemented from CCActionInterval.

void startWithTarget ( CCNode pTarget)
virtual

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

Reimplemented from CCActionInterval.

var startWithTarget ( var  pTarget)
virtual

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

Reimplemented from CCActionInterval.

local startWithTarget ( local  pTarget)
virtual

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

Reimplemented from CCActionInterval.

void update ( float  time)
virtual

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

var update ( var  time)
virtual

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

local update ( local  time)
virtual

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

Member Data Documentation

float m_fDelta
var m_fDelta
local m_fDelta
float m_fFrom
var m_fFrom
local m_fFrom
float m_fTo
var m_fTo
local m_fTo
std::string m_strKey
var m_strKey
local m_strKey

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