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

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

#include <CCActionInterval.h>

Inheritance diagram for FadeOut:
FadeTo ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
var startWithTarget ( var target)
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
virtual FadeOutclone () const override
 returns a clone of action More...
 
var 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...
 
void setReverseAction (FadeTo *ac)
- Public Member Functions inherited from FadeTo
virtual void update (float time) override
 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...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
- 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
virtual void stop ()
 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...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
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
var getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Static Public Member Functions

static FadeOutcreate (float d)
 creates the action More...
 
local create ( local d)
 creates the action More...
 
- Static Public Member Functions inherited from FadeTo
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...
 

Protected Member Functions

 FadeOut ()
virtual ~FadeOut ()
- Protected Member Functions inherited from FadeTo
 FadeTo ()
virtual ~FadeTo ()
local ~FadeTo ()
bool initWithDuration (float duration, GLubyte opacity)
 initializes the action with duration and opacity More...
 
local initWithDuration ( local duration, local opacity)
 initializes the action with duration and opacity More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

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 Attributes inherited from FadeTo
GLubyte _toOpacity
var _toOpacity
local _toOpacity
GLubyte _fromOpacity
var _fromOpacity
local _fromOpacity

Detailed Description

Fades Out an object that implements the RGBAProtocol protocol.

It modifies the opacity from 255 to 0. The "reverse" of this action is FadeIn

Constructor & Destructor Documentation

FadeOut ( )
inlineprotected
var FadeOut ( )
inlineprotected
local FadeOut ( )
inlineprotected
virtual ~FadeOut ( )
inlineprotectedvirtual
var ~FadeOut ( )
inlineprotectedvirtual
local ~FadeOut ( )
inlineprotectedvirtual

Member Function Documentation

virtual FadeOut* clone ( ) const
overridevirtual

returns a clone of action

Reimplemented from FadeTo.

var clone ( )
overridevirtual

returns a clone of action

Reimplemented from FadeTo.

local clone ( )
overridevirtual

returns a clone of action

Reimplemented from FadeTo.

static FadeOut* create ( float  d)
static

creates the action

var create ( var  d)
static

creates the action

local create ( local  d)
static

creates the action

virtual FadeTo* reverse ( void  ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FadeTo.

var reverse (   )
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FadeTo.

local reverse (   )
overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from FadeTo.

void setReverseAction ( FadeTo ac)
var setReverseAction ( var  ac)
local setReverseAction ( local  ac)
virtual void startWithTarget ( Node target)
overridevirtual

called before the action start. It will also set the target.

Reimplemented from FadeTo.

var startWithTarget ( var  target)
overridevirtual

called before the action start. It will also set the target.

Reimplemented from FadeTo.

local startWithTarget ( local  target)
overridevirtual

called before the action start. It will also set the target.

Reimplemented from FadeTo.


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