Cocos2d-x  v3.10
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.
 
virtual void update (float time) override
 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
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 override Action.
 
virtual void startWithTarget (Node *target) override
 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...
 
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.
 
virtual void step (float dt) override
 Called every frame with its delta time, dt in seconds. More...
 
- Public Member Functions inherited from FiniteTimeAction
float getDuration () const
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
virtual void stop ()
 Called after the action that has finished. More...
 
NodegetTarget () const
 Return the current target. More...
 
void setTarget (Node *target)
 The setter function for the target property. More...
 
NodegetOriginalTarget () const
 Return the 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...
 
void setTag (int 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...
 
void setFlags (unsigned int flags)
 Returns a 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...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref.
 

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...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions.
 

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.

virtual void update ( float  time)
overridevirtual

Called once per frame.

time is 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.

    A value between 0 and 1.

Reimplemented from Action.

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: