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

Rotates a Node object to a certain angle by modifying it's rotation attribute. More...

#include <CCActionInterval.h>

Inheritance diagram for RotateTo:
ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual RotateToclone () const override
 Returns a clone of action. More...
 
virtual RotateToreverse () 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. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void update (float time) override
virtual ~RotateTo ()
local ~RotateTo ()
bool initWithDuration (float duration, float dstAngleX, float dstAngleY)
 initializes the action More...
 
var initWithDuration ( var duration, var dstAngleX, var dstAngleY)
 initializes the action More...
 
local initWithDuration ( local duration, local dstAngleX, local dstAngleY)
 initializes the action More...
 
bool initWithDuration (float duration, const Vec3 &dstAngle3D)
 initializes the action More...
 
var initWithDuration ( var duration, var dstAngle3D)
 initializes the action More...
 
local initWithDuration ( local duration, local dstAngle3D)
 initializes the action More...
 
void calculateAngles (float &startAngle, float &diffAngle, float dstAngle)
 calculates the start and diff angles More...
 
local calculateAngles ( local startAngle, local diffAngle, local dstAngle)
 calculates the start and diff angles 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)
 Sets the ampliture rate, extension in GridAction. More...
 
local setAmplitudeRate ( local amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the ampliture rate, extension in GridAction. More...
 
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
local isDone ()
 Return true if the action has finished. More...
 
virtual void step (float dt) override
- 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...
 
NodegetTarget () const
 Return certain target. More...
 
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
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 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...
 
var getTag ()
 Returns a tag that is used to identify the action easily. More...
 
local getTag ()
 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...
 
var setTag ( var tag)
 Changes the tag that is used to identify the action easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the action easily. More...
 
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...
 
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 RotateTocreate (float duration, float dstAngleX, float dstAngleY)
 Creates the action with separate rotation angles. More...
 
var create ( var duration, var dstAngleX, var dstAngleY)
 Creates the action with separate rotation angles. More...
 
local create ( local duration, local dstAngleX, local dstAngleY)
 Creates the action with separate rotation angles. More...
 
static RotateTocreate (float duration, float dstAngle)
 Creates the action. More...
 
var create ( var duration, var dstAngle)
 Creates the action. More...
 
static RotateTocreate (float duration, const Vec3 &dstAngle3D)
 Creates the action with 3D rotation angles. More...
 
local create ( local duration, local dstAngle3D)
 Creates the action with 3D rotation angles. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: RotateTo()
local __pad0__: RotateTo()
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __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

bool _is3D
local _is3D
Vec3 _dstAngle
var _dstAngle
local _dstAngle
Vec3 _startAngle
var _startAngle
local _startAngle
Vec3 _diffAngle
var _diffAngle
local _diffAngle
- 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...
 

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

Rotates a Node object to a certain angle by modifying it's rotation attribute.

The direction will be decided by the shortest angle.

Constructor & Destructor Documentation

virtual ~RotateTo ( )
inlinevirtual
var ~RotateTo ( )
inlinevirtual
local ~RotateTo ( )
inlinevirtual

Member Function Documentation

void calculateAngles ( float &  startAngle,
float &  diffAngle,
float  dstAngle 
)

calculates the start and diff angles

Parameters
dstAnglein degreesCW
var calculateAngles ( var  startAngle,
var  diffAngle,
var  dstAngle 
)

calculates the start and diff angles

Parameters
dstAnglein degreesCW
local calculateAngles ( local  startAngle,
local  diffAngle,
local  dstAngle 
)

calculates the start and diff angles

Parameters
dstAnglein degreesCW
virtual RotateTo* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

static RotateTo* create ( float  duration,
float  dstAngleX,
float  dstAngleY 
)
static

Creates the action with separate rotation angles.

Parameters
durationDuration time, in seconds.
dstAngleXIn degreesCW.
dstAngleYIn degreesCW.
Returns
An autoreleased RotateTo object.
var create ( var  duration,
var  dstAngleX,
var  dstAngleY 
)
static

Creates the action with separate rotation angles.

Parameters
durationDuration time, in seconds.
dstAngleXIn degreesCW.
dstAngleYIn degreesCW.
Returns
An autoreleased RotateTo object.
local create ( local  duration,
local  dstAngleX,
local  dstAngleY 
)
static

Creates the action with separate rotation angles.

Parameters
durationDuration time, in seconds.
dstAngleXIn degreesCW.
dstAngleYIn degreesCW.
Returns
An autoreleased RotateTo object.
static RotateTo* create ( float  duration,
float  dstAngle 
)
static

Creates the action.

Parameters
durationDuration time, in seconds.
dstAngleIn degreesCW.
Returns
An autoreleased RotateTo object.
var create ( var  duration,
var  dstAngle 
)
static

Creates the action.

Parameters
durationDuration time, in seconds.
dstAngleIn degreesCW.
Returns
An autoreleased RotateTo object.
local create ( local  duration,
local  dstAngle 
)
static

Creates the action.

Parameters
durationDuration time, in seconds.
dstAngleIn degreesCW.
Returns
An autoreleased RotateTo object.
static RotateTo* create ( float  duration,
const Vec3 dstAngle3D 
)
static

Creates the action with 3D rotation angles.

Parameters
durationDuration time, in seconds.
dstAngle3DA Vec3 angle.
Returns
An autoreleased RotateTo object.
var create ( var  duration,
var  dstAngle3D 
)
static

Creates the action with 3D rotation angles.

Parameters
durationDuration time, in seconds.
dstAngle3DA Vec3 angle.
Returns
An autoreleased RotateTo object.
local create ( local  duration,
local  dstAngle3D 
)
static

Creates the action with 3D rotation angles.

Parameters
durationDuration time, in seconds.
dstAngle3DA Vec3 angle.
Returns
An autoreleased RotateTo object.
bool initWithDuration ( float  duration,
float  dstAngleX,
float  dstAngleY 
)

initializes the action

Parameters
durationin seconds
dstAngleXin degreesCW
dstAngleYin degreesCW
var initWithDuration ( var  duration,
var  dstAngleX,
var  dstAngleY 
)

initializes the action

Parameters
durationin seconds
dstAngleXin degreesCW
dstAngleYin degreesCW
local initWithDuration ( local  duration,
local  dstAngleX,
local  dstAngleY 
)

initializes the action

Parameters
durationin seconds
dstAngleXin degreesCW
dstAngleYin degreesCW
bool initWithDuration ( float  duration,
const Vec3 dstAngle3D 
)

initializes the action

Parameters
durationin seconds
var initWithDuration ( var  duration,
var  dstAngle3D 
)

initializes the action

Parameters
durationin seconds
local initWithDuration ( local  duration,
local  dstAngle3D 
)

initializes the action

Parameters
durationin seconds
virtual RotateTo* 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 ActionInterval.

var reverse (   )
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 ActionInterval.

local reverse (   )
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 ActionInterval.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

virtual void update ( float  time)
overridevirtual
Parameters
dtIn seconds.

Reimplemented from Action.

var update ( var  time)
overridevirtual
Parameters
dtIn seconds.

Reimplemented from Action.

local update ( local  time)
overridevirtual
Parameters
dtIn seconds.

Reimplemented from Action.

Member Data Documentation

var __pad0__
local __pad0__
Vec3 _diffAngle
protected
var _diffAngle
protected
local _diffAngle
protected
Vec3 _dstAngle
protected
var _dstAngle
protected
local _dstAngle
protected
bool _is3D
protected
var _is3D
protected
local _is3D
protected
Vec3 _startAngle
protected
var _startAngle
protected
local _startAngle
protected

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