Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
EaseRateAction Class Reference

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

Inherits ActionEase.

Inherited by EaseIn, EaseInOut, and EaseOut.

Public Member Functions

void setRate (float rate)
 Set the rate value for the ease rate action. More...
 
var setRate ( var rate)
 Set the rate value for the ease rate action. More...
 
local setRate ( local rate)
 Set the rate value for the ease rate action. More...
 
float getRate () const
 Get the rate value of the ease rate action. More...
 
var getRate ()
 Get the rate value of the ease rate action. More...
 
local getRate ()
 Get the rate value of the ease rate action. More...
 
virtual EaseRateActionclone () const override
 override Action.
 
local clone ()
 override Action.
 
virtual EaseRateActionreverse () const override
 override Action.
 
- 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...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void stop () override
 Called after the action that has finished. More...
 
var stop ()
 Called after the action that has finished. More...
 
local stop ()
 Called after the action that has finished. More...
 
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 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
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 EaseRateActioncreate (ActionInterval *action, float rate)
 Creates the action with the inner action and the rate parameter. More...
 
local create ( local action, local rate)
 Creates the action with the inner action and the rate parameter. More...
 

Protected Member Functions

bool initWithAction (ActionInterval *pAction, float fRate)
 Initializes the action with the inner action and the rate parameter. More...
 
var initWithAction ( var pAction, var fRate)
 Initializes the action with the inner action and the rate parameter. More...
 
- Protected Member Functions inherited from ActionEase
bool initWithAction (ActionInterval *action)
 Initializes the action with the inner action. More...
 
var initWithAction ( var action)
 Initializes the action with the inner action. More...
 
local initWithAction ( local action)
 Initializes the action with the inner action. 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...
 

Additional Inherited Members

- 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

Base class for Easing actions with rate parameters.

Ease the inner action with specified rate.

Member Function Documentation

static EaseRateAction* create ( ActionInterval action,
float  rate 
)
static

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

A given ActionInterval A given rate An autoreleased EaseRateAction object.

var create ( var  action,
var  rate 
)
static

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

A given ActionInterval A given rate An autoreleased EaseRateAction object.

local create ( local  action,
local  rate 
)
static

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

A given ActionInterval A given rate An autoreleased EaseRateAction object.

void setRate ( float  rate)
inline

Set the rate value for the ease rate action.

The rate value.

var setRate ( var  rate)
inline

Set the rate value for the ease rate action.

The rate value.

local setRate ( local  rate)
inline

Set the rate value for the ease rate action.

The rate value.

float getRate ( ) const
inline

Get the rate value of the ease rate action.

Return the rate value of the ease rate action.

var getRate ( )
inline

Get the rate value of the ease rate action.

Return the rate value of the ease rate action.

local getRate ( )
inline

Get the rate value of the ease rate action.

Return the rate value of the ease rate action.

bool initWithAction ( ActionInterval pAction,
float  fRate 
)
protected

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

The pointer of the inner action. The value of the rate parameter. Return true when the initialization success, otherwise return false.

var initWithAction ( var  pAction,
var  fRate 
)
protected

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

The pointer of the inner action. The value of the rate parameter. Return true when the initialization success, otherwise return false.

local initWithAction ( local  pAction,
local  fRate 
)
protected

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

The pointer of the inner action. The value of the rate parameter. Return true when the initialization success, otherwise return false.


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