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

WavesTiles3D action. More...

#include <CCActionTiledGrid.h>

Inheritance diagram for WavesTiles3D:
TiledGrid3DAction GridAction ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

float getAmplitude () const
 Get the amplitude of the effect. More...
 
void setAmplitude (float amplitude)
 Set the amplitude to the effect. More...
 
var setAmplitude ( var amplitude)
 Set the amplitude to the effect. More...
 
local setAmplitude ( local amplitude)
 Set the amplitude to the effect. More...
 
float getAmplitudeRate () const
 Get the amplitude rate of the effect. More...
 
var getAmplitudeRate ()
 Get the amplitude rate of the effect. More...
 
local getAmplitudeRate ()
 Get the amplitude rate of the effect. More...
 
void setAmplitudeRate (float amplitudeRate)
 Set the ampliture rate of the effect. More...
 
var setAmplitudeRate ( var amplitudeRate)
 Set the ampliture rate of the effect. More...
 
local setAmplitudeRate ( local amplitudeRate)
 Set the ampliture rate of the effect. More...
 
virtual WavesTiles3Dclone () 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 void update (float time) override
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
- Public Member Functions inherited from TiledGrid3DAction
Quad3 getTile (const Vec2 &position) const
 Get the tile that belongs to a certain position of the grid. More...
 
Quad3 tile (const Vec2 &position)
Quad3 getOriginalTile (const Vec2 &position) const
 Get the non-transformed tile that belongs to a certain position of the grid. More...
 
Quad3 originalTile (const Vec2 &position)
void setTile (const Vec2 &position, const Quad3 &coords)
 Set a new tile to a certain position of the grid. More...
 
virtual GridBasegetGrid () override
 returns 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 WavesTiles3Dcreate (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 Create the action with a number of waves, the waves amplitude, the grid size and the duration. More...
 
var create ( var duration, var gridSize, var waves, var amplitude)
 Create the action with a number of waves, the waves amplitude, the grid size and the duration. More...
 
local create ( local duration, local gridSize, local waves, local amplitude)
 Create the action with a number of waves, the waves amplitude, the grid size and the duration. More...
 
- Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DActioncreate (float duration, const Size &gridSize)
 Create the action with size and duration. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: WavesTiles3D() {} virtual ~WavesTiles3D() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const SizegridSize
var gridSize
local gridSize
CC_CONSTRUCTOR_ACCESS const
Size unsigned int 
waves
var waves
local waves
CC_CONSTRUCTOR_ACCESS const
Size unsigned int float 
amplitude
- 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

unsigned int _waves
var _waves
local _waves
float _amplitude
local _amplitude
float _amplitudeRate
var _amplitudeRate
local _amplitudeRate
- 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

WavesTiles3D action.

This action wave the target node with many tiles.

Member Function Documentation

virtual WavesTiles3D* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

static WavesTiles3D* create ( float  duration,
const Size gridSize,
unsigned int  waves,
float  amplitude 
)
static

Create the action with a number of waves, the waves amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the WavesTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
wavesSpecify the waves count of the WavesTiles3D action.
amplitudeSpecify the amplitude of the WavesTiles3D action.
Returns
If the creation success, return a pointer of WavesTiles3D action; otherwise, return nil.
var create ( var  duration,
var  gridSize,
var  waves,
var  amplitude 
)
static

Create the action with a number of waves, the waves amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the WavesTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
wavesSpecify the waves count of the WavesTiles3D action.
amplitudeSpecify the amplitude of the WavesTiles3D action.
Returns
If the creation success, return a pointer of WavesTiles3D action; otherwise, return nil.
local create ( local  duration,
local  gridSize,
local  waves,
local  amplitude 
)
static

Create the action with a number of waves, the waves amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the WavesTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
wavesSpecify the waves count of the WavesTiles3D action.
amplitudeSpecify the amplitude of the WavesTiles3D action.
Returns
If the creation success, return a pointer of WavesTiles3D action; otherwise, return nil.
float getAmplitude ( ) const
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
var getAmplitude ( )
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
local getAmplitude ( )
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
float getAmplitudeRate ( void  ) const
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
var getAmplitudeRate (   )
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
local getAmplitudeRate (   )
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
void setAmplitude ( float  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
var setAmplitude ( var  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
local setAmplitude ( local  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
void setAmplitudeRate ( float  amplitudeRate)
inline

Set the ampliture rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
var setAmplitudeRate ( var  amplitudeRate)
inline

Set the ampliture rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
local setAmplitudeRate ( local  amplitudeRate)
inline

Set the ampliture rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
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

float _amplitude
protected
var _amplitude
protected
local _amplitude
protected
float _amplitudeRate
protected
var _amplitudeRate
protected
local _amplitudeRate
protected
unsigned int _waves
protected
var _waves
protected
local _waves
protected
CC_CONSTRUCTOR_ACCESS const
Size unsigned int float
amplitude
var amplitude
local amplitude
CC_CONSTRUCTOR_ACCESS const
Size& gridSize
var gridSize
local gridSize
CC_CONSTRUCTOR_ACCESS const
Size unsigned int waves
var waves
local waves

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