Waves3D Class Reference

Waves3D action. More...

#include <ActionGrid3D.h>

Inherits Grid3DAction.

Public Member Functions
float	getAmplitude () const
	Get the amplitude of the effect.
void	setAmplitude (float amplitude)
	Set the amplitude to the effect.
float	getAmplitudeRate () const
	Get the amplitude rate of the effect.
void	setAmplitudeRate (float amplitudeRate)
	Set the amplitude rate of the effect.
bool	initWithDuration (float duration, const Vec2 &gridSize, unsigned int waves, float amplitude)
	Initializes an action with duration, grid size, waves and amplitude.
Public Member Functions inherited from Grid3DAction
virtual GridBase *	getGrid () override
	Get the pointer of GridBase.
Vec3	getVertex (const Vec2 &position) const
	Get the vertex that belongs to certain position in the grid.
Vec3	getOriginalVertex (const Vec2 &position) const
	Get the non-transformed vertex that belongs to certain position in the grid.
void	setVertex (const Vec2 &position, const Vec3 &vertex)
	Set a new vertex to a certain position of the grid.
Rect	getGridRect () const
	Get the effect grid rect.
Public Member Functions inherited from GridAction
bool	initWithDuration (float duration, const Vec2 &gridSize)
	Initializes the action with size and duration.
Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run.
void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction.
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction.
virtual void	step (float dt) override
bool	initWithDuration (float d)
	initializes the action

Static Public Member Functions
static Waves3D *	create (float duration, const Vec2 &gridSize, unsigned int waves, float amplitude)
	Create an action with duration, grid size, waves and amplitude.

Detailed Description

Waves3D action.

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

Member Function Documentation

create()

static Waves3D * create ( float duration, const Vec2 & gridSize, unsigned int waves, float amplitude )

static

Create an action with duration, grid size, waves and amplitude.

Parameters

duration	Specify the duration of the Waves3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
waves	Specify the waves count of the Waves3D action.
amplitude	Specify the amplitude of the Waves3D action.

Returns

If the creation success, return a pointer of Waves3D action; otherwise, return nil.

getAmplitude()

float getAmplitude ( ) const

inline

Get the amplitude of the effect.

Returns

Return the amplitude of the effect.

setAmplitude()

void setAmplitude ( float amplitude )

inline

Set the amplitude to the effect.

Parameters

amplitude

The value of amplitude will be set.

getAmplitudeRate()

float getAmplitudeRate ( ) const

inline

Get the amplitude rate of the effect.

Returns

Return the amplitude rate of the effect.

setAmplitudeRate()

void setAmplitudeRate ( float amplitudeRate )

inline

Set the amplitude rate of the effect.

Parameters

amplitudeRate

The value of amplitude rate will be set.

initWithDuration()

bool initWithDuration	(	float	duration,
		const Vec2 &	gridSize,
		unsigned int	waves,
		float	amplitude )

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

Parameters

duration	Specify the duration of the Waves3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
waves	Specify the waves count of the Waves3D action.
amplitude	Specify the amplitude of the Waves3D action.

Returns

If the initialization success, return true; otherwise, return false.

---

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

• ActionGrid3D.h