cocos2d-x  3.5
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
 Return the speed. More...
 
void setSpeed (float speed)
 Alter the speed of the inner function in runtime. More...
 
void setInnerAction (ActionInterval *action)
 Replace the interior action. More...
 
ActionIntervalgetInnerAction () const
 Return the interior action. More...
 
virtual Speedclone () const override
 Returns a clone of action. More...
 
virtual Speedreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void stop () override
 Called after the action has finished. More...
 
virtual void step (float dt) override
virtual bool isDone () const override
 Return true if the action has finished. More...
 
virtual ~Speed (void)
bool initWithAction (ActionInterval *action, float speed)
 Initializes the action. More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual void update (float time)
 Called once per frame. More...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 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...
 
void setTag (int tag)
 Changes the tag that is used to identify the action easily. More...
 
virtual ~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 Speedcreate (ActionInterval *action, float speed)
 Create the action and set the speed. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Speed()
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Protected Attributes

float _speed
ActionInterval_innerAction
- 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...
 

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. 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

virtual ~Speed ( void  )
virtual

Member Function Documentation

virtual Speed* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

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

Create the action and set the speed.

Parameters
actionAn action.
speedThe action speed.
ActionInterval* getInnerAction ( ) const
inline

Return the interior action.

Returns
The interior action.
float getSpeed ( void  ) const
inline

Return the speed.

Returns
The action speed.
bool initWithAction ( ActionInterval action,
float  speed 
)

Initializes the action.

virtual bool isDone ( ) const
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from Action.

virtual Speed* 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 Action.

void setInnerAction ( ActionInterval action)

Replace the interior action.

Parameters
actionThe new action, it will replace the running action.
void setSpeed ( float  speed)
inline

Alter the speed of the inner function in runtime.

Parameters
speedAlter 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.

Parameters
targetA certain target.

Reimplemented from Action.

virtual void step ( float  dt)
overridevirtual
Parameters
dtin seconds.

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.

Member Data Documentation

ActionInterval* _innerAction
protected
float _speed
protected

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