AnimationCache Class Reference

Singleton that manages the Animations. More...

#include <CCAnimationCache.h>

Inheritance diagram for AnimationCache:

Public Member Functions
	AnimationCache ()
	~AnimationCache ()
bool	init (void)
void	addAnimation (Animation *animation, const std::string &name)
	Adds a Animation with a name. More...
void	removeAnimation (const std::string &name)
	Deletes a Animation from the cache. More...
local	removeAnimation ( local name)
	Deletes a Animation from the cache. More...
CC_DEPRECATED_ATTRIBUTE void	removeAnimationByName (const std::string &name)
Animation *	getAnimation (const std::string &name)
	Returns a Animation that was previously added. More...
CC_DEPRECATED_ATTRIBUTE Animation *	animationByName (const std::string &name)
void	addAnimationsWithDictionary (const ValueMap &dictionary, const std::string &plist)
	Adds an animation from an NSDictionary Make sure that the frames were previously loaded in the SpriteFrameCache. More...
void	addAnimationsWithFile (const std::string &plist)
	Adds an animation from a plist file. More...
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...
unsigned int	getReferenceCount () const
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)
virtual void	update (float dt)

Static Public Member Functions
static AnimationCache *	getInstance ()
	Returns the shared instance of the Animation cache. More...
var	getInstance ()
	Returns the shared instance of the Animation cache. More...
local	getInstance ()
	Returns the shared instance of the Animation cache. More...
static void	destroyInstance ()
	Purges the cache. More...
local	destroyInstance ()
	Purges the cache. More...
static CC_DEPRECATED_ATTRIBUTE AnimationCache *	sharedAnimationCache ()
local	sharedAnimationCache ()
static CC_DEPRECATED_ATTRIBUTE void	purgeSharedAnimationCache ()
local	purgeSharedAnimationCache ()

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...
int	_luaID
	Lua reference id. More...
Protected Attributes inherited from Object
unsigned int	_referenceCount
	count of references More...

Detailed Description

Singleton that manages the Animations.

It saves in a cache the animations. You should use this class if you want to save your animations in a cache.

Before v0.99.5, the recommend way was to save them on the Sprite. Since v0.99.5, you should use this class instead.

Since

v0.99.5

Constructor & Destructor Documentation

AnimationCache

(

)

var ctor

(

)

local AnimationCache

(

)

~AnimationCache

(

)

Member Function Documentation

void addAnimation	(	Animation *	animation,
		const std::string &	name
	)

Adds a Animation with a name.

var addAnimation	(	var	animation,
		var	name
	)

Adds a Animation with a name.

local addAnimation	(	local	animation,
		local	name
	)

Adds a Animation with a name.

void addAnimationsWithDictionary	(	const ValueMap &	dictionary,
		const std::string &	plist
	)

Adds an animation from an NSDictionary Make sure that the frames were previously loaded in the SpriteFrameCache.

Parameters

plist

The path of the relative file,it use to find the plist path for load SpriteFrames.

Since

v1.1

var addAnimationsWithDictionary	(	var	dictionary,
		var	plist
	)

Adds an animation from an NSDictionary Make sure that the frames were previously loaded in the SpriteFrameCache.

Parameters

plist

The path of the relative file,it use to find the plist path for load SpriteFrames.

Since

v1.1

local addAnimationsWithDictionary	(	local	dictionary,
		local	plist
	)

Adds an animation from an NSDictionary Make sure that the frames were previously loaded in the SpriteFrameCache.

Parameters

plist

The path of the relative file,it use to find the plist path for load SpriteFrames.

Since

v1.1

void addAnimationsWithFile

(

const std::string &

plist)

Adds an animation from a plist file.

Make sure that the frames were previously loaded in the SpriteFrameCache.

Since

v1.1

var addAnimations

(

var

plist)

Adds an animation from a plist file.

Make sure that the frames were previously loaded in the SpriteFrameCache.

Since

v1.1

local addAnimations

(

local

plist)

Adds an animation from a plist file.

Make sure that the frames were previously loaded in the SpriteFrameCache.

Since

v1.1

CC_DEPRECATED_ATTRIBUTE Animation* animationByName ( const std::string &  name)

inline

Deprecated:

. Use getAnimation() instead

static void destroyInstance ( )

static

Purges the cache.

It releases all the Animation objects and the shared instance.

var destroyInstance ( )

static

Purges the cache.

It releases all the Animation objects and the shared instance.

local destroyInstance ( )

static

Purges the cache.

It releases all the Animation objects and the shared instance.

Animation* getAnimation

(

const std::string &

name)

Returns a Animation that was previously added.

If the name is not found it will return nil. You should retain the returned copy if you are going to use it.

var getAnimation

(

var

name)

Returns a Animation that was previously added.

If the name is not found it will return nil. You should retain the returned copy if you are going to use it.

local getAnimation

(

local

name)

Returns a Animation that was previously added.

If the name is not found it will return nil. You should retain the returned copy if you are going to use it.

static AnimationCache* getInstance ( )

static

Returns the shared instance of the Animation cache.

var getInstance ( )

static

Returns the shared instance of the Animation cache.

local getInstance ( )

static

Returns the shared instance of the Animation cache.

bool init

(

void

)

var init

(

)

local init

(

)

static CC_DEPRECATED_ATTRIBUTE void purgeSharedAnimationCache ( )

inlinestatic

Deprecated:

Use destroyInstance() instead

var purgeSharedAnimationCache ( )

inlinestatic

Deprecated:

Use destroyInstance() instead

local purgeSharedAnimationCache ( )

inlinestatic

Deprecated:

Use destroyInstance() instead

void removeAnimation

(

const std::string &

name)

Deletes a Animation from the cache.

var removeAnimation

(

var

name)

Deletes a Animation from the cache.

local removeAnimation

(

local

name)

Deletes a Animation from the cache.

CC_DEPRECATED_ATTRIBUTE void removeAnimationByName ( const std::string &  name)

inline

Deprecated:

. Use removeAnimation() instead

static CC_DEPRECATED_ATTRIBUTE AnimationCache* sharedAnimationCache ( )

inlinestatic

Deprecated:

Use getInstance() instead

var sharedAnimationCache ( )

inlinestatic

Deprecated:

Use getInstance() instead

local sharedAnimationCache ( )

inlinestatic

Deprecated:

Use getInstance() instead

---

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

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