Cocos2d-x  v3.10
Twirl Class Reference

Twirl action. More...

Inherits Grid3DAction.

## Public Member Functions

const Vec2getPosition () const
Get the center position of twirl action. More...

var getPosition ()
Get the center position of twirl action. More...

local getPosition ()
Get the center position of twirl action. More...

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

var setPosition ( var position)
Set the center position of twirl action. More...

local setPosition ( local position)
Set the center position of twirl action. More...

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

var getAmplitude ()
Get the amplitude of the effect. More...

local getAmplitude ()
Get the amplitude of the effect. More...

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

var setAmplitude ( var amplitude)
Set the amplitude to the effect. More...

local setAmplitude ( local amplitude)
Set the amplitude to the effect. More...

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

local getAmplitudeRate ()
Get the amplitude rate of the effect. More...

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

local setAmplitudeRate ( local amplitudeRate)
Set the ampliture rate of the effect. More...

virtual Twirlclone () const override
override Action.

local clone ()
override Action.

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

local update ( local time)
Called once per frame. More...

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

var getGrid ()
Get the pointer of GridBase. More...

local getGrid ()
Get the pointer of GridBase. More...

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

var vertex ( var position)
Get the vertex that belongs to certain position in the grid. More...

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

Vec3 originalVertex (const Vec2 &position)
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...

var getGridRect ()
Get the effect grid rect. More...

local getGridRect ()
Get the effect grid rect. More...

Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
override Action.

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

local startWithTarget ( local target)
Called before the action start. More...

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

var getElapsed ()
How many seconds had elapsed since the actions started to run. More...

local 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 (void)
Gets the ampliture rate, extension in GridAction. More...

virtual bool isDone (void) const override
override Action.

local isDone ()
override Action.

virtual void step (float dt) override
Called every frame with its delta time, dt in seconds. More...

var step ( var dt)
Called every frame with its delta time, dt in seconds. More...

local step ( local dt)
Called every frame with its delta time, dt in seconds. More...

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

var getDuration ()
Get duration in seconds of the action. More...

local getDuration ()
Get duration in seconds of the action. More...

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

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

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

Public Member Functions inherited from Action
virtual void stop ()
Called after the action that has finished. More...

NodegetTarget () const
Return the current target. More...

void setTarget (Node *target)
The setter function for the target property. More...

var setTarget ( var target)
The setter function for the target property. More...

local setTarget ( local target)
The setter function for the target property. More...

NodegetOriginalTarget () const
Return the original Target. More...

var getOriginalTarget ()
Return the original Target. More...

local getOriginalTarget ()
Return the original Target. More...

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

var setOriginalTarget ( var originalTarget)
Set the original target, since target can be nil. More...

local setOriginalTarget ( local 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...

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

local getTag ()
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...

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

local setTag ( local 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)
Returns a flag field that is used to group the actions easily. More...

var setFlags ( var flags)
Returns a flag field that is used to group the actions easily. More...

local setFlags ( local flags)
Returns a flag field that is used to group the actions easily. More...

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

local retain ()
Retains the ownership. More...

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

Refautorelease ()
Releases the ownership sometime soon automatically. More...

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

local getReferenceCount ()
Returns the Ref's current reference count. More...

virtual ~Ref ()
Destructor.

Public Member Functions inherited from Clonable
Refcopy () const
Returns a copy of the Ref.

## Static Public Member Functions

static Twirlcreate (float duration, const Size &gridSize, Vec2 position, unsigned int twirls, float amplitude)
Create the action with duration, grid size, center position, number of twirls and amplitude. More...

local create ( local duration, local gridSize, local position, local twirls, local amplitude)
Create the action with duration, grid size, center position, number of twirls and amplitude. More...

## Protected Member Functions

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

local initWithDuration ( local duration, local gridSize, local position, local twirls, local amplitude)
Initializes the action with duration, grid size, center position, number of twirls and amplitude. More...

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

var initWithDuration ( var duration, var gridSize)
Initializes the action with size and duration. More...

local initWithDuration ( local duration, local gridSize)
Initializes the action with size and duration. More...

Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
initializes the action with the duration. More...

var initWithDuration ( var d)
initializes the action with the duration. More...

local initWithDuration ( local d)
initializes the action with the duration. More...

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

local _ID
object id, ScriptSupport need public _ID

int _luaID
Lua reference id.

local _luaID
Lua reference id.

void * _scriptObject
scriptObject, support for swift

local _scriptObject
scriptObject, support for swift

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

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

bool _scriptOwned
The life of the object is scrolled by the scripting engine. More...

local _scriptOwned
The life of the object is scrolled by the scripting engine. More...

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

var INVALID_TAG = -1
Default tag used for all the actions.

local 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

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

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the creation sucess, return a pointer of Twirl action; otherwise, return nil.

 var create ( var duration, var gridSize, var position, var twirls, var amplitude )
static

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the creation sucess, return a pointer of Twirl action; otherwise, return nil.

 local create ( local duration, local gridSize, local position, local twirls, local amplitude )
static

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the creation sucess, return a pointer of Twirl action; otherwise, return nil.

 const Vec2& getPosition ( ) const
inline

Get the center position of twirl action.

The center position of twirl action.

 var getPosition ( )
inline

Get the center position of twirl action.

The center position of twirl action.

 local getPosition ( )
inline

Get the center position of twirl action.

The center position of twirl action.

 void setPosition ( const Vec2 & position )

Set the center position of twirl action.

The center position of twirl action will be set.

 var setPosition ( var position )

Set the center position of twirl action.

The center position of twirl action will be set.

 local setPosition ( local position )

Set the center position of twirl action.

The center position of twirl action will be set.

 float getAmplitude ( ) const
inline

Get the amplitude of the effect.

Return the amplitude of the effect.

 var getAmplitude ( )
inline

Get the amplitude of the effect.

Return the amplitude of the effect.

 local getAmplitude ( )
inline

Get the amplitude of the effect.

Return the amplitude of the effect.

 void setAmplitude ( float amplitude )
inline

Set the amplitude to the effect.

The value of amplitude will be set.

 var setAmplitude ( var amplitude )
inline

Set the amplitude to the effect.

The value of amplitude will be set.

 local setAmplitude ( local amplitude )
inline

Set the amplitude to the effect.

The value of amplitude will be set.

 float getAmplitudeRate ( void ) const
inline

Get the amplitude rate of the effect.

Return the amplitude rate of the effect.

 var getAmplitudeRate ( )
inline

Get the amplitude rate of the effect.

Return the amplitude rate of the effect.

 local getAmplitudeRate ( )
inline

Get the amplitude rate of the effect.

Return the amplitude rate of the effect.

 void setAmplitudeRate ( float amplitudeRate )
inline

Set the ampliture rate of the effect.

The value of amplitude rate will be set.

 var setAmplitudeRate ( var amplitudeRate )
inline

Set the ampliture rate of the effect.

The value of amplitude rate will be set.

 local setAmplitudeRate ( local amplitudeRate )
inline

Set the ampliture rate of the effect.

The value of amplitude rate will be set.

 virtual void update ( float time )
overridevirtual

Called once per frame.

time is 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.

A value between 0 and 1.

Reimplemented from Action.

 var update ( var time )
overridevirtual

Called once per frame.

time is 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.

A value between 0 and 1.

Reimplemented from Action.

 local update ( local time )
overridevirtual

Called once per frame.

time is 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.

A value between 0 and 1.

Reimplemented from Action.

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

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the initialization sucess, return true; otherwise, return false.

 var initWithDuration ( var duration, var gridSize, var position, var twirls, var amplitude )
protected

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the initialization sucess, return true; otherwise, return false.

 local initWithDuration ( local duration, local gridSize, local position, local twirls, local amplitude )
protected

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

Specify the duration of the Twirl action. It's a value in seconds. Specify the size of the grid. Specify the center position of the twirl action. Specify the twirls count of the Twirl action. Specify the amplitude of the Twirl action. If the initialization sucess, return true; otherwise, return false.

The documentation for this class was generated from the following file:
• CCActionGrid3D.h