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

#include <CCAnimate3D.h>

Inheritance diagram for Animate3D:

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

virtual void	step (float dt) override
var	step ( var dt)
local	step ( local dt)
virtual void	startWithTarget (Node *target) override
	called before the action start. It will also set the target. More...

var	startWithTarget ( var target)
	called before the action start. It will also set the target. More...

local	startWithTarget ( local target)
	called before the action start. It will also set the target. More...

virtual Animate3D *	reverse () const override
	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...

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

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

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

void	setSpeed (float speed)
var	setSpeed ( var speed)
local	setSpeed ( local speed)
float	getWeight () const
	get & set blend weight, weight must positive More...

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

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

void	setWeight (float weight)
var	setWeight ( var weight)
local	setWeight ( local weight)
void	setOriginInterval (float interval)
	get & set origin interval More...

var	setOriginInterval ( var interval)
	get & set origin interval More...

local	setOriginInterval ( local interval)
	get & set origin interval More...

float	getOriginInterval () const
var	getOriginInterval ()
local	getOriginInterval ()
bool	getPlayBack () const
	get & set play reverse, these are deprecated, use set negative speed instead More...

void	setPlayBack (bool reverse)
virtual	~Animate3D ()
var	~Animate3D ()
local	~Animate3D ()
void	removeFromMap ()
var	removeFromMap ()
local	removeFromMap ()
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)
local	setAmplitudeRate ( local amp)
float	getAmplitudeRate (void)
local	getAmplitudeRate ()
virtual bool	isDone (void) const override
	return true if the action has finished More...

var	isDone ()
	return true if the action has finished More...

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

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
virtual std::string	description () const
Node *	getTarget () 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...

Node *	getOriginalTarget () const
var	getOriginalTarget ()
local	getOriginalTarget ()
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
var	getTag ()
local	getTag ()
void	setTag (int tag)
var	setTag ( var tag)
local	setTag ( local tag)
virtual	~Action ()
var	~Action ()
local	~Action ()
Public Member Functions inherited from Ref
void	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...

virtual	~Ref ()
Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () 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 Animate3D *	create (Animation3D *animation)
	create Animate3D using Animation. More...

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

var	create ( var animation, var fromTime, var duration)
	create Animate3D More...

local	create ( local animation, local fromTime, local 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 ()
	animate transition time More...

local	getTransitionTime ()
	animate transition time More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: Animate3D()
Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS	__pad0__: bool initWithDuration(float d)
local	__pad0__: bool initWithDuration(float d)
Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local	__pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS	__pad0__: Action()

Protected Types
enum	Animate3DState { FadeIn, FadeOut, Running }

Protected Attributes
Animate3DState	_state
var	_state
local	_state
Animation3D *	_animation
var	_animation
local	_animation
float	_absSpeed
var	_absSpeed
local	_absSpeed
float	_weight
var	_weight
local	_weight
float	_start
var	_start
local	_start
float	_last
var	_last
local	_last
bool	_playReverse
var	_playReverse
local	_playReverse
float	_accTransTime
var	_accTransTime
local	_accTransTime
float	_lastTime
var	_lastTime
local	_lastTime
float	_originInterval
var	_originInterval
local	_originInterval
std::unordered_map< Bone3D , Animation3D::Curve >	_boneCurves
Protected Attributes inherited from ActionInterval
float	_elapsed
var	_elapsed
local	_elapsed
bool	_firstTick
var	_firstTick
local	_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...

var	_referenceCount
	count of references More...

local	_referenceCount
	count of references More...

Static Protected Attributes
static float	_transTime
var	_transTime
local	_transTime
static std::unordered_map < Sprite3D , Animate3D >	s_fadeInAnimates
static std::unordered_map < Sprite3D , Animate3D >	s_fadeOutAnimates
static std::unordered_map < Sprite3D , Animate3D >	s_runningAnimates

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

Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

	Ref ()
	Constructor. More...

Detailed Description

Animate3D, Animates a Sprite3D given with an Animation3D.

Member Enumeration Documentation

enum Animate3DState

strongprotected

Enumerator
FadeIn
FadeOut
Running

var Animate3DState

strongprotected

Enumerator
FadeIn
FadeOut
Running

local Animate3DState

strongprotected

Enumerator
FadeIn
FadeOut
Running

Constructor & Destructor Documentation

virtual ~Animate3D ( )

virtual

var ~Animate3D ( )

virtual

local ~Animate3D ( )

virtual

Member Function Documentation

virtual Animate3D* clone ( ) const

overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

var clone ( )

overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

local clone ( )

overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

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

float getOriginInterval ( ) const

inline

var getOriginInterval ( )

inline

local getOriginInterval ( )

inline

bool getPlayBack ( ) const

inline

get & set play reverse, these are deprecated, use set negative speed instead

var getPlayBack ( )

inline

get & set play reverse, these are deprecated, use set negative speed instead

local getPlayBack ( )

inline

get & set play reverse, these are deprecated, use set negative speed instead

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

static float getTransitionTime ( )

inlinestatic

animate transition time

var getTransitionTime ( )

inlinestatic

animate transition time

local getTransitionTime ( )

inlinestatic

animate transition time

float getWeight ( ) const

inline

get & set blend weight, weight must positive

var getWeight ( )

inline

get & set blend weight, weight must positive

local getWeight ( )

inline

get & set blend weight, weight must positive

void removeFromMap ( )

var removeFromMap ( )

local removeFromMap ( )

virtual Animate3D* reverse ( void ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

var reverse ( )

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

local reverse ( )

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

void setOriginInterval ( float interval )

get & set origin interval

var setOriginInterval ( var interval )

get & set origin interval

local setOriginInterval ( local interval )

get & set origin interval

void setPlayBack ( bool reverse )

inline

var setPlayBack ( var reverse )

inline

local setPlayBack ( local reverse )

inline

void setSpeed ( float speed )

var setSpeed ( var speed )

local setSpeed ( local speed )

void setWeight ( float weight )

var setWeight ( var weight )

local setWeight ( local weight )

virtual void startWithTarget ( Node * target )

overridevirtual

called before the action start. It will also set the target.

Reimplemented from ActionInterval.

var startWithTarget ( var target )

overridevirtual

called before the action start. It will also set the target.

Reimplemented from ActionInterval.

local startWithTarget ( local target )

overridevirtual

called before the action start. It will also set the target.

Reimplemented from ActionInterval.

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

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

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

Reimplemented from Action.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

float _absSpeed

protected

var _absSpeed

protected

local _absSpeed

protected

float _accTransTime

protected

var _accTransTime

protected

local _accTransTime

protected

Animation3D* _animation

protected

var _animation

protected

local _animation

protected

std::unordered_map<Bone3D*,
Animation3D::Curve*>
_boneCurves

protected

var _boneCurves

protected

local _boneCurves

protected

float _last

protected

var _last

protected

local _last

protected

float _lastTime

protected

var _lastTime

protected

local _lastTime

protected

float _originInterval

protected

var _originInterval

protected

local _originInterval

protected

bool _playReverse

protected

var _playReverse

protected

local _playReverse

protected

float _start

protected

var _start

protected

local _start

protected

Animate3DState _state

protected

var _state

protected

local _state

protected

float _transTime

staticprotected

var _transTime

staticprotected

local _transTime

staticprotected

float _weight

protected

var _weight

protected

local _weight

protected

std::unordered_map<Sprite3D*,
Animate3D*> s_fadeInAnimates

staticprotected

var s_fadeInAnimates

staticprotected

local s_fadeInAnimates

staticprotected

std::unordered_map<Sprite3D*,
Animate3D*> s_fadeOutAnimates

staticprotected

var s_fadeOutAnimates

staticprotected

local s_fadeOutAnimates

staticprotected

std::unordered_map<Sprite3D*,
Animate3D*> s_runningAnimates

staticprotected

var s_runningAnimates

staticprotected

local s_runningAnimates

staticprotected

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

/Users/huabingxu/work/cocos2d-x/cocos/3d/CCAnimate3D.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation