AnimationCache Class Reference

Singleton that manages the Animations. More...

#include <CCAnimationCache.h>

Inheritance diagram for AnimationCache:

Public Member Functions
	AnimationCache ()
	ctor More...
	~AnimationCache ()
	NA NA More...
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...
void	removeAnimationByName (const std::string &name)
Animation *	getAnimation (const std::string &name)
	Returns a Animation that was previously added. More...
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 Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	NA NA More...

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

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
Protected Attributes inherited from Ref
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

(

)

ctor

~AnimationCache

(

)

NA NA

Member Function Documentation

void addAnimation	(	Animation *	animation,
		const std::string &	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

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

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

inline

Deprecated:

. Use getAnimation() instead NA NA

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

static AnimationCache* getInstance ( )

static

Returns the shared instance of the Animation cache.

bool init

(

void

)

static void purgeSharedAnimationCache ( )

inlinestatic

Deprecated:

Use destroyInstance() instead

void removeAnimation

(

const std::string &

name

)

Deletes a Animation from the cache.

void removeAnimationByName ( const std::string &  name )

inline

Deprecated:

.

Use removeAnimation() instead NA NA

static AnimationCache* sharedAnimationCache ( )

inlinestatic

Deprecated:

Use getInstance() instead

---

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

• /Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/cocos/2d/CCAnimationCache.h