Base class for Grid actions. More...

Inherited by Grid3DAction, and TiledGrid3DAction.

Public Member Functions
virtual GridBase *	getGrid ()
	Get the pointer of GridBase.

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

virtual GridAction *	reverse () const override
	Returns a new action that performs the exact reverse of the action.

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

Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run.

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

float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction.

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

virtual void	step (float dt) override

Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action.

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

Public Member Functions inherited from Action
virtual std::string	description () const
	NA NA

virtual void	stop ()
	Called after the action has finished.

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

Node *	getTarget () const
	Return certain target.

void	setTarget (Node *target)
	The action will modify the target properties.

Node *	getOriginalTarget () const
	Return a original Target.

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

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

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

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

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

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

void	release ()
	Releases the ownership immediately.

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

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

virtual	~Ref ()
	Destructor.

Public Member Functions inherited from Clonable
virtual	~Clonable ()
	NA NA

Protected Member Functions
bool	initWithDuration (float duration, const Size &gridSize)
	Initializes the action with size and duration.

Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

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

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

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

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

Detailed Description

Base class for Grid actions.

Grid actions are the actions take effect on GridBase.

Member Function Documentation

virtual GridBase* getGrid ( )

virtual

Get the pointer of GridBase.

Returns: The pointer of GridBase.

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

virtual GridAction* clone ( ) const

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionInterval.

Reimplemented in Twirl, SplitCols, SplitRows, Waves, JumpTiles3D, Liquid, WavesTiles3D, Shaky3D, TurnOffTiles, Ripple3D, FadeOutDownTiles, FadeOutUpTiles, FadeOutBLTiles, FadeOutTRTiles, Lens3D, TiledGrid3DAction, FlipY3D, ShuffleTiles, Grid3DAction, FlipX3D, ShatteredTiles3D, Waves3D, PageTurn3D, and ShakyTiles3D.

virtual GridAction* reverse ( ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns: A new action that performs the exact reverse of the action. NA

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

Reimplemented in SplitCols, SplitRows, TurnOffTiles, and ShuffleTiles.

bool initWithDuration	(	float	duration,
		const Size &	gridSize
	)

protected

Initializes the action with size and duration.

Parameters

duration	The duration of the GridAction. It's a value in seconds.
gridSize	The size of the GridAction should be.

Returns: Return true when the initialization success, otherwise return false.

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

CCActionGrid.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation