FadeTo Class Reference

Fades an object that implements the RGBAProtocol protocol. It modifies the opacity from the current value to a custom one. More...

Inherits ActionInterval.

Inherited by FadeIn, and FadeOut.

Public Member Functions
virtual FadeTo *	clone () const override
	Returns a clone of action. More...
virtual FadeTo *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...
virtual void	update (float time) override
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 FadeTo *	create (float duration, uint8_t opacity)
	Creates an action with duration and opacity. More...

Protected Member Functions
bool	initWithDuration (float duration, uint8_t opacity)
	initializes the action with duration and opacity More...
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

Fades an object that implements the RGBAProtocol protocol. It modifies the opacity from the current value to a custom one.

Warning

This action doesn't support "reverse"

Member Function Documentation

create()

static FadeTo* create ( float  duration, uint8_t  opacity  )

static

Creates an action with duration and opacity.

Parameters

duration	Duration time, in seconds.
opacity	A certain opacity, the range is from 0 to 255.

Returns

An autoreleased FadeTo object.

clone()

virtual FadeTo* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

reverse()

virtual FadeTo* 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.

Reimplemented in FadeOut, and FadeIn.

startWithTarget()

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.

Reimplemented in FadeOut, and FadeIn.

update()

virtual void update ( float  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from Action.

initWithDuration()

bool initWithDuration ( float  duration, uint8_t  opacity  )

protected

initializes the action with duration and opacity

Parameters

duration

in seconds

---

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

• CCActionInterval.h