Twirl action. More...

Inherits Grid3DAction.

Public Member Functions
const Vec2 &	getPosition () const
	Get the center position of twirl action. More...

void	setPosition (const Vec2 &position)
	Set the center position of twirl action. More...

float	getAmplitude () const
	Get the amplitude of the effect. More...

void	setAmplitude (float amplitude)
	Set the amplitude to the effect. More...

float	getAmplitudeRate () const
	Get the amplitude rate of the effect. More...

void	setAmplitudeRate (float amplitudeRate)
	Set the amplitude rate of the effect. More...

virtual Twirl *	clone () const override
	Returns a clone of action. More...

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

Public Member Functions inherited from Grid3DAction
virtual GridBase *	getGrid () override
	Get the pointer of GridBase. More...

Vec3	getVertex (const Vec2 &position) const
	Get the vertex that belongs to certain position in the grid. More...

Vec3	getOriginalVertex (const Vec2 &position) const
	Get the non-transformed vertex that belongs to certain position in the grid. More...

void	setVertex (const Vec2 &position, const Vec3 &vertex)
	Set a new vertex to a certain position of the grid. More...

Rect	getGridRect () const
	Get the effect grid rect. More...

Public Member Functions inherited from GridAction
virtual GridAction *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...

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

Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run. More...

void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction. More...

float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction. More...

virtual bool	isDone () const override
	Return true if the action has finished. More...

virtual void	step (float dt) override

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

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

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

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

Node *	getTarget () const
	Return certain target. More...

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

Node *	getOriginalTarget () const
	Return a original Target. More...

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

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

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

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

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

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

void	release ()
	Releases the ownership immediately. More...

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

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

virtual	~Ref ()
	Destructor. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

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

Protected Member Functions
bool	initWithDuration (float duration, const Size &gridSize, const Vec2 &position, unsigned int twirls, float amplitude)
	Initializes the action with center position, number of twirls, amplitude, a grid size and duration. More...

Protected Member Functions inherited from GridAction
bool	initWithDuration (float duration, const Size &gridSize)
	Initializes the action with size and duration. More...

Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

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

Twirl action.

This action is used for take effect on the target node as twirl. You can control the effect by these parameters: duration, grid size, center position, twirls count, amplitude.

Member Function Documentation

◆ create()

static Twirl* create	(	float	duration,
		const Size &	gridSize,
		const Vec2 &	position,
		unsigned int	twirls,
		float	amplitude
	)

static

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

Parameters

duration	Specify the duration of the Twirl action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the twirl action.
twirls	Specify the twirls count of the Twirl action.
amplitude	Specify the amplitude of the Twirl action.

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

◆ getPosition()

const Vec2& getPosition ( ) const

inline

Get the center position of twirl action.

Returns: The center position of twirl action.

◆ setPosition()

void setPosition ( const Vec2 & position )

Set the center position of twirl action.

Parameters

position The center position of twirl action will be set.

◆ 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.

◆ clone()

virtual Twirl* clone ( ) const

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from Grid3DAction.

◆ update()

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.

◆ initWithDuration()

bool initWithDuration	(	float	duration,
		const Size &	gridSize,
		const Vec2 &	position,
		unsigned int	twirls,
		float	amplitude
	)

protected

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

Parameters

duration	Specify the duration of the Twirl action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the twirl action.
twirls	Specify the twirls count of the Twirl action.
amplitude	Specify the amplitude of the Twirl action.

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

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

CCActionGrid3D.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getPosition()

◆ setPosition()

◆ getAmplitude()

◆ setAmplitude()

◆ getAmplitudeRate()

◆ setAmplitudeRate()

◆ clone()

◆ update()

◆ initWithDuration()