cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
DeccelAmplitude Class Reference

DeccelAmplitude action. More...

#include <CCActionGrid.h>

Inheritance diagram for DeccelAmplitude:
ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

float getRate () const
 Get the value of amplitude rate. More...
 
void setRate (float rate)
 Set the value of amplitude rate. More...
 
local setRate ( local rate)
 Set the value of amplitude rate. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void update (float time) override
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
virtual DeccelAmplitudeclone () const override
 Returns a clone of action. More...
 
virtual DeccelAmplitudereverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
local reverse ()
 Returns a new action that performs the exactly the reverse action. More...
 
bool initWithAction (Action *action, float duration)
 Initializes the action with an inner action that has the amplitude property, and a duration time. More...
 
local initWithAction ( local action, local duration)
 Initializes the action with an inner action that has the amplitude property, and a duration time. 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 ampliture rate, extension in GridAction. More...
 
local setAmplitudeRate ( local amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
local isDone ()
 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...
 
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 std::string description () const
virtual void stop ()
 Called after the action has finished. More...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 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...
 
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...
 
virtual ~Action ()
var ~Action ()
local ~Action ()
- Public Member Functions inherited from Ref
void 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...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static DeccelAmplitudecreate (Action *action, float duration)
 Creates the action with an inner action that has the amplitude property, and a duration time. More...
 
local create ( local action, local duration)
 Creates the action with an inner action that has the amplitude property, and a duration time. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: DeccelAmplitude() {} virtual ~DeccelAmplitude()
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Protected Attributes

float _rate
ActionInterval_other
local _other
- Protected Attributes inherited from ActionInterval
float _elapsed
var _elapsed
local _elapsed
bool _firstTick
var _firstTick
local _firstTick
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Member Function Documentation

virtual DeccelAmplitude* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

static DeccelAmplitude* create ( Action action,
float  duration 
)
static

Creates the action with an inner action that has the amplitude property, and a duration time.

Parameters
actionA pointer of the inner action.
durationSpecify the duration of the DeccelAmplitude action.
Returns
Return a pointer of DeccelAmplitude. When the creation failed, return nil.
local create ( local  action,
local  duration 
)
static

Creates the action with an inner action that has the amplitude property, and a duration time.

Parameters
actionA pointer of the inner action.
durationSpecify the duration of the DeccelAmplitude action.
Returns
Return a pointer of DeccelAmplitude. When the creation failed, return nil.
float getRate ( ) const
inline

Get the value of amplitude rate.

Returns
The value of amplitude rate.
local getRate ( )
inline

Get the value of amplitude rate.

Returns
The value of amplitude rate.
bool initWithAction ( Action action,
float  duration 
)

Initializes the action with an inner action that has the amplitude property, and a duration time.

Parameters
actionThe pointer of inner action.
durationThe duration of the DeccelAmplitude action.
Returns
If the initilization sucess, return true; otherwise, return false.
local initWithAction ( local  action,
local  duration 
)

Initializes the action with an inner action that has the amplitude property, and a duration time.

Parameters
actionThe pointer of inner action.
durationThe duration of the DeccelAmplitude action.
Returns
If the initilization sucess, return true; otherwise, return false.
virtual DeccelAmplitude* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

local reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

void setRate ( float  rate)
inline

Set the value of amplitude rate.

Parameters
rateSpecify the value.
local setRate ( local  rate)
inline

Set the value of amplitude rate.

Parameters
rateSpecify the value.
virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

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
timeA value between 0 and 1.

Reimplemented from Action.

local update ( local  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
timeA value between 0 and 1.

Reimplemented from Action.

Member Data Documentation

local __pad0__
ActionInterval* _other
protected
local _other
protected
float _rate
protected
local _rate
protected

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