Cocos2d-x  v3.12
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
WavesTiles3D Class Reference

WavesTiles3D action. More...

Inherits TiledGrid3DAction.

Public Member Functions

float getAmplitude () const
 Get the amplitude of the effect. More...
 
void setAmplitude (float amplitude)
 Set the amplitude to the effect. More...
 
float getAmplitudeRate () const
 Get the amplitude rate of the effect. More...
 
void setAmplitudeRate (float amplitudeRate)
 Set the ampliture rate of the effect. More...
 
virtual WavesTiles3Dclone () const override
 override Action.
 
- 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
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 override Action.
 
- 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)
 Sets the amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 override Action.
 

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...
 
- Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DActioncreate (float duration, const Size &gridSize)
 Create the action with size and duration. More...
 

Protected Member Functions

bool initWithDuration (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 Initializes an action with duration, grid size, waves count and amplitude. More...
 
- Protected Member Functions inherited from GridAction
bool initWithDuration (float duration, const Size &gridSize)
 Initializes the action with size and duration. More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action with the duration. More...
 

Detailed Description

WavesTiles3D action.

This action wave the target node with many tiles.

Member Function Documentation

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.

Specify the duration of the WavesTiles3D action. It's a value in seconds. Specify the size of the grid. Specify the waves count of the WavesTiles3D action. Specify the amplitude of the WavesTiles3D action. If the creation success, return a pointer of WavesTiles3D action; otherwise, return nil.

float getAmplitude ( ) const
inline

Get the amplitude of the effect.

Return the amplitude of the effect.

void setAmplitude ( float  amplitude)
inline

Set the amplitude to the effect.

The value of amplitude will be set.

float getAmplitudeRate ( void  ) const
inline

Get the amplitude rate of the effect.

Return the amplitude rate of the effect.

void setAmplitudeRate ( float  amplitudeRate)
inline

Set the ampliture rate of the effect.

The value of amplitude rate will be set.

bool initWithDuration ( float  duration,
const Size gridSize,
unsigned int  waves,
float  amplitude 
)
protected

Initializes an action with duration, grid size, waves count and amplitude.

Specify the duration of the WavesTiles3D action. It's a value in seconds. Specify the size of the grid. Specify the waves count of the WavesTiles3D action. Specify the amplitude of the WavesTiles3D action. If the initialization success, return true; otherwise, return false.


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