cocos2d-x  3.3rc0
 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...
 
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. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
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...
 
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)
local setAmplitudeRate ( local amp)
float getAmplitudeRate (void)
local getAmplitudeRate ()
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 return true if the action has finished More...
 
local isDone ()
 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...
 
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...
 
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 ()
local getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
var setOriginalTarget ( var 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)
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...
 
local getReferenceCount ()
 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 FadeTocreate (float duration, GLubyte opacity)
 creates an action with duration and opacity More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: FadeTo() {} virtual ~FadeTo() {} bool initWithDuration(float duration
local __pad0__: FadeTo() {} virtual ~FadeTo() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS GLubyte opacity
local opacity
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
local __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
local _toOpacity
GLubyte _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

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

local clone ( )
overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

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

creates an action with duration and opacity

local create ( local  duration,
local  opacity 
)
static

creates an action with duration and opacity

virtual FadeTo* reverse ( void  ) const
overridevirtual

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

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.

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

local startWithTarget ( local  target)
overridevirtual

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

Reimplemented from ActionInterval.

Reimplemented in FadeOut, and FadeIn.

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

Reimplemented from Action.

local update ( local  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

Reimplemented from Action.

Friends And Related Function Documentation

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

Member Data Documentation

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

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