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

An interval action is an action that takes place within a certain period of time. More...

#include <CCActionInterval.h>

Inheritance diagram for CCActionInterval:
CCFiniteTimeAction CCAction CCObject CCCopying CCAccelAmplitude CCAccelDeccelAmplitude CCActionCamera CCActionEase CCActionTween CCAnimate CCBezierBy CCBlink CCCardinalSplineTo CCDeccelAmplitude CCDelayTime CCFadeIn CCFadeOut CCFadeTo CCGridAction CCJumpBy CCMoveBy CCProgressFromTo CCProgressTo CCRepeat CCRepeatForever CCReverseTime CCRotateBy CCRotateTo CCScaleTo CCSequence CCSkewTo CCSpawn CCTargetedAction CCTintBy CCTintTo CCBRotateTo CCBRotateXTo CCBRotateYTo

Public Member Functions

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...
 
virtual void startWithTarget (CCNode *pTarget)
 called before the action start. It will also set the target. More...
 
var startWithTarget ( var pTarget)
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local pTarget)
 called before the action start. It will also set the target. More...
 
virtual CCActionIntervalreverse (void)
 returns a reversed action More...
 
local reverse ()
 returns a reversed action 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...
 
virtual void update (float time)
 called once per frame. More...
 
local update ( local time)
 called once per frame. 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 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...
 

Protected Attributes

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

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Detailed Description

An interval action is an action that takes place within a certain period of time.

It has an start time, and a finish time. The finish time is the parameter duration plus the start time.

These CCActionInterval actions have some interesting properties, like:

  • They can run normally (default)
  • They can run reversed with the reverse method
  • They can run with the time altered with the Accelerate, AccelDeccel and Speed actions.

For example, you can simulate a Ping Pong effect running the action normally and then running it again in Reverse mode.

Example:

CCAction *pingPongAction = CCSequence::actions(action, action->reverse(), NULL);

Member Function Documentation

static CCActionInterval* create ( float  d)
static

creates the action

var create ( var  d)
static

creates the action

local create ( local  d)
static

creates the action

float getAmplitudeRate ( void  )
var getAmplitudeRate (   )
local getAmplitudeRate (   )
float getElapsed ( void  )
inline

how many seconds had elapsed since the actions started to run.

var getElapsed (   )
inline

how many seconds had elapsed since the actions started to run.

local getElapsed (   )
inline

how many seconds had elapsed since the actions started to run.

bool initWithDuration ( float  d)

initializes the action

var initWithDuration ( var  d)

initializes the action

local initWithDuration ( local  d)

initializes the action

virtual bool isDone ( void  )
virtual

returns true if the action has finished

Reimplemented from CCAction.

Reimplemented in CCRepeatForever, and CCRepeat.

var isDone (   )
virtual

returns true if the action has finished

Reimplemented from CCAction.

Reimplemented in CCRepeatForever, and CCRepeat.

local isDone (   )
virtual

returns true if the action has finished

Reimplemented from CCAction.

Reimplemented in CCRepeatForever, and CCRepeat.

void setAmplitudeRate ( float  amp)
var setAmplitudeRate ( var  amp)
local setAmplitudeRate ( local  amp)
virtual void step ( float  dt)
virtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from CCAction.

Reimplemented in CCRepeatForever.

var step ( var  dt)
virtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from CCAction.

Reimplemented in CCRepeatForever.

local step ( local  dt)
virtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from CCAction.

Reimplemented in CCRepeatForever.

Member Data Documentation

bool m_bFirstTick
protected
var m_bFirstTick
protected
local m_bFirstTick
protected
float m_elapsed
protected
var m_elapsed
protected
local m_elapsed
protected

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