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

#include <CCActionInterval.h>

Inheritance diagram for Animate:

Public Member Functions
	Animate ()
virtual	~Animate ()
bool	initWithAnimation (Animation *pAnimation)
	initializes the action with an Animation and will restore the original frame when the animation is over More...

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

Public Member Functions inherited from ActionInterval
float	getElapsed (void)
	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...

bool	initWithDuration (float d)
	initializes the action More...

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

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

void	setAmplitudeRate (float amp)
float	getAmplitudeRate (void)
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...

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

local	step ( local dt)
	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
	FiniteTimeAction ()
virtual	~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
	Action ()
virtual	~Action ()
const char *	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
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
var	getTag ()
local	getTag ()
void	setTag (int tag)
var	setTag ( var tag)
local	setTag ( local tag)
Public Member Functions inherited from Object
	Object ()
	Constructor. More...

virtual	~Object ()
void	release ()
	Release the ownership immediately. More...

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

Object *	autorelease ()
	Release the ownership sometime soon automatically. More...

bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...

unsigned int	retainCount () const
	Returns the object's current reference count. More...

virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...

virtual void	acceptVisitor (DataVisitor &visitor)
Public Member Functions inherited from Clonable
virtual	~Clonable ()
Object *	copy () const
	returns a copy of the object. More...

var	copy ()
	returns a copy of the object. More...

local	copy ()
	returns a copy of the object. More...

Static Public Member Functions
static Animate *	create (Animation *pAnimation)
	creates the action with an Animation and will restore the original frame when the animation is over More...

Protected Attributes
std::vector< float > *	_splitTimes
int	_nextFrame
SpriteFrame *	_origFrame
unsigned int	_executedLoops
Animation *	_animation
Protected Attributes inherited from ActionInterval
float	_elapsed
bool	_firstTick
Protected Attributes inherited from FiniteTimeAction
float	_duration
	duration in seconds More...

Protected Attributes inherited from Action
Node *	_originalTarget
local	_originalTarget
Node *	_target
	The "target". More...

int	_tag
	The action tag. More...

Protected Attributes inherited from Object
unsigned int	_reference
	count of references More...

unsigned int	_autoReleaseCount
	count of autorelease More...

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...

int	_luaID
	Lua reference id. More...

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

Animates a sprite given the name of an Animation.

Constructor & Destructor Documentation

Animate ( )

virtual ~Animate ( )

virtual

Member Function Documentation

virtual Animate* clone ( ) const

overridevirtual

returns a clone of action

Implements ActionInterval.

static Animate* create ( Animation * pAnimation)

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 * pAnimation)

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

virtual Animate* reverse ( ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Implements 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

Animation* _animation

protected

unsigned int _executedLoops

protected

int _nextFrame

protected

SpriteFrame* _origFrame

protected

std::vector<float>* _splitTimes

protected

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCActionInterval.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation