cocos2d-x  3.0
 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 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...
 
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...
 
- 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...
 
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 ()
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 Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release 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 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...
 

Protected 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...
 
- Protected Member Functions inherited from ActionCamera
void restore ()
void updateTransform ()
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action More...
 
var initWithDuration ( var d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
var ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

float _radius
float _deltaRadius
float _angleZ
float _deltaAngleZ
float _angleX
float _deltaAngleX
float _radZ
float _radDeltaZ
float _radX
float _radDeltaX
- Protected Attributes inherited from ActionCamera
kmVec3 _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 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...
 

Detailed Description

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

Constructor & Destructor Documentation

OrbitCamera ( )
protected
virtual ~OrbitCamera ( )
protectedvirtual

Member Function Documentation

OrbitCamera* clone ( ) const
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

bool initWithDuration ( float  t,
float  radius,
float  deltaRadius,
float  angleZ,
float  deltaAngleZ,
float  angleX,
float  deltaAngleX 
)
protected

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

virtual void startWithTarget ( Node 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.

Member Data Documentation

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

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