ActionEase Class Reference

Base class for Easing actions. More...

Inherits ActionInterval.

Inherited by EaseBackIn, EaseBackInOut, EaseBackOut, EaseBezierAction, EaseBounce, EaseBounceIn, EaseBounceInOut, EaseBounceOut, EaseCircleActionIn, EaseCircleActionInOut, EaseCircleActionOut, EaseCubicActionIn, EaseCubicActionInOut, EaseCubicActionOut, EaseElastic, EaseExponentialIn, EaseExponentialInOut, EaseExponentialOut, EaseQuadraticActionIn, EaseQuadraticActionInOut, EaseQuadraticActionOut, EaseQuarticActionIn, EaseQuarticActionInOut, EaseQuarticActionOut, EaseQuinticActionIn, EaseQuinticActionInOut, EaseQuinticActionOut, EaseRateAction, EaseSineIn, EaseSineInOut, and EaseSineOut.

Public Member Functions
virtual ActionInterval *	getInnerAction ()
	Get the pointer of the inner action.
virtual void	startWithTarget (Node *target) override
	Called before the action start.
virtual void	stop () override
	Called after the action has finished.
virtual void	update (float time) override
	Called once per frame.
Public Member Functions inherited from ActionInterval
float	getElapsed ()
	How many seconds had elapsed since the actions started to run.
void	setAmplitudeRate (float amp)
	Sets the amplitude rate, extension in GridAction.
float	getAmplitudeRate ()
	Gets the amplitude rate, extension in GridAction.
virtual bool	isDone () const override
	Return true if the action has finished.
virtual void	step (float dt) override
virtual ActionInterval *	reverse () const override
	Returns a new action that performs the exact reverse of the action.
virtual ActionInterval *	clone () const override
	Returns a clone of action.
Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action.
void	setDuration (float duration)
	Set duration in seconds of the action.
Public Member Functions inherited from Action
virtual std::string	description () const
	NA NA
Node *	getTarget () const
	Return certain target.
void	setTarget (Node *target)
	The action will modify the target properties.
Node *	getOriginalTarget () const
	Return a original Target.
void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil.
int	getTag () const
	Returns a tag that is used to identify the action easily.
void	setTag (int tag)
	Changes the tag that is used to identify the action easily.
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily.
void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily.
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Ref *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count.
virtual	~Ref ()
	Destructor.
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	NA NA

Protected Member Functions
bool	initWithAction (ActionInterval *action)
	Initializes the action.
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

Base class for Easing actions.

Ease actions are created from other interval actions. The ease action will change the timeline of the inner action.

Member Function Documentation

virtual ActionInterval* getInnerAction ( )

virtual

Get the pointer of the inner action.

Returns

The pointer of the inner action.

virtual void startWithTarget ( Node *  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from ActionInterval.

virtual void stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

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

time	A value between 0 and 1.

Reimplemented from Action.

Reimplemented in EaseBezierAction, EaseElasticInOut, EaseElasticOut, EaseElasticIn, EaseInOut, EaseOut, EaseIn, EaseCubicActionInOut, EaseCubicActionOut, EaseCubicActionIn, EaseCircleActionInOut, EaseCircleActionOut, EaseCircleActionIn, EaseQuinticActionInOut, EaseQuinticActionOut, EaseQuinticActionIn, EaseQuarticActionInOut, EaseQuarticActionOut, EaseQuarticActionIn, EaseQuadraticActionInOut, EaseQuadraticActionOut, EaseQuadraticActionIn, EaseBackInOut, EaseBackOut, EaseBackIn, EaseBounceInOut, EaseBounceOut, EaseBounceIn, EaseSineInOut, EaseSineOut, EaseSineIn, EaseExponentialInOut, EaseExponentialOut, and EaseExponentialIn.

bool initWithAction ( ActionInterval *  action )

protected

Initializes the action.

Returns

Return true when the initialization success, otherwise return false.

---

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

• CCActionEase.h