Ease Elastic abstract class. More...

Inherited by EaseElasticIn, EaseElasticInOut, and EaseElasticOut.

Public Member Functions
float	getPeriod () const
	Get period of the wave in radians. More...

var	getPeriod ()
	Get period of the wave in radians. More...

local	getPeriod ()
	Get period of the wave in radians. More...

void	setPeriod (float fPeriod)
	Set period of the wave in radians. More...

var	setPeriod ( var fPeriod)
	Set period of the wave in radians. More...

local	setPeriod ( local fPeriod)
	Set period of the wave in radians. More...

virtual EaseElastic *	clone () const override
	Returns a clone of action. More...

local	clone ()
	Returns a clone of action. More...

virtual EaseElastic *	reverse () const override
	Returns a new action that performs the exactly the reverse action. More...

Public Member Functions inherited from ActionEase
virtual ActionInterval *	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...

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...

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
Node *	getTarget () 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...

Node *	getOriginalTarget () 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...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	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
Ref *	copy () const
	Returns a copy of the Ref. More...

Protected Member Functions
bool	initWithAction (ActionInterval *action, float period=0.3f)
	Initializes the action with the inner action and the period in radians. More...

local	initWithAction ( local action, local 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...

var	initWithAction ( var action)
	Initializes the action. More...

local	initWithAction ( local action)
	Initializes the action. More...

Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

var	initWithDuration ( var d)
	initializes the action

local	initWithDuration ( local 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

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

Ease Elastic abstract class.

Since: v0.8.2

Member Function Documentation

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.

var getPeriod ( )

inline

Get period of the wave in radians.

Default value is 0.3.

Returns: Return the period of the wave in radians.

local getPeriod ( )

inline

Get period of the wave in radians.

Default value is 0.3.

Returns: Return the period of the wave in radians.

void setPeriod ( float fPeriod )

inline

Set period of the wave in radians.

Parameters

fPeriod The value will be set.

var setPeriod ( var fPeriod )

inline

Set period of the wave in radians.

Parameters

fPeriod The value will be set.

local setPeriod ( local fPeriod )

inline

Set period of the wave in radians.

Parameters

fPeriod The value will be set.

virtual EaseElastic* clone ( ) const

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

var clone ( )

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

local clone ( )

inlineoverridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionEase.

Reimplemented in EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

virtual EaseElastic* 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 EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

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 EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

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 EaseElasticInOut, EaseElasticOut, and EaseElasticIn.

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

protected

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

Parameters

action	The pointer of the inner action.
period	Period of the wave in radians. Default is 0.3.

Returns: Return true when the initialization success, otherwise return false.

var initWithAction	(	var	action,
		var	period = `0.3f`
	)

protected

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

Parameters

action	The pointer of the inner action.
period	Period of the wave in radians. Default is 0.3.

Returns: Return true when the initialization success, otherwise return false.

local initWithAction	(	local	action,
		local	period = `0.3f`
	)

protected

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

Parameters

action	The pointer of the inner action.
period	Period 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:

CCActionEase.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation