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
	called every frame with it's delta time. DON'T override unless you know what you are doing. More...

virtual void	startWithTarget (Node *target) override
	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...

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

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

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

void	setSpeed (float speed)

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

void	setWeight (float weight)

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

void	setPlayBack (bool reverse)

virtual	~Animate3D ()

void	removeFromMap ()

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

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

Node *	getTarget () const

void	setTarget (Node *target)
	The action will modify the target properties. More...

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

Ref *	autorelease ()
	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...

Ref *	copy () const
	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...

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

static float	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)

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 Types
enum	Animate3DState { FadeIn, FadeOut, Running }

Protected Attributes
Animate3DState	_state

Animation3D *	_animation

float	_absSpeed

float	_weight

float	_start

float	_last

bool	_playReverse

float	_accTransTime

float	_lastTime

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

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

Static Protected Attributes
static float	_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...

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

Detailed Description

Animate3D, Animates a Sprite3D given with an Animation3D.

Member Enumeration Documentation

enum Animate3DState

strongprotected

Enumerator
FadeIn
FadeOut
Running

Constructor & Destructor Documentation

virtual ~Animate3D ( )

virtual

Member Function Documentation

virtual Animate3D* clone ( ) const

overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

static Animate3D* create ( Animation3D * 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

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

bool getPlayBack ( ) const

inline

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

float getSpeed ( ) const

get & set speed, negative speed means playing reverse

static float getTransitionTime ( )

inlinestatic

animate transition time

float getWeight ( ) const

inline

get & set blend weight, weight must positive

void removeFromMap ( )

virtual Animate3D* reverse ( void ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

void setPlayBack ( bool reverse )

inline

void setSpeed ( float speed )

void setWeight ( float weight )

virtual void startWithTarget ( Node * target )

overridevirtual

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

Reimplemented from ActionInterval.

virtual void step ( float dt )

overridevirtual

called every frame with it's delta time. DON'T override unless you know what you are doing.

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.

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

CC_CONSTRUCTOR_ACCESS __pad0__

float _absSpeed

protected

float _accTransTime

protected

Animation3D* _animation

protected

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

protected

float _last

protected

float _lastTime

protected

bool _playReverse

protected

float _start

protected

Animate3DState _state

protected

float _transTime

staticprotected

float _weight

protected

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

staticprotected

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

staticprotected

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

staticprotected

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/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