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

Base class for Grid3D actions. More...

Inherits GridAction.

Inherited by FlipX3D, Lens3D, Liquid, PageTurn3D, Ripple3D, Shaky3D, Twirl, Waves, and Waves3D.

Public Member Functions

virtual GridBasegetGrid () override
 Get the pointer of GridBase. More...
 
var getGrid ()
 Get the pointer of GridBase. More...
 
local getGrid ()
 Get the pointer of GridBase. More...
 
Vec3 getVertex (const Vec2 &position) const
 Get the vertex that belongs to certain position in the grid. More...
 
var vertex ( var position)
 Get the vertex that belongs to certain position in the grid. More...
 
Vec3 vertex (const Vec2 &position)
Vec3 getOriginalVertex (const Vec2 &position) const
 Get the non-transformed vertex that belongs to certain position in the grid. More...
 
Vec3 originalVertex (const Vec2 &position)
void setVertex (const Vec2 &position, const Vec3 &vertex)
 Set a new vertex to a certain position of the grid. More...
 
virtual Grid3DActionclone () const override
 Returns a clone of action. More...
 
Rect getGridRect () const
 Get the effect grid rect. More...
 
var getGridRect ()
 Get the effect grid rect. More...
 
local getGridRect ()
 Get the effect grid rect. More...
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 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...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
var getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var isDone ()
 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...
 
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...
 
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...
 
var update ( var time)
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
NodegetTarget () const
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 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...
 
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...
 
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...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local 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...
 
local getReferenceCount ()
 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...
 

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...
 
- Protected Member Functions inherited from 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...
 
- 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
 

Detailed Description

Base class for Grid3D actions.

Grid3D actions can modify a non-tiled grid.

Member Function Documentation

virtual GridBase* getGrid ( )
overridevirtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented from GridAction.

Reimplemented in PageTurn3D.

var getGrid ( )
overridevirtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented from GridAction.

Reimplemented in PageTurn3D.

local getGrid ( )
overridevirtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented from GridAction.

Reimplemented in PageTurn3D.

Vec3 getVertex ( const Vec2 position) const

Get the vertex that belongs to certain position in the grid.

Parameters
positionThe position of the grid.
Returns
Return a pointer of vertex.
var vertex ( var  position)

Get the vertex that belongs to certain position in the grid.

Parameters
positionThe position of the grid.
Returns
Return a pointer of vertex.
Vec3 vertex ( const Vec2 position)
inline
Vec3 getOriginalVertex ( const Vec2 position) const

Get the non-transformed vertex that belongs to certain position in the grid.

Parameters
positionThe position of the grid.
Returns
Return a pointer of vertex.
var originalVertex ( var  position)

Get the non-transformed vertex that belongs to certain position in the grid.

Parameters
positionThe position of the grid.
Returns
Return a pointer of vertex.
Vec3 originalVertex ( const Vec2 position)
inline
void setVertex ( const Vec2 position,
const Vec3 vertex 
)

Set a new vertex to a certain position of the grid.

Parameters
positionThe position of the grid.
vertexThe vertex will be used on the certain position of grid.
var setVertex ( var  position,
var  vertex 
)

Set a new vertex to a certain position of the grid.

Parameters
positionThe position of the grid.
vertexThe vertex will be used on the certain position of grid.
virtual Grid3DAction* clone ( ) const
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from GridAction.

Reimplemented in Twirl, Waves, Liquid, Shaky3D, Ripple3D, Lens3D, FlipY3D, FlipX3D, Waves3D, and PageTurn3D.

var clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from GridAction.

Reimplemented in Twirl, Waves, Liquid, Shaky3D, Ripple3D, Lens3D, FlipY3D, FlipX3D, Waves3D, and PageTurn3D.

local clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from GridAction.

Reimplemented in Twirl, Waves, Liquid, Shaky3D, Ripple3D, Lens3D, FlipY3D, FlipX3D, Waves3D, and PageTurn3D.

Rect getGridRect ( ) const

Get the effect grid rect.

Returns
Return the effect grid rect.
var getGridRect ( )

Get the effect grid rect.

Returns
Return the effect grid rect.
local getGridRect ( )

Get the effect grid rect.

Returns
Return the effect grid rect.

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