Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
RotateTo Class Reference

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

Inherits ActionInterval.

Public Member Functions

virtual RotateToclone () const override
 Returns a clone of action. More...
 
virtual RotateToreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 Returns a new action that performs the exact reverse of the 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
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 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 amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
var getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var 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...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
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
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 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...
 
local setOriginalTarget ( local 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...
 
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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Changes the flag field that is used to group the actions easily. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from 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...
 

Protected Member Functions

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...
 
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...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 
var initWithDuration ( var d)
 initializes the action
 
local initWithDuration ( local d)
 initializes the action
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
- 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

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

The direction will be decided by the shortest angle.

Member Function Documentation

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

virtual RotateTo* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action.

Reimplemented from ActionInterval.

var reverse (   )
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action.

Reimplemented from ActionInterval.

local reverse (   )
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the 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
timeIn seconds.

Reimplemented from Action.

var update ( var  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

local update ( local  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

bool initWithDuration ( float  duration,
float  dstAngleX,
float  dstAngleY 
)
protected

initializes the action

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

initializes the action

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

initializes the action

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

initializes the action

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

initializes the action

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

initializes the action

Parameters
durationin seconds
void calculateAngles ( float &  startAngle,
float &  diffAngle,
float  dstAngle 
)
protected

calculates the start and diff angles

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

calculates the start and diff angles

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

calculates the start and diff angles

Parameters
dstAnglein degreesCW

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