Singleton that handles the loading of the sprite frames. More...

#include <CCSpriteFrameCache.h>

Inheritance diagram for SpriteFrameCache:

Public Member Functions
virtual	~SpriteFrameCache ()
	NA NA More...

bool	init ()

void	addSpriteFramesWithFile (const std::string &plist)
	Adds multiple Sprite Frames from a plist file. More...

void	addSpriteFramesWithFile (const std::string &plist, const std::string &textureFileName)
	Adds multiple Sprite Frames from a plist file. More...

void	addSpriteFramesWithFile (const std::string &plist, Texture2D *texture)
	Adds multiple Sprite Frames from a plist file. More...

void	addSpriteFramesWithFileContent (const std::string &plist_content, Texture2D *texture)
	Adds multiple Sprite Frames from a plist file content. More...

void	addSpriteFrame (SpriteFrame *frame, const std::string &frameName)
	Adds an sprite frame with a given name. More...

void	removeSpriteFrames ()
	Purges the dictionary of loaded sprite frames. More...

void	removeUnusedSpriteFrames ()
	Removes unused sprite frames. More...

void	removeSpriteFrameByName (const std::string &name)
	Deletes an sprite frame from the sprite frame cache. More...

void	removeSpriteFramesFromFile (const std::string &plist)
	Removes multiple Sprite Frames from a plist file. More...

void	removeSpriteFramesFromFileContent (const std::string &plist_content)
	Removes multiple Sprite Frames from a plist file content. More...

void	removeSpriteFramesFromTexture (Texture2D *texture)
	Removes all Sprite Frames associated with the specified textures. More...

SpriteFrame *	getSpriteFrameByName (const std::string &name)
	Returns an Sprite Frame that was previously added. More...

SpriteFrame *	spriteFrameByName (const std::string &name)

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 SpriteFrameCache *	getInstance ()
	Returns the shared instance of the Sprite Frame cache. More...

static SpriteFrameCache *	sharedSpriteFrameCache ()

static void	destroyInstance ()
	Destroys the cache. More...

static void	purgeSharedSpriteFrameCache ()

Protected Member Functions
	SpriteFrameCache ()

void	addSpriteFramesWithDictionary (ValueMap &dictionary, Texture2D *texture)

void	removeSpriteFramesFromDictionary (ValueMap &dictionary)
	Removes multiple Sprite Frames from Dictionary. More...

Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
Map< std::string, SpriteFrame * >	_spriteFrames

ValueMap	_spriteFramesAliases

std::set< std::string > *	_loadedFileNames

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Detailed Description

Singleton that handles the loading of the sprite frames.

It saves in a cache the sprite frames.

Since: v0.9

Constructor & Destructor Documentation

virtual ~SpriteFrameCache ( )

virtual

NA NA

SpriteFrameCache ( )

inlineprotected

Member Function Documentation

void addSpriteFrame	(	SpriteFrame *	frame,
		const std::string &	frameName
	)

Adds an sprite frame with a given name.

If the name already exists, then the contents of the old name will be replaced with the new one.

void addSpriteFramesWithDictionary	(	ValueMap &	dictionary,
		Texture2D *	texture
	)

protected

void addSpriteFramesWithFile ( const std::string & plist )

Adds multiple Sprite Frames from a plist file.

A texture will be loaded automatically. The texture name will composed by replacing the .plist suffix with .png If you want to use another texture, you should use the addSpriteFramesWithFile(const std::string& plist, const std::string& textureFileName) method. addSpriteFrames addSpriteFrames

void addSpriteFramesWithFile	(	const std::string &	plist,
		const std::string &	textureFileName
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames.

Since: v0.99.5 addSpriteFrames addSpriteFrames

void addSpriteFramesWithFile	(	const std::string &	plist,
		Texture2D *	texture
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames. addSpriteFrames addSpriteFrames

void addSpriteFramesWithFileContent	(	const std::string &	plist_content,
		Texture2D *	texture
	)

Adds multiple Sprite Frames from a plist file content.

The texture will be associated with the created sprite frames. addSpriteFrames addSpriteFrames

static void destroyInstance ( )

static

Destroys the cache.

It releases all the Sprite Frames and the retained instance.

static SpriteFrameCache* getInstance ( )

static

Returns the shared instance of the Sprite Frame cache.

SpriteFrame* getSpriteFrameByName ( const std::string & name )

Returns an Sprite Frame 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. getSpriteFrame getSpriteFrame

bool init ( )

static void purgeSharedSpriteFrameCache ( )

inlinestatic

Deprecated:: Use destroyInstance() instead

void removeSpriteFrameByName ( const std::string & name )

Deletes an sprite frame from the sprite frame cache.

void removeSpriteFrames ( )

Purges the dictionary of loaded sprite frames.

Call this method if you receive the "Memory Warning". In the short term: it will free some resources preventing your app from being killed. In the medium term: it will allocate more resources. In the long term: it will be the same.

void removeSpriteFramesFromDictionary ( ValueMap & dictionary )

protected

Removes multiple Sprite Frames from Dictionary.

Since: v0.99.5

void removeSpriteFramesFromFile ( const std::string & plist )

Removes multiple Sprite Frames from a plist file.

Sprite Frames stored in this file will be removed. It is convenient to call this method when a specific texture needs to be removed.

Since: v0.99.5

void removeSpriteFramesFromFileContent ( const std::string & plist_content )

Removes multiple Sprite Frames from a plist file content.

Sprite Frames stored in this file will be removed. It is convenient to call this method when a specific texture needs to be removed.

void removeSpriteFramesFromTexture ( Texture2D * texture )

Removes all Sprite Frames associated with the specified textures.

It is convenient to call this method when a specific texture needs to be removed.

Since: v0.995.

void removeUnusedSpriteFrames ( )

Removes unused sprite frames.

Sprite Frames that have a retain count of 1 will be deleted. It is convenient to call this method after when starting a new Scene.

static SpriteFrameCache* sharedSpriteFrameCache ( )

inlinestatic

Deprecated:: Use getInstance() instead

SpriteFrame* spriteFrameByName ( const std::string & name )

inline

Deprecated:: use getSpriteFrameByName() instead

Member Data Documentation

std::set<std::string>* _loadedFileNames

protected

Map<std::string, SpriteFrame*> _spriteFrames

protected

ValueMap _spriteFramesAliases

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation