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

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

void	setAmplitudeRate (float amp)
	Sets the ampliture rate, extension in GridAction. More...

local	setAmplitudeRate ( local amp)
	Sets the ampliture rate, extension in GridAction. More...

float	getAmplitudeRate (void)
	Gets the ampliture rate, extension in GridAction. More...

local	getAmplitudeRate ()
	Gets the ampliture rate, extension in GridAction. More...

virtual bool	isDone (void) const override
	Return true if the action has finished. More...

local	isDone ()
	Return true if the action has finished. More...

virtual void	step (float dt) override
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...

local	startWithTarget ( local target)
	Called before the action start. More...

virtual ActionInterval *	reverse () const override
	Returns a new action that performs the exactly the reverse action. More...

virtual ActionInterval *	clone () const override
	Returns a clone of action. More...

var	clone ()
	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...

var	getDuration ()
	Get duration in seconds of the action. More...

local	getDuration ()
	Get duration in seconds of the action. More...

void	setDuration (float duration)
	Set duration in seconds of the action. More...

var	setDuration ( var duration)
	Set duration in seconds of the action. More...

local	setDuration ( local 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...

virtual void	update (float time)
	Called once per frame. More...

var	update ( var time)
	Called once per frame. More...

local	update ( local time)
	Called once per frame. More...

Node *	getTarget () const
	Return certain target. More...

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
	Return a original Target. More...

var	getOriginalTarget ()
	Return a original Target. More...

local	getOriginalTarget ()
	Return a original Target. More...

void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...

int	getTag () const
	Returns a tag that is used to identify the action easily. More...

var	getTag ()
	Returns a tag that is used to identify the action easily. More...

local	getTag ()
	Returns a tag that is used to identify the action easily. More...

void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...

var	setTag ( var tag)
	Changes the tag that is used to identify the action easily. More...

local	setTag ( local tag)
	Changes the tag that is used to identify the action easily. More...

virtual	~Action ()
var	~Action ()
local	~Action ()
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () const
	Returns a copy of the Ref. More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: bool initWithDuration(float d)
Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS	__pad0__: Action()

Protected Attributes
float	_elapsed
var	_elapsed
local	_elapsed
bool	_firstTick
var	_firstTick
local	_firstTick
Protected Attributes inherited from Action
Node *	_originalTarget
Node *	_target
	The "target". More...

int	_tag
	The action tag. More...

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

local	_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...

Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

	Ref ()
	Constructor. 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

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from FiniteTimeAction.

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

var clone ( )

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from FiniteTimeAction.

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

local clone ( )

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from FiniteTimeAction.

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

float getAmplitudeRate ( void )

Gets the ampliture rate, extension in GridAction.

Returns: The ampliture rate.

var getAmplitudeRate ( )

Gets the ampliture rate, extension in GridAction.

Returns: The ampliture rate.

local getAmplitudeRate ( )

Gets the ampliture rate, extension in GridAction.

Returns: The ampliture rate.

float getElapsed ( void )

inline

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

Returns: The seconds had elapsed since the ations started to run.

var getElapsed ( )

inline

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

Returns: The seconds had elapsed since the ations started to run.

local getElapsed ( )

inline

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

Returns: The seconds had elapsed since the ations started to run.

virtual bool isDone ( void ) const

overridevirtual

Return true if the action has finished.

Returns: Is true if the action has finished.

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

var isDone ( )

overridevirtual

Return true if the action has finished.

Returns: Is true if the action has finished.

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

local isDone ( )

overridevirtual

Return true if the action has finished.

Returns: Is true if the action has finished.

Reimplemented from Action.

Reimplemented in RepeatForever, and Repeat.

virtual ActionInterval* reverse ( void ) const

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from FiniteTimeAction.

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

var reverse ( )

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from FiniteTimeAction.

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

local reverse ( )

inlineoverridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from FiniteTimeAction.

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

void setAmplitudeRate ( float amp )

Sets the ampliture rate, extension in GridAction.

Parameters

amp	The ampliture rate.

var setAmplitudeRate ( var amp )

Sets the ampliture rate, extension in GridAction.

Parameters

amp	The ampliture rate.

local setAmplitudeRate ( local amp )

Sets the ampliture rate, extension in GridAction.

Parameters

amp	The ampliture rate.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain 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, SplitCols, RotateBy, SplitRows, RotateTo, Spawn, TurnOffTiles, DeccelAmplitude, RepeatForever, AccelAmplitude, CardinalSplineBy, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, CardinalSplineTo, CCBRotateTo, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, Animate3D, ActionEase, GridAction, ActionCamera, and ProgressTo.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain 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, SplitCols, RotateBy, SplitRows, RotateTo, Spawn, TurnOffTiles, DeccelAmplitude, RepeatForever, AccelAmplitude, CardinalSplineBy, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, CardinalSplineTo, CCBRotateTo, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, Animate3D, ActionEase, GridAction, ActionCamera, and ProgressTo.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain 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, SplitCols, RotateBy, SplitRows, RotateTo, Spawn, TurnOffTiles, DeccelAmplitude, RepeatForever, AccelAmplitude, CardinalSplineBy, CCBRotateYTo, Repeat, AccelDeccelAmplitude, CCBRotateXTo, CardinalSplineTo, CCBRotateTo, Sequence, ShuffleTiles, OrbitCamera, ProgressFromTo, ActionTween, Animate3D, ActionEase, GridAction, ActionCamera, and ProgressTo.

virtual void step ( float dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

var step ( var dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

local step ( local dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

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/minggo/SourceCode/cocos2d-x/cocos/2d/CCActionInterval.h

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation