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

Inherits FiniteTimeAction.

Inherited by AccelAmplitude, AccelDeccelAmplitude, ActionCamera, ActionEase, ActionFloat, ActionTween, Animate, Animate3D, BezierBy, Blink, CardinalSplineTo, DeccelAmplitude, DelayTime, FadeTo, GridAction, JumpBy, MoveBy, ProgressFromTo, ProgressTo, Repeat, RepeatForever, ReverseTime, RotateBy, RotateTo, ScaleTo, Sequence, SkewTo, Spawn, TargetedAction, TintBy, and TintTo.

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 amplitude rate, extension in GridAction. More...

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

virtual bool	isDone (void) const override
	override `Action`.

local	isDone ()
	override `Action`.

virtual void	step (float dt) override
	Called every frame with its delta time, dt in seconds. More...

var	step ( var dt)
	Called every frame with its delta time, dt in seconds. More...

local	step ( local dt)
	Called every frame with its delta time, dt in seconds. More...

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

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

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

virtual ActionInterval *	reverse () const override
	override `Action`.

virtual ActionInterval *	clone () const override
	override `Action`.

var	clone ()
	override `Action`.

local	clone ()
	override `Action`.

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 void	stop ()
	Called after the action that 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 the current target. More...

void	setTarget (Node *target)
	The setter function for the target property. More...

var	setTarget ( var target)
	The setter function for the target property. More...

local	setTarget ( local target)
	The setter function for the target property. More...

Node *	getOriginalTarget () const
	Return the original Target. More...

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

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

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

var	setOriginalTarget ( var 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
	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...

unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...

void	setFlags (unsigned int flags)
	Returns a flag field that is used to group the actions easily. More...

var	setFlags ( var flags)
	Returns a flag field that is used to group the actions easily. More...

local	setFlags ( local flags)
	Returns a flag field that is used to group the actions easily. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

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

local	getReferenceCount ()
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor.

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

Protected Member Functions
bool	initWithDuration (float d)
	initializes the action with the duration. More...

var	initWithDuration ( var d)
	initializes the action with the duration. More...

local	initWithDuration ( local d)
	initializes the action with the duration. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

local	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

local	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

local	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

local	_rooted
	When true, it means that the object was already rooted.

bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.

var	INVALID_TAG = -1
	Default tag used for all the actions.

local	INVALID_TAG = -1
	Default tag used for all the actions.

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:

Member Function Documentation

float getElapsed ( void )

inline

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

The seconds had elapsed since the ations started to run.

var getElapsed ( )

inline

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

The seconds had elapsed since the ations started to run.

local getElapsed ( )

inline

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

The seconds had elapsed since the ations started to run.

void setAmplitudeRate ( float amp )

Sets the amplitude rate, extension in GridAction.

The ampliture rate.

var setAmplitudeRate ( var amp )

Sets the amplitude rate, extension in GridAction.

The ampliture rate.

local setAmplitudeRate ( local amp )

Sets the amplitude rate, extension in GridAction.

The ampliture rate.

float getAmplitudeRate ( void )

Gets the ampliture rate, extension in GridAction.

The ampliture rate.

var getAmplitudeRate ( )

Gets the ampliture rate, extension in GridAction.

The ampliture rate.

local getAmplitudeRate ( )

Gets the ampliture rate, extension in GridAction.

The ampliture rate.

virtual void step ( float dt )

overridevirtual

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

var step ( var dt )

overridevirtual

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

local step ( local dt )

overridevirtual

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from Action.

Reimplemented in RepeatForever, and Animate3D.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from Action.

Reimplemented in ActionFloat, 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, Repeat, AccelDeccelAmplitude, CardinalSplineTo, Sequence, ShuffleTiles, OrbitCamera, Animate3D, ProgressFromTo, ActionTween, ActionEase, GridAction, ProgressTo, and ActionCamera.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from Action.

Reimplemented in ActionFloat, 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, Repeat, AccelDeccelAmplitude, CardinalSplineTo, Sequence, ShuffleTiles, OrbitCamera, Animate3D, ProgressFromTo, ActionTween, ActionEase, GridAction, ProgressTo, and ActionCamera.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from Action.

Reimplemented in ActionFloat, 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, Repeat, AccelDeccelAmplitude, CardinalSplineTo, Sequence, ShuffleTiles, OrbitCamera, Animate3D, ProgressFromTo, ActionTween, ActionEase, GridAction, ProgressTo, and ActionCamera.

bool initWithDuration ( float d )

protected

initializes the action with the duration.

The duration Return true if initialized successfully, otherwise return false.

var initWithDuration ( var d )

protected

initializes the action with the duration.

The duration Return true if initialized successfully, otherwise return false.

local initWithDuration ( local d )

protected

initializes the action with the duration.

The duration Return true if initialized successfully, otherwise return false.

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

CCActionInterval.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation