cocos2d-x  2.2.3-gd2.113-rev1ec524e
Loading...
Searching...
No Matches
CCAnimationFrame Class Reference

CCAnimationFrame A frame of the animation. More...

#include <CCAnimation.h>

Inheritance diagram for CCAnimationFrame:
[legend]
Collaboration diagram for CCAnimationFrame:
[legend]

Public Member Functions

 CCAnimationFrame ()
 ctor More...
 
virtual ~CCAnimationFrame ()
 NA NA. More...
 
virtual CCObjectcopyWithZone (CCZone *pZone)
 NA NA. More...
 
bool initWithSpriteFrame (CCSpriteFrame *spriteFrame, float delayUnits, CCDictionary *userInfo)
 initializes the animation frame with a spriteframe, number of delay units and a notification user info More...
 
virtual CCSpriteFramegetSpriteFrame (void)
 
virtual void setSpriteFrame (CCSpriteFrame *var)
 
virtual float getDelayUnits (void)
 
virtual void setDelayUnits (float var)
 
virtual CCDictionarygetUserInfo (void)
 
virtual void setUserInfo (CCDictionary *var)
 
- Public Member Functions inherited from CCObject
 CCObject (void)
 
virtual ~CCObject (void)
 NA. More...
 
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)
 
virtual void update (float dt)
 
 CCObject (const CCObject &)
 
CCObjectoperator= (const CCObject &)
 
virtual void encodeWithCoder (DS_Dictionary *)
 
virtual bool canEncode ()
 
CCObjectType getObjType () const
 
virtual int getTag () const
 
virtual void setTag (int nTag)
 
void setObjType (CCObjectType)
 
virtual CCObjectcopyWithZone (CCZone *pZone)
 

Protected Attributes

CCSpriteFramem_pSpriteFrame
 CCSpriteFrameName to be used. More...
 
float m_fDelayUnits
 how many units of time the frame takes More...
 
CCDictionarym_pUserInfo
 A CCAnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
 
unsigned int m_uAutoReleaseCount
 
int m_nTag
 
int m_eObjType
 
unsigned int m_uObjectIdxInArray
 

Additional Inherited Members

- Static Public Member Functions inherited from CCObject
static CCObjectcreateWithCoder (DS_Dictionary *)
 
- Public Attributes inherited from CCObject
unsigned int m_uID
 
int m_nLuaID
 

Detailed Description

CCAnimationFrame A frame of the animation.

It contains information like:

  • sprite frame name
  • # of delay units.
  • offset
Since
v2.0

Constructor & Destructor Documentation

◆ CCAnimationFrame()

ctor

◆ ~CCAnimationFrame()

virtual ~CCAnimationFrame ( )
virtual

NA NA.

Member Function Documentation

◆ copyWithZone()

virtual CCObject * copyWithZone ( CCZone pZone)
virtual

NA NA.

Reimplemented from CCCopying.

◆ getDelayUnits()

virtual float getDelayUnits ( void  )
virtual

◆ getSpriteFrame()

virtual CCSpriteFrame * getSpriteFrame ( void  )
virtual

◆ getUserInfo()

virtual CCDictionary * getUserInfo ( void  )
virtual

◆ initWithSpriteFrame()

bool initWithSpriteFrame ( CCSpriteFrame spriteFrame,
float  delayUnits,
CCDictionary userInfo 
)

initializes the animation frame with a spriteframe, number of delay units and a notification user info

◆ setDelayUnits()

virtual void setDelayUnits ( float  var)
virtual

◆ setSpriteFrame()

virtual void setSpriteFrame ( CCSpriteFrame var)
virtual

◆ setUserInfo()

virtual void setUserInfo ( CCDictionary var)
virtual

Member Data Documentation

◆ m_fDelayUnits

float m_fDelayUnits
protected

how many units of time the frame takes

◆ m_pSpriteFrame

CCSpriteFrame* m_pSpriteFrame
protected

CCSpriteFrameName to be used.

◆ m_pUserInfo

CCDictionary* m_pUserInfo
protected

A CCAnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this dictionary as UserInfo.

If UserInfo is nil, then no notification will be broadcast.


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