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

OrbitCamera action. More...

#include <CCActionCamera.h>

Inheritance diagram for OrbitCamera:
ActionCamera ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

void sphericalRadius (float *r, float *zenith, float *azimuth)
 Positions the camera according to spherical coordinates. More...
 
OrbitCameraclone () const override
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of 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
 Called once per frame. More...
 
var update ( var time)
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. More...
 
virtual ~OrbitCamera ()
bool initWithDuration (float t, float radius, float deltaRadius, float angleZ, float deltaAngleZ, float angleX, float deltaAngleX)
 Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 
var initWithDuration ( var t, var radius, var deltaRadius, var angleZ, var deltaAngleZ, var angleX, var deltaAngleX)
 Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 
local initWithDuration ( local t, local radius, local deltaRadius, local angleZ, local deltaAngleZ, local angleX, local deltaAngleX)
 Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 
- Public Member Functions inherited from ActionCamera
 ActionCamera ()
 ctor ()
 ActionCamera ()
virtual ~ActionCamera ()
virtual ActionCamerareverse () 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...
 
void setEye (const Vec3 &eye)
local setEye ( local eye)
void setEye (float x, float y, float z)
var setEye ( var x, var y, var z)
local setEye ( local x, local y, local z)
const Vec3getEye () const
local getEye ()
void setCenter (const Vec3 &center)
local setCenter ( local center)
const Vec3getCenter () const
var getCenter ()
local getCenter ()
void setUp (const Vec3 &up)
local setUp ( local up)
const Vec3getUp () const
local getUp ()
- 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 OrbitCameracreate (float t, float radius, float deltaRadius, float angleZ, float deltaAngleZ, float angleX, float deltaAngleX)
 Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 
var create ( var t, var radius, var deltaRadius, var angleZ, var deltaAngleZ, var angleX, var deltaAngleX)
 Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 
local create ( local t, local radius, local deltaRadius, local angleZ, local deltaAngleZ, local angleX, local deltaAngleX)
 Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: OrbitCamera()
- 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

float _radius
float _deltaRadius
var _deltaRadius
local _deltaRadius
float _angleZ
var _angleZ
local _angleZ
float _deltaAngleZ
var _deltaAngleZ
local _deltaAngleZ
float _angleX
var _angleX
local _angleX
float _deltaAngleX
var _deltaAngleX
local _deltaAngleX
float _radZ
var _radZ
local _radZ
float _radDeltaZ
var _radDeltaZ
local _radDeltaZ
float _radX
var _radX
local _radX
float _radDeltaX
var _radDeltaX
local _radDeltaX
- Protected Attributes inherited from ActionCamera
Vec3 _center
Vec3 _eye
var _eye
local _eye
Vec3 _up
var _up
local _up
- 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 ActionCamera
void restore ()
var restore ()
local restore ()
void updateTransform ()
var updateTransform ()
local updateTransform ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

OrbitCamera action.

Orbits the camera around the center of the screen using spherical coordinates.

Constructor & Destructor Documentation

virtual ~OrbitCamera ( )
virtual

Member Function Documentation

OrbitCamera* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionCamera.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionCamera.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionCamera.

static OrbitCamera* create ( float  t,
float  radius,
float  deltaRadius,
float  angleZ,
float  deltaAngleZ,
float  angleX,
float  deltaAngleX 
)
static

Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

Parameters
tDuration in seconds.
radiusThe start radius.
deltaRadiusThe delta radius.
angelZThe start Angel in Z.
deltaAngleZThe delta angle in Z.
angelXThe start Angel in X.
deltaAngleXThe delta angle in X.
Returns
An OrbitCamera.
var create ( var  t,
var  radius,
var  deltaRadius,
var  angleZ,
var  deltaAngleZ,
var  angleX,
var  deltaAngleX 
)
static

Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

Parameters
tDuration in seconds.
radiusThe start radius.
deltaRadiusThe delta radius.
angelZThe start Angel in Z.
deltaAngleZThe delta angle in Z.
angelXThe start Angel in X.
deltaAngleXThe delta angle in X.
Returns
An OrbitCamera.
local create ( local  t,
local  radius,
local  deltaRadius,
local  angleZ,
local  deltaAngleZ,
local  angleX,
local  deltaAngleX 
)
static

Creates a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

Parameters
tDuration in seconds.
radiusThe start radius.
deltaRadiusThe delta radius.
angelZThe start Angel in Z.
deltaAngleZThe delta angle in Z.
angelXThe start Angel in X.
deltaAngleXThe delta angle in X.
Returns
An OrbitCamera.
bool initWithDuration ( float  t,
float  radius,
float  deltaRadius,
float  angleZ,
float  deltaAngleZ,
float  angleX,
float  deltaAngleX 
)

Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

var initWithDuration ( var  t,
var  radius,
var  deltaRadius,
var  angleZ,
var  deltaAngleZ,
var  angleX,
var  deltaAngleX 
)

Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

local initWithDuration ( local  t,
local  radius,
local  deltaRadius,
local  angleZ,
local  deltaAngleZ,
local  angleX,
local  deltaAngleX 
)

Initializes a OrbitCamera action with radius, delta-radius, z, deltaZ, x, deltaX.

void sphericalRadius ( float *  r,
float *  zenith,
float *  azimuth 
)

Positions the camera according to spherical coordinates.

Parameters
rThe spherical radius.
zenithThe spherical zenith.
azimuthThe spherical azimuth.
var sphericalRadius ( var  r,
var  zenith,
var  azimuth 
)

Positions the camera according to spherical coordinates.

Parameters
rThe spherical radius.
zenithThe spherical zenith.
azimuthThe spherical azimuth.
local sphericalRadius ( local  r,
local  zenith,
local  azimuth 
)

Positions the camera according to spherical coordinates.

Parameters
rThe spherical radius.
zenithThe spherical zenith.
azimuthThe spherical azimuth.
virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionCamera.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionCamera.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionCamera.

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.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

var update ( var  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.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

local update ( local  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.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

Member Data Documentation

float _angleX
protected
var _angleX
protected
local _angleX
protected
float _angleZ
protected
var _angleZ
protected
local _angleZ
protected
float _deltaAngleX
protected
var _deltaAngleX
protected
local _deltaAngleX
protected
float _deltaAngleZ
protected
var _deltaAngleZ
protected
local _deltaAngleZ
protected
float _deltaRadius
protected
var _deltaRadius
protected
local _deltaRadius
protected
float _radDeltaX
protected
var _radDeltaX
protected
local _radDeltaX
protected
float _radDeltaZ
protected
var _radDeltaZ
protected
local _radDeltaZ
protected
float _radius
protected
float _radX
protected
var _radX
protected
local _radX
protected
float _radZ
protected
var _radZ
protected
local _radZ
protected

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