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

Liquid action. More...

Inherits Grid3DAction.

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 Liquidclone () const override
 override Action.
 
- Public Member Functions inherited from Grid3DAction
virtual GridBasegetGrid () override
 Get the pointer of GridBase. More...
 
Vec3 getVertex (const Vec2 &position) const
 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...
 
Rect getGridRect () const
 Get the effect grid rect. More...
 
- 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 Liquidcreate (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 Create the action with duration, grid size, waves count and amplitude. More...
 

Protected Member Functions

bool initWithDuration (float duration, const Size &gridSize, unsigned int waves, float amplitude)
 Initializes the 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

Liquid action.

This action is used for take effect on the target node as liquid. You can create the action by these parameters: duration, grid size, waves count, amplitude of the liquid effect.

Member Function Documentation

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

Create the action with duration, grid size, waves count and amplitude.

Specify the duration of the Liquid action. It's a value in seconds. Specify the size of the grid. Specify the waves count of the Liquid action. Specify the amplitude of the Liquid action. If the creation sucess, return a pointer of Liquid 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 the action with duration, grid size, waves count and amplitude.

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


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