cocos2d-x  3.0rc1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
GridAction Class Referenceabstract

Base class for Grid actions. More...

#include <CCActionGrid.h>

Inheritance diagram for GridAction:
ActionInterval FiniteTimeAction Action Ref Clonable Grid3DAction TiledGrid3DAction FlipX3D Lens3D Liquid PageTurn3D Ripple3D Shaky3D Twirl Waves Waves3D FadeOutTRTiles JumpTiles3D ShakyTiles3D ShatteredTiles3D ShuffleTiles SplitCols SplitRows TurnOffTiles WavesTiles3D

Public Member Functions

virtual GridBasegetGrid ()
 returns the grid More...
 
local getGrid ()
 returns the grid More...
 
virtual GridActionclone () const override=0
 returns a clone of action More...
 
virtual GridActionreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
var reverse ()
 returns a new action that performs the exactly the reverse action More...
 
local reverse ()
 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...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 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...
 
void setDuration (float 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...
 
NodegetTarget () const
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
local getOriginalTarget ()
void setOriginalTarget (Node *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
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () 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...
 

Protected Member Functions

 GridAction ()
virtual ~GridAction ()
var ~GridAction ()
local ~GridAction ()
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...
 
void cacheTargetAsGridNode ()
var cacheTargetAsGridNode ()
local cacheTargetAsGridNode ()
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Protected Attributes

Size _gridSize
local _gridSize
NodeGrid_gridNodeTarget
var _gridNodeTarget
local _gridNodeTarget
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _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.

Constructor & Destructor Documentation

GridAction ( )
inlineprotected
var GridAction ( )
inlineprotected
local GridAction ( )
inlineprotected
virtual ~GridAction ( )
inlineprotectedvirtual
var ~GridAction ( )
inlineprotectedvirtual
local ~GridAction ( )
inlineprotectedvirtual

Member Function Documentation

void cacheTargetAsGridNode ( )
protected
var cacheTargetAsGridNode ( )
protected
local cacheTargetAsGridNode ( )
protected
virtual GridBase* getGrid ( )
virtual

returns the grid

Reimplemented in TiledGrid3DAction, and Grid3DAction.

var getGrid ( )
virtual

returns the grid

Reimplemented in TiledGrid3DAction, and Grid3DAction.

local getGrid ( )
virtual

returns the grid

Reimplemented in TiledGrid3DAction, and Grid3DAction.

bool initWithDuration ( float  duration,
const Size gridSize 
)
protected

initializes the action with size and duration

var initWithDuration ( var  duration,
var  gridSize 
)
protected

initializes the action with size and duration

local initWithDuration ( local  duration,
local  gridSize 
)
protected

initializes the action with size and duration

virtual GridAction* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInterval.

var reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInterval.

local reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Implements 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

NodeGrid* _gridNodeTarget
protected
var _gridNodeTarget
protected
local _gridNodeTarget
protected
Size _gridSize
protected
var _gridSize
protected
local _gridSize
protected

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