cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Shaky3D Class Reference

Shaky3D action. More...

#include <CCActionGrid3D.h>

Inheritance diagram for Shaky3D:
Grid3DAction GridAction ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual Shaky3Dclone () const override
 Returns a clone of action. More...
 
virtual void update (float time) override
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
- Public Member Functions inherited from Grid3DAction
virtual GridBasegetGrid () override
 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...
 
- Public Member Functions inherited from GridAction
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. More...
 
local startWithTarget ( local target)
 Called before the action start. 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)
 Sets the ampliture rate, extension in GridAction. More...
 
local setAmplitudeRate ( local amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
local 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...
 
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...
 
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...
 
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...
 
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
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static Shaky3Dcreate (float initWithDuration, const Size &gridSize, int range, bool shakeZ)
 Create the action with a range, shake Z vertices, a grid and duration. More...
 
local create ( local initWithDuration, local gridSize, local range, local shakeZ)
 Create the action with a range, shake Z vertices, a grid and duration. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Shaky3D() {} virtual ~Shaky3D() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const SizegridSize
var gridSize
local gridSize
CC_CONSTRUCTOR_ACCESS const
Size int 
range
var range
local range
CC_CONSTRUCTOR_ACCESS const
Size int bool 
shakeZ
var shakeZ
local shakeZ
- Public Attributes inherited from GridAction
CC_CONSTRUCTOR_ACCESS __pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const SizegridSize
var gridSize
local gridSize
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __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 Attributes

int _randrange
var _randrange
local _randrange
bool _shakeZ
var _shakeZ
local _shakeZ
- Protected Attributes inherited from GridAction
Size _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...
 
- Protected Member Functions inherited from GridAction
void cacheTargetAsGridNode ()
var cacheTargetAsGridNode ()
local cacheTargetAsGridNode ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Shaky3D action.

This action is used for take effect on the target node as shaky. You can create the action by these parameters: duration, grid size, range, whether shake on the z axis.

Member Function Documentation

virtual Shaky3D* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Grid3DAction.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Grid3DAction.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Grid3DAction.

static Shaky3D* create ( float  initWithDuration,
const Size gridSize,
int  range,
bool  shakeZ 
)
static

Create the action with a range, shake Z vertices, a grid and duration.

Parameters
durationSpecify the duration of the Shaky3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
rangeSpecify the range of the shaky effect.
shakeZSpecify whether shake on the z axis.
Returns
If the creation sucess, return a pointer of Shaky3D action; otherwise, return nil.
var create ( var  initWithDuration,
var  gridSize,
var  range,
var  shakeZ 
)
static

Create the action with a range, shake Z vertices, a grid and duration.

Parameters
durationSpecify the duration of the Shaky3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
rangeSpecify the range of the shaky effect.
shakeZSpecify whether shake on the z axis.
Returns
If the creation sucess, return a pointer of Shaky3D action; otherwise, return nil.
local create ( local  initWithDuration,
local  gridSize,
local  range,
local  shakeZ 
)
static

Create the action with a range, shake Z vertices, a grid and duration.

Parameters
durationSpecify the duration of the Shaky3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
rangeSpecify the range of the shaky effect.
shakeZSpecify whether shake on the z axis.
Returns
If the creation sucess, return a pointer of Shaky3D action; otherwise, return nil.
virtual void update ( float  time)
overridevirtual

Called once per frame.

time a value between 0 and 1.

For example:

  • 0 Means that the action just started.
  • 0.5 Means that the action is in the middle.
  • 1 Means that the action is over.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

var update ( var  time)
overridevirtual

Called once per frame.

time a value between 0 and 1.

For example:

  • 0 Means that the action just started.
  • 0.5 Means that the action is in the middle.
  • 1 Means that the action is over.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

local update ( local  time)
overridevirtual

Called once per frame.

time a value between 0 and 1.

For example:

  • 0 Means that the action just started.
  • 0.5 Means that the action is in the middle.
  • 1 Means that the action is over.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

Member Data Documentation

int _randrange
protected
var _randrange
protected
local _randrange
protected
bool _shakeZ
protected
var _shakeZ
protected
local _shakeZ
protected
CC_CONSTRUCTOR_ACCESS const
Size& gridSize
var gridSize
local gridSize
CC_CONSTRUCTOR_ACCESS const
Size int range
var range
local range
CC_CONSTRUCTOR_ACCESS const
Size int bool shakeZ
var shakeZ
local shakeZ

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