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

Toggles the visibility of a node. More...

#include <CCActionInstant.h>

Inheritance diagram for ToggleVisibility:
ActionInstant FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual void update (float time) override
 called once per frame. More...
 
virtual ToggleVisibilityreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
virtual ToggleVisibilityclone () const override
 returns a clone of action More...
 
- Public Member Functions inherited from ActionInstant
virtual bool isDone () 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 startWithTarget (Node *target)
 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 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
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
local 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
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...
 
local 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 ToggleVisibilitycreate ()
 Allocates and initializes the action. More...
 

Protected Member Functions

 ToggleVisibility ()
virtual ~ToggleVisibility ()

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 FiniteTimeAction
float _duration
 duration in seconds More...
 

Detailed Description

Toggles the visibility of a node.

Constructor & Destructor Documentation

ToggleVisibility ( )
inlineprotected
virtual ~ToggleVisibility ( )
inlineprotectedvirtual

Member Function Documentation

virtual ToggleVisibility* clone ( ) const
overridevirtual

returns a clone of action

Implements ActionInstant.

static ToggleVisibility* create ( )
static

Allocates and initializes the action.

virtual ToggleVisibility* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInstant.

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 ActionInstant.


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