ShatteredTiles3D action. More...

Inherits TiledGrid3DAction.

Public Member Functions
virtual ShatteredTiles3D *	clone () const override
	Returns a clone of action.

virtual void	update (float time) override
	Called once per frame.

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
virtual GridAction *	reverse () const override
	Returns a new action that performs the exact reverse of the action.

virtual void	startWithTarget (Node *target) override
	Called before the action start.

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 bool	isDone () const override
	Return true if the action has finished.

virtual void	step (float dt) override

Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action.

void	setDuration (float duration)
	Set duration in seconds of the action.

Public Member Functions inherited from Action
virtual std::string	description () const
	NA NA

virtual void	stop ()
	Called after the action has finished.

Node *	getTarget () const
	Return certain target.

void	setTarget (Node *target)
	The action will modify the target properties.

Node *	getOriginalTarget () const
	Return a original Target.

void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil.

int	getTag () const
	Returns a tag that is used to identify the action easily.

void	setTag (int tag)
	Changes the tag that is used to identify the action easily.

unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily.

void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily.

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership.

void	release ()
	Releases the ownership immediately.

Ref *	autorelease ()
	Releases the ownership sometime soon automatically.

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count.

virtual	~Ref ()
	Destructor.

Public Member Functions inherited from Clonable
virtual	~Clonable ()
	NA NA

Static Public Member Functions
static ShatteredTiles3D *	create (float duration, const Size &gridSize, int range, bool shatterZ)
	Create the action with a range, whether of not to shatter Z vertices, grid size and duration.

Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DAction *	create (float duration, const Size &gridSize)
	Create the action with size and duration.

Protected Member Functions
bool	initWithDuration (float duration, const Size &gridSize, int range, bool shatterZ)
	Initializes the action with a range, shatter Z vertices, grid size and duration.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.

Detailed Description

ShatteredTiles3D action.

This action make the target node shattered with many tiles. You can create the action by these parameters: duration, grid size, range, whether shatter on the z axis.

Member Function Documentation

static ShatteredTiles3D* create	(	float	duration,
		const Size &	gridSize,
		int	range,
		bool	shatterZ
	)

static

Create the action with a range, whether of not to shatter Z vertices, grid size and duration.

Parameters

duration	Specify the duration of the ShatteredTiles3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
range	Specify the range of the shatter effect.
shatterZ	Specify whether shatter on the z axis.

Returns: If the creation success, return a pointer of ShatteredTiles3D action; otherwise, return nil.

virtual ShatteredTiles3D* clone ( ) const

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from TiledGrid3DAction.

virtual void update ( float time )

overridevirtual

Called once per frame.

time a value between 0 and 1.

For example:

0 Means that the action just started.
0.5 Means that the action is in the middle.
1 Means that the action is over.

Parameters

time	A value between 0 and 1.

Reimplemented from Action.

bool initWithDuration	(	float	duration,
		const Size &	gridSize,
		int	range,
		bool	shatterZ
	)

protected

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

Parameters

duration	Specify the duration of the ShatteredTiles3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
range	Specify the range of the shatter effect.
shatterZ	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:

CCActionTiledGrid.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation