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

Changes the speed of an action, making it take longer (speed>1) or less (speed<1) time. More...

#include <CCAction.h>

Inheritance diagram for Speed:
Action Ref Clonable

Public Member Functions

float getSpeed (void) const
void setSpeed (float speed)
 alter the speed of the inner function in runtime More...
 
local setSpeed ( local speed)
 alter the speed of the inner function in runtime More...
 
void setInnerAction (ActionInterval *action)
local setInnerAction ( local action)
ActionIntervalgetInnerAction () const
local getInnerAction ()
virtual Speedclone () const override
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
virtual Speedreverse () 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 stop () override
 called after the action has finished. More...
 
local stop ()
 called after 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...
 
virtual bool isDone () const override
 return true if the action has finished More...
 
local isDone ()
 return true if the action has finished More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual void update (float time)
 called once per frame. More...
 
local update ( local time)
 called once per frame. 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
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 Speedcreate (ActionInterval *action, float speed)
 create the action More...
 

Protected Member Functions

 Speed ()
 Speed ()
virtual ~Speed (void)
local ~Speed ()
bool initWithAction (ActionInterval *action, float speed)
 initializes the action More...
 
local initWithAction ( local action, local speed)
 initializes the action More...
 
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

float _speed
local _speed
ActionInterval_innerAction
local _innerAction
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references 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...
 

Detailed Description

Changes the speed of an action, making it take longer (speed>1) or less (speed<1) time.

Useful to simulate 'slow motion' or 'fast forward' effect.

Warning
This action can't be Sequenceable because it is not an IntervalAction

Constructor & Destructor Documentation

Speed ( )
protected
local Speed ( )
protected
virtual ~Speed ( void  )
protectedvirtual
local ~Speed (   )
protectedvirtual

Member Function Documentation

virtual Speed* clone ( ) const
overridevirtual

returns a clone of action

Implements Action.

local clone ( )
overridevirtual

returns a clone of action

Implements Action.

static Speed* create ( ActionInterval action,
float  speed 
)
static

create the action

local create ( local  action,
local  speed 
)
static

create the action

ActionInterval* getInnerAction ( ) const
inline
local getInnerAction ( )
inline
float getSpeed ( void  ) const
inline
local getSpeed (   )
inline
bool initWithAction ( ActionInterval action,
float  speed 
)
protected

initializes the action

local initWithAction ( local  action,
local  speed 
)
protected

initializes the action

virtual bool isDone ( ) const
overridevirtual

return true if the action has finished

Reimplemented from Action.

local isDone ( )
overridevirtual

return true if the action has finished

Reimplemented from Action.

virtual Speed* reverse ( ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements Action.

local reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Implements Action.

void setInnerAction ( ActionInterval action)
local setInnerAction ( local  action)
void setSpeed ( float  speed)
inline

alter the speed of the inner function in runtime

local setSpeed ( local  speed)
inline

alter the speed of the inner function in runtime

virtual void startWithTarget ( Node target)
overridevirtual

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

Reimplemented from Action.

local startWithTarget ( local  target)
overridevirtual

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

Reimplemented from Action.

virtual void step ( float  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

local step ( local  dt)
overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

Reimplemented from Action.

virtual void stop ( )
overridevirtual

called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "[action stop]" manually. Instead, use: "target->stopAction(action);"

Reimplemented from Action.

local stop ( )
overridevirtual

called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "[action stop]" manually. Instead, use: "target->stopAction(action);"

Reimplemented from Action.

Member Data Documentation

ActionInterval* _innerAction
protected
local _innerAction
protected
float _speed
protected
local _speed
protected

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