TiledGrid3DAction Class Reference

Base class for TiledGrid3D actions. More...

Inherits GridAction.

Inherited by FadeOutTRTiles, JumpTiles3D, ShakyTiles3D, ShatteredTiles3D, ShuffleTiles, SplitCols, SplitRows, TurnOffTiles, and WavesTiles3D.

Public Member Functions
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
virtual TiledGrid3DAction *	clone () const override
	Returns a clone of action.
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.
virtual void	update (float time)
	Called once per frame.
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 TiledGrid3DAction *	create (float duration, const Size &gridSize)
	Create the action with 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.
Protected Member Functions inherited from GridAction
bool	initWithDuration (float duration, const Size &gridSize)
	Initializes the action with size and duration.

Detailed Description

Base class for TiledGrid3D actions.

Member Function Documentation

static TiledGrid3DAction* create ( float  duration, const Size &  gridSize  )

static

Create the action with size and duration.

Parameters

duration	The duration of the action. It's a value in seconds.
gridSize	Specify the grid size of the action.

Returns

A pointer of TiledGrid3DAction. If creation failed, return nil. NA

Quad3 getTile

(

const Vec2 &

position

)

const

Get the tile that belongs to a certain position of the grid.

Parameters

position

The position of the tile want to get.

Returns

A quadrilateral of the tile. tile NA

Quad3 getOriginalTile

(

const Vec2 &

position

)

const

Get the non-transformed tile that belongs to a certain position of the grid.

Parameters

position

The position of the tile want to get.

Returns

A quadrilateral of the tile. originalTile NA

void setTile	(	const Vec2 &	position,
		const Quad3 &	coords
	)

Set a new tile to a certain position of the grid.

Parameters

position	The position of the tile.
coords	The quadrilateral of the new tile. NA

virtual TiledGrid3DAction* clone ( ) const

inlineoverridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from GridAction.

Reimplemented in SplitCols, SplitRows, JumpTiles3D, WavesTiles3D, TurnOffTiles, FadeOutDownTiles, FadeOutUpTiles, FadeOutBLTiles, FadeOutTRTiles, ShuffleTiles, ShatteredTiles3D, and ShakyTiles3D.

---

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

• CCActionGrid.h