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

OrbitCamera action Orbits the camera around the center of the screen using spherical coordinates. More...

#include <CCActionCamera.h>

Inheritance diagram for OrbitCamera:
ActionCamera ActionInterval FiniteTimeAction Action Object Clonable

Public Member Functions

 OrbitCamera ()
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...
 
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...
 
virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
virtual void update (float time) override
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
- Public Member Functions inherited from ActionCamera
 ActionCamera ()
virtual ~ActionCamera ()
virtual ActionCamerareverse () const override
 returns a new action that performs the exactly the reverse action More...
 
var reverse ()
 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 kmVec3 &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 kmVec3 & getEye () const
void setCenter (const kmVec3 &center)
local setCenter ( local center)
const kmVec3 & getCenter () const
var getCenter ()
local getCenter ()
void setUp (const kmVec3 &up)
local setUp ( local up)
const kmVec3 & getUp () const
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
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...
 
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...
 
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
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
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
unsigned int getReferenceCount () const
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Objectcopy () const
 returns a copy of the object. More...
 
var copy ()
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. 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...
 

Protected Attributes

float _radius
float _deltaRadius
var _deltaRadius
local _deltaRadius
float _angleZ
float _deltaAngleZ
var _deltaAngleZ
local _deltaAngleZ
float _angleX
float _deltaAngleX
var _deltaAngleX
local _deltaAngleX
float _radZ
float _radDeltaZ
var _radDeltaZ
local _radDeltaZ
float _radX
float _radDeltaX
var _radDeltaX
local _radDeltaX
- Protected Attributes inherited from ActionCamera
kmVec3 _center
local _center
kmVec3 _eye
kmVec3 _up
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Object
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- 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 ()
void updateTransform ()

Detailed Description

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

Constructor & Destructor Documentation

OrbitCamera ( )
inline
var ctor ( )
inline
local OrbitCamera ( )
inline
virtual ~OrbitCamera ( )
inlinevirtual

Member Function Documentation

OrbitCamera* clone ( ) const
overridevirtual

returns a clone of action

Reimplemented from ActionCamera.

var clone ( )
overridevirtual

returns a clone of action

Reimplemented from ActionCamera.

local clone ( )
overridevirtual

returns a clone of 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

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

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

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

var sphericalRadius ( var  r,
var  zenith,
var  azimuth 
)

positions the camera according to spherical coordinates

local sphericalRadius ( local  r,
local  zenith,
local  azimuth 
)

positions the camera according to spherical coordinates

virtual void startWithTarget ( Node target)
overridevirtual

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

Reimplemented from ActionCamera.

var startWithTarget ( var  target)
overridevirtual

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

Reimplemented from ActionCamera.

local startWithTarget ( local  target)
overridevirtual

called before the action start. It will also set the 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

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

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

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: