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

Base class for Easing actions with rate parameters. More...

#include <CCActionEase.h>

Inheritance diagram for EaseRateAction:
ActionEase ActionInterval FiniteTimeAction Action Ref Clonable EaseIn EaseInOut EaseOut

Public Member Functions

void setRate (float rate)
 Set the rate value for the ease rate action. More...
 
float getRate () const
 Get the rate value of the ease rate action. More...
 
virtual EaseRateActionclone () const override
 Returns a clone of action. More...
 
virtual EaseRateActionreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
bool initWithAction (ActionInterval *pAction, float fRate)
 Initializes the action with the inner action and the rate parameter. More...
 
- Public Member Functions inherited from ActionEase
virtual ActionIntervalgetInnerAction ()
 Get the pointer of the inner action. More...
 
local getInnerAction ()
 Get the pointer of the inner action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void stop () override
 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...
 
virtual void update (float time) override
 Called once per frame. More...
 
var update ( var time)
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
bool initWithAction (ActionInterval *action)
 Initializes the action. More...
 
var initWithAction ( var action)
 Initializes the action. More...
 
local initWithAction ( local action)
 Initializes the action. 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
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...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: EaseRateAction() {} virtual ~EaseRateAction()
var __pad0__: EaseRateAction() {} virtual ~EaseRateAction()
local __pad0__: EaseRateAction() {} virtual ~EaseRateAction()
- Public Attributes inherited from ActionEase
CC_CONSTRUCTOR_ACCESS __pad0__: ActionEase() {} virtual ~ActionEase()
- 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
- Protected Attributes inherited from ActionEase
ActionInterval_inner
 The inner action. More...
 
var _inner
 The inner action. More...
 
local _inner
 The inner action. More...
 
- 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

Base class for Easing actions with rate parameters.

Ease the inner action with specified rate.

Member Function Documentation

virtual EaseRateAction* clone ( ) const
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

var clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

local clone ( )
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

float getRate ( ) const
inline

Get the rate value of the ease rate action.

Returns
Return the rate value of the ease rate action.
var getRate ( )
inline

Get the rate value of the ease rate action.

Returns
Return the rate value of the ease rate action.
local getRate ( )
inline

Get the rate value of the ease rate action.

Returns
Return the rate value of the ease rate action.
bool initWithAction ( ActionInterval pAction,
float  fRate 
)

Initializes the action with the inner action and the rate parameter.

Parameters
pActionThe pointer of the inner action.
fRateThe value of the rate parameter.
Returns
Return true when the initialization success, otherwise return false.
var initWithAction ( var  pAction,
var  fRate 
)

Initializes the action with the inner action and the rate parameter.

Parameters
pActionThe pointer of the inner action.
fRateThe value of the rate parameter.
Returns
Return true when the initialization success, otherwise return false.
local initWithAction ( local  pAction,
local  fRate 
)

Initializes the action with the inner action and the rate parameter.

Parameters
pActionThe pointer of the inner action.
fRateThe value of the rate parameter.
Returns
Return true when the initialization success, otherwise return false.
virtual EaseRateAction* reverse ( void  ) const
inlineoverridevirtual

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

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

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

var reverse (   )
inlineoverridevirtual

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

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

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

local reverse (   )
inlineoverridevirtual

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

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

Reimplemented from ActionEase.

Reimplemented in EaseInOut, EaseOut, and EaseIn.

void setRate ( float  rate)
inline

Set the rate value for the ease rate action.

Parameters
rateThe value will be set.
var setRate ( var  rate)
inline

Set the rate value for the ease rate action.

Parameters
rateThe value will be set.
local setRate ( local  rate)
inline

Set the rate value for the ease rate action.

Parameters
rateThe value will be set.

Member Data Documentation

var __pad0__
local __pad0__
float _rate
protected
var _rate
protected
local _rate
protected

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