Cocos2d-x  v4
EaseElastic Class Reference

Ease Elastic abstract class. More...

Inherits ActionEase.

Inherited by EaseElasticIn, EaseElasticInOut, and EaseElasticOut.

Public Member Functions

float getPeriod () const
 Get period of the wave in radians. More...
 
void setPeriod (float fPeriod)
 Set period of the wave in radians. More...
 
- Public Member Functions inherited from ActionEase
virtual ActionIntervalgetInnerAction ()
 Get the pointer of the inner action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void stop () override
 Called after the action has finished. More...
 
virtual void update (float time) override
 Called once per frame. 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
 
virtual ActionIntervalreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual ActionIntervalclone () const override
 Returns a clone of action. More...
 
- 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
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () 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...
 
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 ()
 @js NA @lua NA
 

Protected Member Functions

bool initWithAction (ActionInterval *action, float period=0.3f)
 Initializes the action with the inner action and the period in radians. More...
 
- Protected Member Functions inherited from ActionEase
bool initWithAction (ActionInterval *action)
 Initializes the action. 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

Ease Elastic abstract class.

Since
v0.8.2

Member Function Documentation

◆ getPeriod()

float getPeriod ( ) const
inline

Get period of the wave in radians.

Default value is 0.3.

Returns
Return the period of the wave in radians.

◆ setPeriod()

void setPeriod ( float  fPeriod)
inline

Set period of the wave in radians.

Parameters
fPeriodThe value will be set.

◆ initWithAction()

bool initWithAction ( ActionInterval action,
float  period = 0.3f 
)
protected

Initializes the action with the inner action and the period in radians.

Parameters
actionThe pointer of the inner action.
periodPeriod of the wave in radians. Default is 0.3.
Returns
Return true when the initialization success, otherwise return false.

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