GridAction Class Reference

Base class for Grid actions. More...

#include <CCActionGrid.h>

Inheritance diagram for GridAction:

Public Member Functions
virtual GridBase *	getGrid ()
	returns the grid More...
local	getGrid ()
	returns the grid More...
virtual GridAction *	clone () const override
	returns a clone of action More...
local	clone ()
	returns a clone of action More...
virtual GridAction *	reverse () const override
	returns a new action that performs the exactly the reverse action 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...
Public Member Functions inherited from ActionInterval
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)
local	setAmplitudeRate ( local amp)
float	getAmplitudeRate (void)
local	getAmplitudeRate ()
virtual bool	isDone (void) const override
	return true if the action has finished More...
var	isDone ()
	return true if the action has finished More...
local	isDone ()
	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...
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...
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 ()
local	getOriginalTarget ()
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
var	getTag ()
local	getTag ()
void	setTag (int tag)
var	setTag ( var tag)
local	setTag ( local tag)
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...
local	getReferenceCount ()
	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...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
var	__pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
local	__pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const Size &	gridSize
var	gridSize
local	gridSize
Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS	__pad0__: bool initWithDuration(float d)
local	__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 Member Functions
void	cacheTargetAsGridNode ()
var	cacheTargetAsGridNode ()
local	cacheTargetAsGridNode ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Protected Attributes
Size	_gridSize
var	_gridSize
local	_gridSize
NodeGrid *	_gridNodeTarget
var	_gridNodeTarget
local	_gridNodeTarget
Protected Attributes inherited from ActionInterval
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...

Detailed Description

Base class for Grid actions.

Member Function Documentation

void cacheTargetAsGridNode ( )

protected

var cacheTargetAsGridNode ( )

protected

local cacheTargetAsGridNode ( )

protected

virtual GridAction* clone ( ) const

inlineoverridevirtual

returns a clone of action

Reimplemented from ActionInterval.

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

var clone ( )

inlineoverridevirtual

returns a clone of action

Reimplemented from ActionInterval.

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

local clone ( )

inlineoverridevirtual

returns a clone of action

Reimplemented from ActionInterval.

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

virtual GridBase* getGrid ( )

virtual

returns the grid

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

var getGrid ( )

virtual

returns the grid

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

local getGrid ( )

virtual

returns the grid

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

virtual GridAction* reverse ( void  ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

var reverse (   )

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

local reverse (   )

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node *  target )

overridevirtual

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

Reimplemented from ActionInterval.

Reimplemented in SplitCols, SplitRows, TurnOffTiles, and ShuffleTiles.

var startWithTarget ( var  target )

overridevirtual

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

Reimplemented from ActionInterval.

Reimplemented in SplitCols, SplitRows, TurnOffTiles, and ShuffleTiles.

local startWithTarget ( local  target )

overridevirtual

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

Reimplemented from ActionInterval.

Reimplemented in SplitCols, SplitRows, TurnOffTiles, and ShuffleTiles.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

NodeGrid* _gridNodeTarget

protected

var _gridNodeTarget

protected

local _gridNodeTarget

protected

Size _gridSize

protected

var _gridSize

protected

local _gridSize

protected

CC_CONSTRUCTOR_ACCESS const Size& gridSize

var gridSize

local gridSize

---

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

• /Users/guanghui/cocos2d-x-v3/cocos/2d/CCActionGrid.h