cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
FadeTo Class Reference

Fades an object that implements the RGBAProtocol protocol. More...

#include <CCActionInterval.h>

Inheritance diagram for FadeTo:
ActionInterval FiniteTimeAction Action Ref Clonable FadeIn FadeOut

Public Member Functions

virtual FadeToclone () const override
 Returns a clone of action. More...
 
var clone ()
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
virtual FadeToreverse (void) const override
 Returns a new action that performs the exactly the reverse action. More...
 
local reverse ()
 Returns a new action that performs the exactly the reverse 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 update (float time) override
- 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...
 
local getAmplitudeRate ()
 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
virtual std::string description () const
virtual void stop ()
 Called after the action has finished. More...
 
NodegetTarget () 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...
 
NodegetOriginalTarget () 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...
 
virtual ~Action ()
var ~Action ()
local ~Action ()
- Public Member Functions inherited from Ref
void 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...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static FadeTocreate (float duration, GLubyte opacity)
 Creates an action with duration and opacity. More...
 
local create ( local duration, local opacity)
 Creates an action with duration and opacity. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: FadeTo() {} virtual ~FadeTo() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS GLubyte opacity
var opacity
local opacity
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Protected Attributes

GLubyte _toOpacity
var _toOpacity
local _toOpacity
GLubyte _fromOpacity
var _fromOpacity
local _fromOpacity
- Protected Attributes inherited from ActionInterval
float _elapsed
var _elapsed
local _elapsed
bool _firstTick
var _firstTick
local _firstTick
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Friends

class FadeOut
class FadeIn

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

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

virtual FadeTo* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

static FadeTo* create ( float  duration,
GLubyte  opacity 
)
static

Creates an action with duration and opacity.

Parameters
durationDuration time, in seconds.
opacityA certain opacity, the range is from 0 to 255.
Returns
An autoreleased FadeTo object.
var create ( var  duration,
var  opacity 
)
static

Creates an action with duration and opacity.

Parameters
durationDuration time, in seconds.
opacityA certain opacity, the range is from 0 to 255.
Returns
An autoreleased FadeTo object.
local create ( local  duration,
local  opacity 
)
static

Creates an action with duration and opacity.

Parameters
durationDuration time, in seconds.
opacityA certain opacity, the range is from 0 to 255.
Returns
An autoreleased FadeTo object.
virtual FadeTo* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

var reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

local reverse (   )
overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns
A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

var update ( var  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

local update ( local  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

Friends And Related Function Documentation

friend class FadeIn
friend
var FadeIn
friend
local FadeIn
friend
friend class FadeOut
friend
var FadeOut
friend
local FadeOut
friend

Member Data Documentation

var __pad0__
local __pad0__
GLubyte _fromOpacity
protected
var _fromOpacity
protected
local _fromOpacity
protected
GLubyte _toOpacity
protected
var _toOpacity
protected
local _toOpacity
protected
CC_CONSTRUCTOR_ACCESS GLubyte
opacity
var opacity
local opacity

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