Cocos2d-x  v3.15
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
GridAction Class Reference

Base class for Grid actions. More...

Inherits ActionInterval.

Inherited by Grid3DAction, and TiledGrid3DAction.

Public Member Functions

virtual GridBasegetGrid ()
 Get the pointer of GridBase. More...
 
var getGrid ()
 Get the pointer of GridBase. More...
 
local getGrid ()
 Get the pointer of GridBase. More...
 
virtual GridActionclone () const override
 Returns a clone of action. More...
 
var clone ()
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
virtual GridActionreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 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...
 
local setAmplitudeRate ( local amp)
 Sets the amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
virtual void step (float dt) override
- 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 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...
 
NodegetTarget () 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...
 
NodegetOriginalTarget () 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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Changes the flag field that is used to group the actions easily. More...
 
var setFlags ( var flags)
 Changes the flag field that is used to group the actions easily. More...
 
local setFlags ( local flags)
 Changes the flag field that is used to group the actions easily. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 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
Refcopy () const
 Returns a copy of the Ref. More...
 

Protected Member Functions

bool initWithDuration (float duration, const Size &gridSize)
 Initializes the action with size and duration. More...
 
var initWithDuration ( var duration, var gridSize)
 Initializes the action with size and duration. More...
 
local initWithDuration ( local duration, local gridSize)
 Initializes the action with size and duration. More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 
var initWithDuration ( var d)
 initializes the action
 
local initWithDuration ( local d)
 initializes the action
 

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

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.

var getGrid ( )
virtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

local getGrid ( )
virtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented in TiledGrid3DAction, Grid3DAction, and PageTurn3D.

virtual GridAction* clone ( ) const
inlineoverridevirtual
var clone ( )
inlineoverridevirtual
local clone ( )
inlineoverridevirtual
virtual GridAction* reverse ( void  ) 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.

Reimplemented from ActionInterval.

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

Reimplemented from ActionInterval.

local reverse (   )
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.

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain 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.

Parameters
targetA certain 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.

Parameters
targetA 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
durationThe duration of the GridAction. It's a value in seconds.
gridSizeThe size of the GridAction should be.
Returns
Return true when the initialization success, otherwise return false.
var initWithDuration ( var  duration,
var  gridSize 
)
protected

Initializes the action with size and duration.

Parameters
durationThe duration of the GridAction. It's a value in seconds.
gridSizeThe size of the GridAction should be.
Returns
Return true when the initialization success, otherwise return false.
local initWithDuration ( local  duration,
local  gridSize 
)
protected

Initializes the action with size and duration.

Parameters
durationThe duration of the GridAction. It's a value in seconds.
gridSizeThe 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: