Animate3D, Animates a Sprite3D given with an Animation3D. More...

Inherits ActionInterval.

Public Member Functions
virtual void	stop () override
	Called after the action has finished. More...

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

local	startWithTarget ( local target)
	Called before the action start. More...

virtual Animate3D *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...

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

virtual void	update (float t) override
	Called once per frame. More...

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

float	getSpeed () const
	get & set speed, negative speed means playing reverse

var	getSpeed ()
	get & set speed, negative speed means playing reverse

local	getSpeed ()
	get & set speed, negative speed means playing reverse

float	getWeight () const
	get & set blend weight, weight must positive

var	getWeight ()
	get & set blend weight, weight must positive

local	getWeight ()
	get & set blend weight, weight must positive

void	setOriginInterval (float interval)
	get & set origin interval

var	setOriginInterval ( var interval)
	get & set origin interval

local	setOriginInterval ( local interval)
	get & set origin interval

bool	getPlayBack () const
	get & set play reverse, these are deprecated, use set negative speed instead

void	setQuality (Animate3DQuality quality)
	set animate quality

var	setQuality ( var quality)
	set animate quality

local	setQuality ( local quality)
	set animate quality

Animate3DQuality	getQuality () const
	get animate quality

var	getQuality ()
	get animate quality

local	getQuality ()
	get animate quality

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

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
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 Animate3D *	create (Animation3D *animation)
	create Animate3D using Animation. More...

var	create ( var animation)
	create Animate3D using Animation. More...

local	create ( local animation)
	create Animate3D using Animation. More...

static Animate3D *	create (Animation3D *animation, float fromTime, float duration)
	create Animate3D More...

static Animate3D *	createWithFrames (Animation3D *animation, int startFrame, int endFrame, float frameRate=30.f)
	create Animate3D by frame section, [startFrame, endFrame) More...

local	createWithFrames ( local animation, local startFrame, local endFrame, local f)
	create Animate3D by frame section, [startFrame, endFrame) More...

static float	getTransitionTime ()
	get animate transition time between 3d animations

var	getTransitionTime ()
	get animate transition time between 3d animations

local	getTransitionTime ()
	get animate transition time between 3d animations

static void	setTransitionTime (float transTime)
	set animate transition time between 3d animations

local	setTransitionTime ( local transTime)
	set animate transition time between 3d animations

Protected Member Functions
bool	init (Animation3D *animation)
	init method

var	init ( var animation)
	init method

local	init ( local animation)
	init method

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

Animate3D, Animates a Sprite3D given with an Animation3D.

Member Function Documentation

static Animate3D* create ( Animation3D * animation )

static

create Animate3D using Animation.

var create ( var animation )

static

create Animate3D using Animation.

local create ( local animation )

static

create Animate3D using Animation.

static Animate3D* create	(	Animation3D *	animation,
		float	fromTime,
		float	duration
	)

static

create Animate3D

Parameters

animation	used to generate animate3D
fromTime
duration	Time the Animate3D lasts

Returns: Animate3D created using animate

var create	(	var	animation,
		var	fromTime,
		var	duration
	)

static

create Animate3D

Parameters

animation	used to generate animate3D
fromTime
duration	Time the Animate3D lasts

Returns: Animate3D created using animate

local create	(	local	animation,
		local	fromTime,
		local	duration
	)

static

create Animate3D

Parameters

animation	used to generate animate3D
fromTime
duration	Time the Animate3D lasts

Returns: Animate3D created using animate

static Animate3D* createWithFrames	(	Animation3D *	animation,
		int	startFrame,
		int	endFrame,
		float	frameRate = `30.f`
	)

static

create Animate3D by frame section, [startFrame, endFrame)

Parameters

animation	used to generate animate3D
startFrame
endFrame
frameRate	default is 30 per second

Returns: Animate3D created using animate

var createWithFrames	(	var	animation,
		var	startFrame,
		var	endFrame,
		var	frameRate = `30.f`
	)

static

create Animate3D by frame section, [startFrame, endFrame)

Parameters

animation	used to generate animate3D
startFrame
endFrame
frameRate	default is 30 per second

Returns: Animate3D created using animate

local createWithFrames	(	local	animation,
		local	startFrame,
		local	endFrame,
		local	frameRate = `30.f`
	)

static

create Animate3D by frame section, [startFrame, endFrame)

Parameters

animation	used to generate animate3D
startFrame
endFrame
frameRate	default is 30 per second

Returns: Animate3D created using animate

virtual void stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

var stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

local stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

virtual void step ( float dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from ActionInterval.

var step ( var dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from ActionInterval.

local step ( local dt )

overridevirtual

Parameters

dt	in seconds

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

virtual Animate3D* reverse ( void ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns: A new action that performs the exact reverse of the action.

Reimplemented from ActionInterval.

var reverse ( )

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns: A new action that performs the exact reverse of the action.

Reimplemented from ActionInterval.

local reverse ( )

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns: A new action that performs the exact reverse of the action.

Reimplemented from ActionInterval.

virtual Animate3D* clone ( ) const

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionInterval.

var clone ( )

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionInterval.

local clone ( )

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from ActionInterval.

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.

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

CCAnimate3D.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation