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

Rotates a Node object clockwise a number of degrees by modifying it's rotation attribute. More...

#include <CCActionInterval.h>

Inheritance diagram for RotateBy:
ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual RotateByclone () const override
 returns a clone of action More...
 
virtual RotateByreverse (void) 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. It will also set the target. More...
 
virtual void update (float time) override
 called once per frame. More...
 
virtual ~RotateBy ()
bool initWithDuration (float duration, float deltaAngle)
 initializes the action More...
 
bool initWithDuration (float duration, float deltaAngleZ_X, float deltaAngleZ_Y)
bool initWithDuration (float duration, const Vec3 &deltaAngle3D)
- 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)
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...
 
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 ()
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)
- 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 ()
- 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 RotateBycreate (float duration, float deltaAngle)
 creates the action More...
 
static RotateBycreate (float duration, float deltaAngleZ_X, float deltaAngleZ_Y)
static RotateBycreate (float duration, const Vec3 &deltaAngle3D)

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: RotateBy()
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
local __pad0__: bool initWithDuration(float d)

Protected Attributes

float _angleZ_X
float _startAngleZ_X
float _angleZ_Y
float _startAngleZ_Y
bool _is3D
Vec3 _angle3D
Vec3 _startAngle3D
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
var _firstTick
local _firstTick
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
var _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
var _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...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

Rotates a Node object clockwise a number of degrees by modifying it's rotation attribute.

Constructor & Destructor Documentation

virtual ~RotateBy ( )
inlinevirtual

Member Function Documentation

virtual RotateBy* clone ( ) const
overridevirtual

returns a clone of action

Implements ActionInterval.

static RotateBy* create ( float  duration,
float  deltaAngle 
)
static

creates the action

static RotateBy* create ( float  duration,
float  deltaAngleZ_X,
float  deltaAngleZ_Y 
)
static
Warning
The physics body contained in Node doesn't support rotate with different x and y angle.
static RotateBy* create ( float  duration,
const Vec3 deltaAngle3D 
)
static
bool initWithDuration ( float  duration,
float  deltaAngle 
)

initializes the action

bool initWithDuration ( float  duration,
float  deltaAngleZ_X,
float  deltaAngleZ_Y 
)
Warning
The physics body contained in Node doesn't support rotate with different x and y angle.
bool initWithDuration ( float  duration,
const Vec3 deltaAngle3D 
)
virtual RotateBy* reverse ( void  ) const
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInterval.

virtual void startWithTarget ( Node target)
overridevirtual

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

Reimplemented from ActionInterval.

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.

Member Data Documentation

Vec3 _angle3D
protected
float _angleZ_X
protected
float _angleZ_Y
protected
bool _is3D
protected
Vec3 _startAngle3D
protected
float _startAngleZ_X
protected
float _startAngleZ_Y
protected

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