Ripple3D Class Reference

Ripple3D action. More...

#include <ActionGrid3D.h>

Inherits Grid3DAction.

Public Member Functions
const Vec2 &	getPosition () const
	Get the center position of ripple effect.
void	setPosition (const Vec2 &position)
	Set the center position of ripple effect.
float	getAmplitude () const
	Get the amplitude of ripple effect.
void	setAmplitude (float fAmplitude)
	Set the amplitude of ripple effect.
float	getAmplitudeRate () const
	Get the amplitude rate of ripple effect.
void	setAmplitudeRate (float fAmplitudeRate)
	Set the amplitude rate of ripple effect.
bool	initWithDuration (float duration, const Vec2 &gridSize, const Vec2 &position, float radius, unsigned int waves, float amplitude)
	Initializes the action with center position, radius, number of waves, amplitude, a grid size and duration.
Public Member Functions inherited from Grid3DAction
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.
void	step (float dt) override
bool	initWithDuration (float d)
	initializes the action

Static Public Member Functions
static Ripple3D *	create (float duration, const Vec2 &gridSize, const Vec2 &position, float radius, unsigned int waves, float amplitude)
	Create the action with center position, radius, number of waves, amplitude, a grid size and duration.

Detailed Description

Ripple3D action.

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

Member Function Documentation

create()

Ripple3D * create ( float duration, const Vec2 & gridSize, const Vec2 & position, float radius, unsigned int waves, float amplitude )

static

Create the action with center position, radius, number of waves, amplitude, a grid size and duration.

Parameters

duration	Specify the duration of the Ripple3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the ripple effect.
radius	Specify the radius of the ripple effect.
waves	Specify the waves count of the ripple effect.
amplitude	Specify the amplitude of the ripple effect.

Returns

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

getPosition()

const Vec2 & getPosition ( ) const

inline

Get the center position of ripple effect.

Returns

The center position of ripple effect.

setPosition()

void setPosition

(

const Vec2 &

position

)

Set the center position of ripple effect.

Parameters

position

The center position of ripple effect will be set.

getAmplitude()

float getAmplitude ( ) const

inline

Get the amplitude of ripple effect.

Returns

The amplitude of ripple effect.

setAmplitude()

void setAmplitude ( float fAmplitude )

inline

Set the amplitude of ripple effect.

Parameters

fAmplitude

The amplitude of ripple effect.

getAmplitudeRate()

float getAmplitudeRate ( ) const

inline

Get the amplitude rate of ripple effect.

Returns

The amplitude rate of ripple effect.

setAmplitudeRate()

void setAmplitudeRate ( float fAmplitudeRate )

inline

Set the amplitude rate of ripple effect.

Parameters

fAmplitudeRate

The amplitude rate of ripple effect.

initWithDuration()

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

Initializes the action with center position, radius, number of waves, amplitude, a grid size and duration.

Parameters

duration	Specify the duration of the Ripple3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the ripple effect.
radius	Specify the radius of the ripple effect.
waves	Specify the waves count of the ripple effect.
amplitude	Specify the amplitude of the ripple effect.

Returns

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

---

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

• ActionGrid3D.h