CCAnimationFrame Class Reference

CCAnimationFrame A frame of the animation. More...

#include <CCAnimation.h>

Inheritance diagram for CCAnimationFrame:

Public Member Functions
	CCAnimationFrame ()
virtual	~CCAnimationFrame ()
virtual CCObject *	copyWithZone (CCZone *pZone)
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 CCSpriteFrame *	getSpriteFrame (void)
	getSpriteFrame More...
local	getSpriteFrame ()
	getSpriteFrame More...
virtual void	setSpriteFrame (CCSpriteFrame *var)
	setSpriteFrame More...
var	setSpriteFrame ( var var)
	setSpriteFrame More...
local	setSpriteFrame ( local var)
	setSpriteFrame More...
virtual CCDictionary *	getUserInfo (void)
	getUserInfo More...
virtual void	setUserInfo (CCDictionary *var)
	setUserInfo More...
var	setUserInfo ( var var)
	setUserInfo More...
local	setUserInfo ( local var)
	setUserInfo More...
Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (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)

Protected Attributes
CCSpriteFrame *	m_pSpriteFrame
	CCSpriteFrameName to be used. More...
float	m_fDelayUnits
	how many units of time the frame takes More...
var	m_fDelayUnits
	how many units of time the frame takes More...
local	m_fDelayUnits
	how many units of time the frame takes More...
CCDictionary *	m_pUserInfo
	getDelayUnits 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

CCAnimationFrame A frame of the animation.

It contains information like:

• sprite frame name
• # of delay units.
• offset

Since

v2.0

Constructor & Destructor Documentation

CCAnimationFrame

(

)

var ctor

(

)

local CCAnimationFrame

(

)

virtual ~CCAnimationFrame ( )

virtual

Member Function Documentation

virtual CCObject* copyWithZone ( CCZone *  pZone)

virtual

Reimplemented from CCCopying.

virtual CCSpriteFrame* getSpriteFrame ( void  )

virtual

getSpriteFrame

var getSpriteFrame (   )

virtual

getSpriteFrame

local getSpriteFrame (   )

virtual

getSpriteFrame

virtual CCDictionary* getUserInfo ( void  )

virtual

getUserInfo

var getUserInfo (   )

virtual

getUserInfo

local getUserInfo (   )

virtual

getUserInfo

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

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

var initWithSpriteFrame	(	var	spriteFrame,
		var	delayUnits,
		var	userInfo
	)

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

local initWithSpriteFrame	(	local	spriteFrame,
		local	delayUnits,
		local	userInfo
	)

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

virtual void setSpriteFrame ( CCSpriteFrame *  var)

virtual

setSpriteFrame

var setSpriteFrame ( var  var)

virtual

setSpriteFrame

local setSpriteFrame ( local  var)

virtual

setSpriteFrame

virtual void setUserInfo ( CCDictionary *  var)

virtual

setUserInfo

var setUserInfo ( var  var)

virtual

setUserInfo

local setUserInfo ( local  var)

virtual

setUserInfo

Member Data Documentation

float m_fDelayUnits

protected

how many units of time the frame takes

var m_fDelayUnits

protected

how many units of time the frame takes

local m_fDelayUnits

protected

how many units of time the frame takes

CCSpriteFrame* m_pSpriteFrame

protected

CCSpriteFrameName to be used.

var m_pSpriteFrame

protected

CCSpriteFrameName to be used.

local m_pSpriteFrame

protected

CCSpriteFrameName to be used.

CCDictionary* m_pUserInfo

protected

getDelayUnits

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

var m_pUserInfo

protected

getDelayUnits

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

local m_pUserInfo

protected

getDelayUnits

setDelayUnits 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:

• /Users/cocos2d/MyWork/cocos2d-x/cocos2dx/sprite_nodes/CCAnimation.h