Animates a sprite given the name of an Animation. More...

#include <CCActionInterval.h>

Inheritance diagram for Animate:

Public Member Functions
void	setAnimation (Animation *animation)
	sets the Animation object to be animated More...

Animation *	getAnimation ()
	returns the Animation object that is being animated More...

const Animation *	getAnimation () const

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

virtual Animate *	reverse () const override
	returns a new action that performs the exactly the reverse action More...

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

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

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

virtual	~Animate ()

bool	initWithAnimation (Animation *animation)
	initializes the action with an Animation and will restore the original frame when the animation is over More...

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

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

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 Animate *	create (Animation *animation)
	creates the action with an Animation and will restore the original frame when the animation is over More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: Animate()

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 Attributes
std::vector< float > *	_splitTimes

int	_nextFrame

SpriteFrame *	_origFrame

unsigned int	_executedLoops

Animation *	_animation

EventCustom *	_frameDisplayedEvent

AnimationFrame::DisplayedEventInfo	_frameDisplayedEventInfo

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

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

Animates a sprite given the name of an Animation.

Constructor & Destructor Documentation

virtual ~Animate ( )

virtual

Member Function Documentation

virtual Animate* clone ( ) const

overridevirtual

returns a clone of action

Reimplemented from ActionInterval.

static Animate* create ( Animation * animation )

static

creates the action with an Animation and will restore the original frame when the animation is over

Animation* getAnimation ( )

inline

returns the Animation object that is being animated

const Animation* getAnimation ( ) const

inline

bool initWithAnimation ( Animation * animation )

initializes the action with an Animation and will restore the original frame when the animation is over

virtual Animate* reverse ( void ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Reimplemented from ActionInterval.

void setAnimation ( Animation * animation )

sets the Animation object to be animated

virtual void startWithTarget ( Node * target )

overridevirtual

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

Reimplemented from ActionInterval.

virtual void stop ( void )

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__

Animation* _animation

protected

unsigned int _executedLoops

protected

EventCustom* _frameDisplayedEvent

protected

AnimationFrame::DisplayedEventInfo _frameDisplayedEventInfo

protected

int _nextFrame

protected

SpriteFrame* _origFrame

protected

std::vector<float>* _splitTimes

protected

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/cocos/2d/CCActionInterval.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation