cocos2d-x  3.3
 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...
 
virtual ~OrbitCamera ()
 NA NA More...
 
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...
 
- Public Member Functions inherited from ActionCamera
 ActionCamera ()
 ctor More...
 
virtual ~ActionCamera ()
 NA NA More...
 
virtual ActionCamerareverse () const override
 returns a new action that performs the exactly the reverse action More...
 
void setEye (const Vec3 &eye)
 
void setEye (float x, float y, float z)
 
const Vec3getEye () const
 
void setCenter (const Vec3 &center)
 
const Vec3getCenter () const
 
void setUp (const Vec3 &up)
 
const Vec3getUp () 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...
 
- 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
 NA NA More...
 
virtual void stop ()
 called after the action has finished. More...
 
NodegetTarget () const
 
void setTarget (Node *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...
 
int getTag () const
 
void setTag (int tag)
 
virtual ~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 ()
 NA NA More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
 NA NA More...
 
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...
 

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
 
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
 

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
Vec3 _center
 
Vec3 _eye
 
Vec3 _up
 
- Protected Attributes inherited from ActionInterval
float _elapsed
 
bool _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...
 

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from ActionCamera
void restore ()
 
void updateTransform ()
 
- Protected Member Functions inherited from Ref
 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

NA NA

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 
)

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: