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

Inherits ActionInterval.

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

virtual void	step (float dt) override
	Called every frame with its delta time, dt in seconds. More...

local	step ( local dt)
	Called every frame with its delta time, dt in seconds. More...

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
	override `Action`.

virtual Animate3D *	clone () const override
	override `Action`.

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

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

float	getSpeed () const
	Get speed, negative speed means playing reverse The speed.

var	getSpeed ()
	Get speed, negative speed means playing reverse The speed.

local	getSpeed ()
	Get speed, negative speed means playing reverse The speed.

void	setSpeed (float speed)
	Set speed, negative speed means playing reverse the speed.

float	getWeight () const
	Get the blend weight.

var	getWeight ()
	Get the blend weight.

local	getWeight ()
	Get the blend weight.

void	setWeight (float weight)
	Set the blend weight. More...

local	setWeight ( local weight)
	Set the blend weight. More...

void	setOriginInterval (float interval)
	Set origin interval. More...

float	getOriginInterval () const
	Get origin interval Get the origin interval.

var	getOriginInterval ()
	Get origin interval Get the origin interval.

local	getOriginInterval ()
	Get origin interval Get the origin interval.

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

void	setQuality (Animate3DQuality quality)
	Set the animate quality, see also Animate3DQuality The animate quality.

local	setQuality ( local quality)
	Set the animate quality, see also Animate3DQuality The animate quality.

Animate3DQuality	getQuality () const
	Get animate quality, see also Animate3DQuality The animate quality.

local	getQuality ()
	Get animate quality, see also Animate3DQuality The animate quality.

Public Member Functions inherited from ActionInterval
float	getElapsed (void)
	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 (void)
	Gets the ampliture rate, extension in GridAction. More...

virtual bool	isDone (void) const override
	override `Action`.

local	isDone ()
	override `Action`.

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
Node *	getTarget () const
	Return the current target. More...

void	setTarget (Node *target)
	The setter function for the target property. More...

var	setTarget ( var target)
	The setter function for the target property. More...

local	setTarget ( local target)
	The setter function for the target property. More...

Node *	getOriginalTarget () const
	Return the original Target. More...

var	getOriginalTarget ()
	Return the original Target. More...

local	getOriginalTarget ()
	Return the original Target. More...

void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...

var	setOriginalTarget ( var 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...

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

void	setFlags (unsigned int flags)
	Returns a flag field that is used to group the actions easily. More...

var	setFlags ( var flags)
	Returns a flag field that is used to group the actions easily. More...

local	setFlags ( local flags)
	Returns a flag field that is used to group the actions easily. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

local	retain ()
	Retains the ownership. More...

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

Public Member Functions inherited from Clonable
Ref *	copy () const
	Returns a copy of the Ref.

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 Animation used to generate animate3D FormTime. More...

local	create ( local animation, local fromTime, local duration)
	create Animate3D Animation used to generate animate3D FormTime. More...

static Animate3D *	createWithFrames (Animation3D *animation, int startFrame, int endFrame, float frameRate=30.f)
	Create Animate3D by frame section, [startFrame, endFrame) Animation used to generate animate3D The start frame. More...

static float	getTransitionTime ()
	Get animate transition time between 3d animations The tarnsition time.

static void	setTransitionTime (float transTime)
	Set animate transition time between 3d animations The transition time.

local	setTransitionTime ( local transTime)
	Set animate transition time between 3d animations The transition time.

Protected Member Functions
void	removeFromMap ()
	Remove this action from map.

var	removeFromMap ()
	Remove this action from map.

local	removeFromMap ()
	Remove this action from map.

bool	init (Animation3D *animation)
	Init method, init from the specified animation. More...

var	init ( var animation)
	Init method, init from the specified animation. More...

local	init ( local animation)
	Init method, init from the specified animation. More...

bool	init (Animation3D *animation, float fromTime, float duration)
	Init method, init from the start time and duration. More...

var	init ( var animation, var fromTime, var duration)
	Init method, init from the start time and duration. More...

local	init ( local animation, local fromTime, local duration)
	Init method, init from the start time and duration. More...

bool	initWithFrames (Animation3D *animation, int startFrame, int endFrame, float frameRate)
	Init with frames The specified animation The start frame The end frame The frame rate Return true if success, otherwise return false.

Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action with the duration. More...

var	initWithDuration ( var d)
	initializes the action with the duration. More...

local	initWithDuration ( local d)
	initializes the action with the duration. More...

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.

bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.

var	INVALID_TAG = -1
	Default tag used for all the actions.

local	INVALID_TAG = -1
	Default tag used for all the actions.

Detailed Description

Animate3D, Animates a Sprite3D given with an Animation3D.

Member Function Documentation

static Animate3D* create ( Animation3D * animation )

static

Create Animate3D using Animation.

The specified Animation3D object. The Animate3D object.

var create ( var animation )

static

Create Animate3D using Animation.

The specified Animation3D object. The Animate3D object.

local create ( local animation )

static

Create Animate3D using Animation.

The specified Animation3D object. The Animate3D object.

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

static

create Animate3D Animation used to generate animate3D FormTime.

Duration Time the Animate3D lasts. The Animate3D object.

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

static

create Animate3D Animation used to generate animate3D FormTime.

Duration Time the Animate3D lasts. The Animate3D object.

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

static

create Animate3D Animation used to generate animate3D FormTime.

Duration Time the Animate3D lasts. The Animate3D object.

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

static

Create Animate3D by frame section, [startFrame, endFrame) Animation used to generate animate3D The start frame.

The end frame The frameRate, default is 30 per second Animate3D created using animate

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

static

Create Animate3D by frame section, [startFrame, endFrame) Animation used to generate animate3D The start frame.

The end frame The frameRate, default is 30 per second Animate3D created using animate

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

static

Create Animate3D by frame section, [startFrame, endFrame) Animation used to generate animate3D The start frame.

The end frame The frameRate, default is 30 per second Animate3D created using animate

virtual void stop ( )

overridevirtual

Called after the action that 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 that 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 that 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

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from ActionInterval.

var step ( var dt )

overridevirtual

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from ActionInterval.

local step ( local dt )

overridevirtual

Called every frame with its delta time, dt in seconds.

DON'T override unless you know what you are doing.

In seconds.

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

A certain target.

Reimplemented from ActionInterval.

virtual void update ( float time )

overridevirtual

Called once per frame.

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

A value between 0 and 1.

Reimplemented from Action.

var update ( var time )

overridevirtual

Called once per frame.

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

A value between 0 and 1.

Reimplemented from Action.

local update ( local time )

overridevirtual

Called once per frame.

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

A value between 0 and 1.

Reimplemented from Action.

void setWeight ( float weight )

Set the blend weight.

It is internally used currently. For example, Sprite3D is playing an Animate3D, and then another Animate3D is going to be played. This function will be used to make the transition from on Animate3D to another smoothly. The blend weight, the blend weight must be positive

var setWeight ( var weight )

Set the blend weight.

It is internally used currently. For example, Sprite3D is playing an Animate3D, and then another Animate3D is going to be played. This function will be used to make the transition from on Animate3D to another smoothly. The blend weight, the blend weight must be positive

local setWeight ( local weight )

Set the blend weight.

It is internally used currently. For example, Sprite3D is playing an Animate3D, and then another Animate3D is going to be played. This function will be used to make the transition from on Animate3D to another smoothly. The blend weight, the blend weight must be positive

void setOriginInterval ( float interval )

Set origin interval.

The new interval

var setOriginInterval ( var interval )

Set origin interval.

The new interval

local setOriginInterval ( local interval )

Set origin interval.

The new interval

bool init ( Animation3D * animation )

protected

Init method, init from the specified animation.

The specified animation. Return true if success, otherwise return false.

var init ( var animation )

protected

Init method, init from the specified animation.

The specified animation. Return true if success, otherwise return false.

local init ( local animation )

protected

Init method, init from the specified animation.

The specified animation. Return true if success, otherwise return false.

bool init	(	Animation3D *	animation,
		float	fromTime,
		float	duration
	)

protected

Init method, init from the start time and duration.

The specified animation. The start time. The animate's duration Return true if success, otherwise return false.

var init	(	var	animation,
		var	fromTime,
		var	duration
	)

protected

Init method, init from the start time and duration.

The specified animation. The start time. The animate's duration Return true if success, otherwise return false.

local init	(	local	animation,
		local	fromTime,
		local	duration
	)

protected

Init method, init from the start time and duration.

The specified animation. The start time. The animate's duration Return true if success, otherwise return false.

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