cocos2d-x  3.0-alpha0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Twirl Class Reference

Twirl action. More...

#include <CCActionGrid3D.h>

Inheritance diagram for Twirl:
Grid3DAction GridAction ActionInterval FiniteTimeAction Action Object Clonable

Public Member Functions

const PointgetPosition (void) const
 get twirl center More...
 
void setPosition (const Point &position)
 set twirl center More...
 
float getAmplitude (void) const
void setAmplitude (float fAmplitude)
float getAmplitudeRate (void) const
void setAmplitudeRate (float fAmplitudeRate)
bool initWithDuration (float duration, const Size &gridSize, Point position, unsigned int twirls, float amplitude)
 initializes the action with center position, number of twirls, amplitude, a grid size and duration More...
 
virtual Twirlclone () 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 GridBasegetGrid (void)
 returns the grid More...
 
local getGrid ()
 returns the grid More...
 
Vertex3F getVertex (const Point &position) const
 returns the vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F vertex (const Point &position)
Vertex3F getOriginalVertex (const Point &position) const
 returns the non-transformed vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F originalVertex (const Point &position)
void setVertex (const Point &position, const Vertex3F &vertex)
 sets a new vertex to a certain position of the grid More...
 
- Public 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...
 
virtual GridActionreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 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...
 
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 return true if the action has finished More...
 
local isDone ()
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
- Public Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
float getDuration (void) 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
 Action (void)
 ctor ()
 Action ()
virtual ~Action (void)
const char * description () const
virtual void stop (void)
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
NodegetTarget (void) const
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget (void) const
local getOriginalTarget ()
void setOriginalTarget (Node *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void) const
void setTag (int nTag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
CC_DEPRECATED_ATTRIBUTE Objectcopy () const
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. More...
 

Static Public Member Functions

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

Protected Attributes

Point _position
unsigned int _twirls
float _amplitude
float _amplitudeRate

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 

Detailed Description

Twirl action.

Member Function Documentation

virtual Twirl* clone ( ) const
overridevirtual

returns a clone of action

Implements Grid3DAction.

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

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

float getAmplitude ( void  ) const
inline
float getAmplitudeRate ( void  ) const
inline
const Point& getPosition ( void  ) const
inline

get twirl center

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

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

void setAmplitude ( float  fAmplitude)
inline
void setAmplitudeRate ( float  fAmplitudeRate)
inline
void setPosition ( const Point position)

set twirl center

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

Reimplemented from Action.

Member Data Documentation

float _amplitude
protected
float _amplitudeRate
protected
Point _position
protected
unsigned int _twirls
protected

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