Shaky3D Class Reference

Shaky3D action. More...

#include <ActionGrid3D.h>

Inherits Grid3DAction.

Public Member Functions
bool	initWithDuration (float duration, const Vec2 &gridSize, int range, bool shakeZ)
	Initializes the action with a range, shake Z vertices, 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 Shaky3D *	create (float initWithDuration, const Vec2 &gridSize, int range, bool shakeZ)
	Create the action with a range, shake Z vertices, a grid and duration.

Detailed Description

Shaky3D action.

This action is used for take effect on the target node as shaky. You can create the action by these parameters: duration, grid size, range, whether shake on the z axis.

Member Function Documentation

create()

Shaky3D * create ( float initWithDuration, const Vec2 & gridSize, int range, bool shakeZ )

static

Create the action with a range, shake Z vertices, a grid and duration.

Parameters

initWithDuration	Specify the duration of the Shaky3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
range	Specify the range of the shaky effect.
shakeZ	Specify whether shake on the z axis.

Returns

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

initWithDuration()

bool initWithDuration	(	float	duration,
		const Vec2 &	gridSize,
		int	range,
		bool	shakeZ )

Initializes the action with a range, shake Z vertices, grid size and duration.

Parameters

duration	Specify the duration of the Shaky3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
range	Specify the range of the shaky effect.
shakeZ	Specify whether shake on the z axis.

Returns

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

---

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

• ActionGrid3D.h