SpriteFrameCache Class Reference

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

Inherits Ref.

Public Member Functions
virtual	~SpriteFrameCache ()
	Destructor. More...
bool	init ()
	Initialize method. More...
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...
bool	isSpriteFramesWithFileLoaded (const std::string &plist) const
	Check if multiple Sprite Frames from a plist file have been loaded. 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...
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 ()
	Destructor. More...

Static Public Member Functions
static SpriteFrameCache *	getInstance ()
	Returns the shared instance of the Sprite Frame cache. More...
static void	destroyInstance ()
	Destroys the cache. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

Singleton that handles the loading of the sprite frames.

The SpriteFrameCache loads SpriteFrames from a .plist file. A SpriteFrame contains information about how to use a sprite located in a sprite sheet.

The .plist file contains the following elements:

• frames: Dictionary of sprites. Key is the sprite's name, value a dict containing the sprite frame data. A sprite frame consists of the following values:
  • spriteOffset: difference vector between the original sprite's center and the center of the trimmed sprite
  • spriteSize: size of the trimmed sprite
  • spriteSourceSize: size of the original sprite
  • textureRect: the position of the sprite in the sprite sheet
  • textureRotated: true if the sprite is rotated clockwise
  • anchor: anchor point in normalized coordinates (optional) Optional values when using polygon outlines
  • triangles: 3 indices per triangle, pointing to vertices and verticesUV coordinates
  • vertices: vertices in sprite coordinates, each vertex consists of a pair of x and y coordinates
  • verticesUV: vertices in the sprite sheet, each vertex consists of a pair of x and y coordinates
• metadata: Dictionary containing additional information about the sprite sheet:
  • format: plist file format, currently 3
  • size: size of the texture (optional)
  • textureFileName: name of the texture's image file

Use one of the following tools to create the .plist file and sprite sheet:

• TexturePacker
• Zwoptex

Since

v0.9 @js cc.spriteFrameCache

Constructor & Destructor Documentation

~SpriteFrameCache()

virtual ~SpriteFrameCache ( )

virtual

Destructor.

@js NA @lua NA

Member Function Documentation

getInstance()

static SpriteFrameCache* getInstance ( )

static

Returns the shared instance of the Sprite Frame cache.

Returns

The instance of the Sprite Frame Cache. @js NA

destroyInstance()

static void destroyInstance ( )

static

Destroys the cache.

It releases all the Sprite Frames and the retained instance. @js NA

init()

bool init

(

)

Initialize method.

Returns

if success return true.

addSpriteFramesWithFile() [1/3]

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. @js addSpriteFrames @lua addSpriteFrames

Parameters

plist

Plist file name.

addSpriteFramesWithFile() [2/3]

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 @js addSpriteFrames @lua addSpriteFrames

Parameters

plist	Plist file name.
textureFileName	Texture file name.

addSpriteFramesWithFile() [3/3]

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. @js addSpriteFrames @lua addSpriteFrames

Parameters

plist	Plist file name.
texture	Texture pointer.

addSpriteFramesWithFileContent()

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. @js NA @lua addSpriteFrames

Parameters

plist_content	Plist file content string.
texture	Texture pointer.

addSpriteFrame()

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.

Parameters

frame	A certain sprite frame.
frameName	The name of the sprite frame.

isSpriteFramesWithFileLoaded()

bool isSpriteFramesWithFileLoaded

(

const std::string &

plist

)

const

Check if multiple Sprite Frames from a plist file have been loaded.

@js NA @lua NA

Parameters

plist

Plist file name.

Returns

True if the file is loaded.

removeSpriteFrames()

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.

removeUnusedSpriteFrames()

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. @js NA

removeSpriteFrameByName()

void removeSpriteFrameByName

(

const std::string &

name

)

Deletes an sprite frame from the sprite frame cache.

Parameters

name	The name of the sprite frame that needs to removed.

removeSpriteFramesFromFile()

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

Parameters

plist

The name of the plist that needs to removed.

removeSpriteFramesFromFileContent()

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.

Parameters

plist_content

The string of the plist content that needs to removed. @js NA

removeSpriteFramesFromTexture()

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.

Parameters

texture

The texture that needs to removed.

getSpriteFrameByName()

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. @js getSpriteFrame @lua getSpriteFrame

Parameters

name	A certain sprite frame name.

Returns

The sprite frame.

---

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

• CCSpriteFrameCache.h