OrbitCamera action. More...

Inherits ActionCamera.

Public Member Functions
void	sphericalRadius (float r, float zenith, float *azimuth)
	Positions the camera according to spherical coordinates. More...

OrbitCamera *	clone () const override
	Returns a clone of action. More...

virtual void	startWithTarget (Node *target) override
	Called before the action start. More...

var	startWithTarget ( var target)
	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...

local	update ( local time)
	Called once per frame. More...

Public Member Functions inherited from ActionCamera
virtual ActionCamera *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...

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

Node *	getTarget () 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...

Node *	getOriginalTarget () 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...

Ref *	autorelease ()
	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
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
static OrbitCamera *	create (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 Member Functions
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...

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

OrbitCamera action.

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

Member Function Documentation

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

t	Duration in seconds.
radius	The start radius.
deltaRadius	The delta radius.
angleZ	The start angle in Z.
deltaAngleZ	The delta angle in Z.
angleX	The start angle in X.
deltaAngleX	The 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

t	Duration in seconds.
radius	The start radius.
deltaRadius	The delta radius.
angleZ	The start angle in Z.
deltaAngleZ	The delta angle in Z.
angleX	The start angle in X.
deltaAngleX	The 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

t	Duration in seconds.
radius	The start radius.
deltaRadius	The delta radius.
angleZ	The start angle in Z.
deltaAngleZ	The delta angle in Z.
angleX	The start angle in X.
deltaAngleX	The delta angle in X.

Returns: An OrbitCamera.

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

Positions the camera according to spherical coordinates.

Parameters

r	The spherical radius.
zenith	The spherical zenith.
azimuth	The spherical azimuth.

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

Positions the camera according to spherical coordinates.

Parameters

r	The spherical radius.
zenith	The spherical zenith.
azimuth	The spherical azimuth.

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

Positions the camera according to spherical coordinates.

Parameters

r	The spherical radius.
zenith	The spherical zenith.
azimuth	The spherical azimuth.

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.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionCamera.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionCamera.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A 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

time	A 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

time	A 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

time	A value between 0 and 1.

Reimplemented from Action.

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.

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

protected

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
	)

protected

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

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

CCActionCamera.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation