ActionFloat Class Reference

Action used to animate any value in range [from,to] over specified time interval. More...

Inherits ActionInterval.

Public Types
typedef std::function< void(float value)>	ActionFloatCallback
	Callback function used to report back result.

Public Member Functions
void	startWithTarget (Node *target) override
	Overridden ActionInterval methods.
void	update (float delta) override
	Called once per frame. More...
ActionFloat *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
ActionFloat *	clone () const override
	Returns a clone of action. 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
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
virtual void	stop ()
	Called after the action has finished. More...
Node *	getTarget () const
	Return certain target. More...
void	setTarget (Node *target)
	The action will modify the target properties. More...
Node *	getOriginalTarget () 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...
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
virtual	~Clonable ()
	@js NA @lua NA

Static Public Member Functions
static ActionFloat *	create (float duration, float from, float to, ActionFloatCallback callback)
	Creates FloatAction with specified duration, from value, to value and callback to report back results. More...

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.
Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action

Detailed Description

Action used to animate any value in range [from,to] over specified time interval.

Member Function Documentation

create()

static ActionFloat* create ( float  duration, float  from, float  to, ActionFloatCallback  callback  )

static

Creates FloatAction with specified duration, from value, to value and callback to report back results.

Parameters

duration	of the action
from	value to start from
to	value to be at the end of the action
callback	to report back result

Returns

An autoreleased ActionFloat object

update()

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.

reverse()

ActionFloat* reverse ( ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns

A new action that performs the exact reverse of the action. @js NA

Reimplemented from ActionInterval.

clone()

ActionFloat* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from ActionInterval.

---

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

• CCActionInterval.h