JumpTiles3D Class Reference

JumpTiles3D action. More...

#include <ActionTiledGrid.h>

Inherits TiledGrid3DAction.

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 numberOfJumps, float amplitude)
	Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration.
Public Member Functions inherited from TiledGrid3DAction
Quad3	getTile (const Vec2 &position) const
	Get the tile that belongs to a certain position of the grid.
Quad3	getOriginalTile (const Vec2 &position) const
	Get the non-transformed tile that belongs to a certain position of the grid.
void	setTile (const Vec2 &position, const Quad3 &coords)
	Set a new tile to a certain position of the grid.
virtual GridBase *	getGrid () override
	returns the grid
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 JumpTiles3D *	create (float duration, const Vec2 &gridSize, unsigned int numberOfJumps, float amplitude)
	Create the action with the number of jumps, the sin amplitude, the grid size and the duration.
Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DAction *	create (float duration, const Vec2 &gridSize)
	Create the action with size and duration.

Detailed Description

JumpTiles3D action.

Move the tiles of a target node across the Z axis.

Member Function Documentation

create()

static JumpTiles3D * create ( float duration, const Vec2 & gridSize, unsigned int numberOfJumps, float amplitude )

static

Create the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters

duration	Specify the duration of the JumpTiles3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
numberOfJumps	Specify the jump tiles count.
amplitude	Specify the amplitude of the JumpTiles3D action.

Returns

If the creation success, return a pointer of JumpTiles3D 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	numberOfJumps,
		float	amplitude )

Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters

duration	Specify the duration of the JumpTiles3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
numberOfJumps	Specify the jump tiles count.
amplitude	Specify the amplitude of the JumpTiles3D action.

Returns

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

---

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

• ActionTiledGrid.h