cocos2d-x  2.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCAnimate Class Reference

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

#include <CCActionInterval.h>

Inheritance diagram for CCAnimate:
CCActionInterval CCFiniteTimeAction CCAction CCObject CCCopying

Public Member Functions

 CCAnimate ()
 ~CCAnimate ()
bool initWithAnimation (CCAnimation *pAnimation)
 initializes the action with an Animation and will restore the original frame when the animation is over More...
 
virtual CCObjectcopyWithZone (CCZone *pZone)
virtual void startWithTarget (CCNode *pTarget)
 called before the action start. It will also set the target. More...
 
virtual void stop (void)
 called after the action has finished. More...
 
virtual void update (float t)
 called once per frame. More...
 
virtual CCActionIntervalreverse (void)
 returns a reversed action More...
 
virtual CCAnimationgetAnimation (void)
 getAnimation More...
 
virtual void setAnimation (CCAnimation *var)
 setAnimation More...
 
- Public Member Functions inherited from CCActionInterval
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...
 
bool initWithDuration (float d)
 initializes the action More...
 
local initWithDuration ( local d)
 initializes the action More...
 
virtual bool isDone (void)
 returns true if the action has finished More...
 
local isDone ()
 returns true if the action has finished More...
 
virtual void step (float dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
var step ( var dt)
 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...
 
void setAmplitudeRate (float amp)
var setAmplitudeRate ( var amp)
local setAmplitudeRate ( local amp)
float getAmplitudeRate (void)
var getAmplitudeRate ()
local getAmplitudeRate ()
- Public Member Functions inherited from CCFiniteTimeAction
 CCFiniteTimeAction ()
virtual ~CCFiniteTimeAction ()
float getDuration (void)
 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 CCAction
 CCAction (void)
 ctor ()
 CCAction ()
virtual ~CCAction (void)
const char * description ()
CCNodegetTarget (void)
var getTarget ()
local getTarget ()
void setTarget (CCNode *pTarget)
 The action will modify the target properties. More...
 
local setTarget ( local pTarget)
 The action will modify the target properties. More...
 
CCNodegetOriginalTarget (void)
local getOriginalTarget ()
void setOriginalTarget (CCNode *pOriginalTarget)
 Set the original target, since target can be nil. More...
 
int getTag (void)
var getTag ()
local getTag ()
void setTag (int nTag)
var setTag ( var nTag)
local setTag ( local nTag)
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)

Static Public Member Functions

static CCAnimatecreate (CCAnimation *pAnimation)
 creates the action with an Animation and will restore the original frame when the animation is over More...
 
- Static Public Member Functions inherited from CCActionInterval
static CCActionIntervalcreate (float d)
 creates the action More...
 
- Static Public Member Functions inherited from CCAction
static CCActioncreate ()
 Create an action. More...
 
var create ()
 Create an action. More...
 
local create ()
 Create an action. More...
 

Protected Attributes

CCAnimationm_pAnimation
std::vector< float > * m_pSplitTimes
int m_nNextFrame
CCSpriteFramem_pOrigFrame
unsigned int m_uExecutedLoops
- Protected Attributes inherited from CCActionInterval
float m_elapsed
bool m_bFirstTick
var m_bFirstTick
local m_bFirstTick
- Protected Attributes inherited from CCFiniteTimeAction
float m_fDuration
 duration in seconds More...
 
- Protected Attributes inherited from CCAction
CCNodem_pOriginalTarget
CCNodem_pTarget
 The "target". More...
 
local m_pTarget
 The "target". More...
 
int m_nTag
 The action tag. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Detailed Description

Animates a sprite given the name of an Animation.

Constructor & Destructor Documentation

CCAnimate ( )
~CCAnimate ( )

Member Function Documentation

virtual CCObject* copyWithZone ( CCZone pZone)
virtual

Reimplemented from CCActionInterval.

static CCAnimate* create ( CCAnimation pAnimation)
static

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

virtual CCAnimation* getAnimation ( void  )
virtual

getAnimation

bool initWithAnimation ( CCAnimation pAnimation)

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

virtual CCActionInterval* reverse ( void  )
virtual

returns a reversed action

Reimplemented from CCActionInterval.

virtual void setAnimation ( CCAnimation var)
virtual

setAnimation

virtual void startWithTarget ( CCNode pTarget)
virtual

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

Reimplemented from CCActionInterval.

virtual void stop ( void  )
virtual

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

virtual void update ( float  time)
virtual

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

Member Data Documentation

int m_nNextFrame
protected
CCAnimation* m_pAnimation
protected
CCSpriteFrame* m_pOrigFrame
protected
std::vector<float>* m_pSplitTimes
protected
unsigned int m_uExecutedLoops
protected

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