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

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 Waves3D *	clone () const override
	override `Action`.

var	clone ()
	override `Action`.

local	clone ()
	override `Action`.

Public Member Functions inherited from Grid3DAction
virtual GridBase *	getGrid () override
	Get the pointer of GridBase. More...

var	getGrid ()
	Get the pointer of GridBase. More...

local	getGrid ()
	Get the pointer of GridBase. More...

Vec3	getVertex (const Vec2 &position) const
	Get the vertex that belongs to certain position in the grid. More...

var	vertex ( var position)
	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...

var	getGridRect ()
	Get the effect grid rect. More...

local	getGridRect ()
	Get the effect grid rect. More...

Public Member Functions inherited from GridAction
virtual GridAction *	reverse () 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...

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

local	isDone ()
	override `Action`.

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

local	create ( local duration, local gridSize, local waves, local amplitude)
	Create an action with duration, grid size, waves and amplitude. More...

Protected Member Functions
bool	initWithDuration (float duration, const Size &gridSize, unsigned int waves, float amplitude)
	Initializes an action with duration, grid size, waves and amplitude. More...

var	initWithDuration ( var duration, var gridSize, var waves, var amplitude)
	Initializes an action with duration, grid size, waves and amplitude. More...

local	initWithDuration ( local duration, local gridSize, local waves, local amplitude)
	Initializes an action with duration, grid size, waves and amplitude. More...

Protected Member Functions inherited from GridAction
bool	initWithDuration (float duration, const Size &gridSize)
	Initializes the action with size and duration. More...

var	initWithDuration ( var duration, var gridSize)
	Initializes the action with size and duration. More...

local	initWithDuration ( local duration, local 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...

var	initWithDuration ( var d)
	initializes the action with the duration. More...

local	initWithDuration ( local d)
	initializes the action with the duration. More...

Detailed Description

Waves3D action.

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

Member Function Documentation

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

static

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

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

var create	(	var	duration,
		var	gridSize,
		var	waves,
		var	amplitude
	)

static

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

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

local create	(	local	duration,
		local	gridSize,
		local	waves,
		local	amplitude
	)

static

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

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

float getAmplitude ( ) const

inline

Get the amplitude of the effect.

Return the amplitude of the effect.

var getAmplitude ( )

inline

Get the amplitude of the effect.

Return the amplitude of the effect.

local getAmplitude ( )

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.

var setAmplitude ( var amplitude )

inline

Set the amplitude to the effect.

The value of amplitude will be set.

local setAmplitude ( local 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.

var getAmplitudeRate ( )

inline

Get the amplitude rate of the effect.

Return the amplitude rate of the effect.

local getAmplitudeRate ( )

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.

var setAmplitudeRate ( var amplitudeRate )

inline

Set the ampliture rate of the effect.

The value of amplitude rate will be set.

local setAmplitudeRate ( local 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 and amplitude.

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

var initWithDuration	(	var	duration,
		var	gridSize,
		var	waves,
		var	amplitude
	)

protected

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

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

local initWithDuration	(	local	duration,
		local	gridSize,
		local	waves,
		local	amplitude
	)

protected

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

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

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

CCActionGrid3D.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation