ActionInterval Class Reference

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

#include <CCActionInterval.h>

Inheritance diagram for ActionInterval:

Public Member Functions
float	getElapsed (void)
	how many seconds had elapsed since the actions started to run. More...
void	setAmplitudeRate (float amp)
float	getAmplitudeRate (void)
virtual bool	isDone (void) const override
	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...
virtual void	startWithTarget (Node *target) override
	called before the action start. It will also set the target. More...
local	startWithTarget ( local target)
	called before the action start. It will also set the target. More...
virtual ActionInterval *	reverse () const override=0
	returns a new action that performs the exactly the reverse action More...
local	reverse ()
	returns a new action that performs the exactly the reverse action More...
virtual ActionInterval *	clone () const override=0
	returns a clone of action More...
local	clone ()
	returns a clone of action More...
Public Member Functions inherited from FiniteTimeAction
float	getDuration () 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
virtual std::string	description () const
virtual void	stop ()
	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...
virtual void	update (float time)
	called once per frame. More...
local	update ( local time)
	called once per frame. More...
Node *	getTarget () const
var	getTarget ()
local	getTarget ()
void	setTarget (Node *target)
	The action will modify the target properties. More...
var	setTarget ( var target)
	The action will modify the target properties. More...
local	setTarget ( local target)
	The action will modify the target properties. More...
Node *	getOriginalTarget () const
var	getOriginalTarget ()
void	setOriginalTarget (Node *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
var	getTag ()
local	getTag ()
void	setTag (int tag)
var	setTag ( var tag)
local	setTag ( local tag)
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Release the ownership immediately. More...
Ref *	autorelease ()
	Release the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () const
	returns a copy of the Ref. More...
var	copy ()
	returns a copy of the Ref. More...
local	copy ()
	returns a copy of the Ref. More...

Protected Member Functions
bool	initWithDuration (float d)
	initializes the action More...
var	initWithDuration ( var d)
	initializes the action More...
local	initWithDuration ( local d)
	initializes the action More...
Protected Member Functions inherited from FiniteTimeAction
	FiniteTimeAction ()
virtual	~FiniteTimeAction ()
Protected Member Functions inherited from Action
	Action ()
	Action ()
	Action ()
virtual	~Action ()
var	~Action ()
local	~Action ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
float	_elapsed
bool	_firstTick
Protected Attributes inherited from FiniteTimeAction
float	_duration
	duration in seconds More...
Protected Attributes inherited from Action
Node *	_originalTarget
local	_originalTarget
Node *	_target
	The "target". More...
int	_tag
	The action tag. More...
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Additional Inherited Members
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

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

Action *pingPongAction = Sequence::actions(action, action->reverse(), nullptr);

Member Function Documentation

virtual ActionInterval* clone ( ) const

overridepure virtual

returns a clone of action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, MoveTo, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, SplitCols, EaseElasticIn, RotateTo, SplitRows, EaseElastic, Twirl, JumpTiles3D, Spawn, EaseSineInOut, EaseSineOut, Waves, CatmullRomBy, WavesTiles3D, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, Liquid, RepeatForever, CCBRotateXTo, TurnOffTiles, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, Shaky3D, FadeOutDownTiles, EaseExponentialOut, FadeOutUpTiles, EaseExponentialIn, CardinalSplineTo, Repeat, Ripple3D, AccelDeccelAmplitude, FadeOutBLTiles, EaseInOut, TiledGrid3DAction, FadeOutTRTiles, EaseOut, Lens3D, Sequence, EaseIn, Grid3DAction, FlipY3D, ShuffleTiles, OrbitCamera, EaseRateAction, FlipX3D, ProgressFromTo, ActionTween, ShatteredTiles3D, ActionCamera, Waves3D, PageTurn3D, ActionEase, GridAction, ProgressTo, and ShakyTiles3D.

var clone ( )

overridepure virtual

returns a clone of action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, MoveTo, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, SplitCols, EaseElasticIn, RotateTo, SplitRows, EaseElastic, Twirl, JumpTiles3D, Spawn, EaseSineInOut, EaseSineOut, Waves, CatmullRomBy, WavesTiles3D, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, Liquid, RepeatForever, CCBRotateXTo, TurnOffTiles, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, Shaky3D, FadeOutDownTiles, EaseExponentialOut, FadeOutUpTiles, EaseExponentialIn, CardinalSplineTo, Repeat, Ripple3D, AccelDeccelAmplitude, FadeOutBLTiles, EaseInOut, TiledGrid3DAction, FadeOutTRTiles, EaseOut, Lens3D, Sequence, EaseIn, Grid3DAction, FlipY3D, ShuffleTiles, OrbitCamera, EaseRateAction, FlipX3D, ProgressFromTo, ActionTween, ShatteredTiles3D, ActionCamera, Waves3D, PageTurn3D, ActionEase, GridAction, ProgressTo, and ShakyTiles3D.

local clone ( )

overridepure virtual

returns a clone of action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, MoveTo, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, SplitCols, EaseElasticIn, RotateTo, SplitRows, EaseElastic, Twirl, JumpTiles3D, Spawn, EaseSineInOut, EaseSineOut, Waves, CatmullRomBy, WavesTiles3D, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, Liquid, RepeatForever, CCBRotateXTo, TurnOffTiles, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, Shaky3D, FadeOutDownTiles, EaseExponentialOut, FadeOutUpTiles, EaseExponentialIn, CardinalSplineTo, Repeat, Ripple3D, AccelDeccelAmplitude, FadeOutBLTiles, EaseInOut, TiledGrid3DAction, FadeOutTRTiles, EaseOut, Lens3D, Sequence, EaseIn, Grid3DAction, FlipY3D, ShuffleTiles, OrbitCamera, EaseRateAction, FlipX3D, ProgressFromTo, ActionTween, ShatteredTiles3D, ActionCamera, Waves3D, PageTurn3D, ActionEase, GridAction, ProgressTo, and ShakyTiles3D.

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)

protected

initializes the action

var initWithDuration ( var  d)

protected

initializes the action

local initWithDuration ( local  d)

protected

initializes the action

virtual bool isDone ( void  ) const

overridevirtual

return true if the action has finished

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

var isDone (   )

overridevirtual

return true if the action has finished

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

local isDone (   )

overridevirtual

return true if the action has finished

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

virtual ActionInterval* reverse ( ) const

overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, EaseSineOut, CatmullRomBy, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, RepeatForever, CCBRotateXTo, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, EaseExponentialOut, EaseExponentialIn, CardinalSplineTo, Repeat, AccelDeccelAmplitude, EaseInOut, EaseOut, Sequence, EaseIn, EaseRateAction, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

var reverse ( )

overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, EaseSineOut, CatmullRomBy, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, RepeatForever, CCBRotateXTo, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, EaseExponentialOut, EaseExponentialIn, CardinalSplineTo, Repeat, AccelDeccelAmplitude, EaseInOut, EaseOut, Sequence, EaseIn, EaseRateAction, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

local reverse ( )

overridepure virtual

returns a new action that performs the exactly the reverse action

Implements FiniteTimeAction.

Implemented in TargetedAction, Animate, ReverseTime, DelayTime, EaseCubicActionInOut, EaseCubicActionOut, TintBy, EaseCubicActionIn, TintTo, EaseCircleActionInOut, FadeOut, EaseCircleActionOut, EaseCircleActionIn, FadeIn, EaseQuinticActionInOut, FadeTo, EaseQuinticActionOut, EaseQuinticActionIn, Blink, EaseQuarticActionInOut, ScaleBy, EaseQuarticActionOut, EaseQuarticActionIn, ScaleTo, EaseQuadraticActionInOut, BezierTo, EaseQuadraticActionOut, EaseQuadraticActionIn, BezierBy, EaseBezierAction, JumpTo, EaseBackInOut, EaseBackOut, JumpBy, EaseBackIn, SkewBy, EaseBounceInOut, SkewTo, EaseBounceOut, EaseBounceIn, EaseBounce, MoveBy, EaseElasticInOut, EaseElasticOut, RotateBy, EaseElasticIn, RotateTo, EaseElastic, Spawn, EaseSineInOut, EaseSineOut, CatmullRomBy, CCBEaseInstant, CCBRotateYTo, EaseSineIn, CatmullRomTo, DeccelAmplitude, RepeatForever, CCBRotateXTo, EaseExponentialInOut, CardinalSplineBy, CCBRotateTo, AccelAmplitude, EaseExponentialOut, EaseExponentialIn, CardinalSplineTo, Repeat, AccelDeccelAmplitude, EaseInOut, EaseOut, Sequence, EaseIn, EaseRateAction, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

void setAmplitudeRate

(

float

amp)

var setAmplitudeRate

(

var

amp)

local setAmplitudeRate

(

local

amp)

virtual void startWithTarget ( Node *  target)

overridevirtual

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

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, Blink, ScaleBy, ScaleTo, BezierTo, BezierBy, JumpTo, JumpBy, SkewBy, SkewTo, MoveTo, MoveBy, RotateBy, SplitCols, RotateTo, SplitRows, Spawn, CCBRotateYTo, DeccelAmplitude, RepeatForever, TurnOffTiles, CCBRotateXTo, CCBRotateTo, CardinalSplineBy, AccelAmplitude, CardinalSplineTo, Repeat, AccelDeccelAmplitude, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

var startWithTarget ( var  target)

overridevirtual

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

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, Blink, ScaleBy, ScaleTo, BezierTo, BezierBy, JumpTo, JumpBy, SkewBy, SkewTo, MoveTo, MoveBy, RotateBy, SplitCols, RotateTo, SplitRows, Spawn, CCBRotateYTo, DeccelAmplitude, RepeatForever, TurnOffTiles, CCBRotateXTo, CCBRotateTo, CardinalSplineBy, AccelAmplitude, CardinalSplineTo, Repeat, AccelDeccelAmplitude, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

local startWithTarget ( local  target)

overridevirtual

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

Reimplemented from Action.

Reimplemented in TargetedAction, Animate, ReverseTime, TintBy, TintTo, FadeOut, FadeIn, FadeTo, Blink, ScaleBy, ScaleTo, BezierTo, BezierBy, JumpTo, JumpBy, SkewBy, SkewTo, MoveTo, MoveBy, RotateBy, SplitCols, RotateTo, SplitRows, Spawn, CCBRotateYTo, DeccelAmplitude, RepeatForever, TurnOffTiles, CCBRotateXTo, CCBRotateTo, CardinalSplineBy, AccelAmplitude, CardinalSplineTo, Repeat, AccelDeccelAmplitude, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, ActionCamera, ActionEase, GridAction, and ProgressTo.

virtual void step ( float  dt)

overridevirtual

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

Reimplemented from Action.

Reimplemented in RepeatForever.

var step ( var  dt)

overridevirtual

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

Reimplemented from Action.

Reimplemented in RepeatForever.

local step ( local  dt)

overridevirtual

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

Reimplemented from Action.

Reimplemented in RepeatForever.

Member Data Documentation

float _elapsed

protected

var _elapsed

protected

local _elapsed

protected

bool _firstTick

protected

var _firstTick

protected

local _firstTick

protected

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCActionInterval.h