SpriteFrameCache Class Reference

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

Inherits Ref.

Public Member Functions
virtual	~SpriteFrameCache ()
	Destructor.
bool	init ()
	Initialize method. More...
var	init ()
	Initialize method. More...
local	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...
local	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...
local	getSpriteFrame ( local name)
	Returns an Sprite Frame that was previously added. More...
SpriteFrame *	spriteFrameByName (const std::string &name)
local	spriteFrameByName ( local name)
bool	reloadTexture (const std::string &plist)
	Reload packed texture with special file name. More...
var	reloadTexture ( var plist)
	Reload packed texture with special file name. More...
local	reloadTexture ( local plist)
	Reload packed texture with special file name. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
local	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...
local	getReferenceCount ()
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor.

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

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
local	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
local	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
local	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
local	_rooted
	When true, it means that the object was already rooted.
bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...
local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

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

Member Function Documentation

static SpriteFrameCache* getInstance ( )

static

Returns the shared instance of the Sprite Frame cache.

The instance of the Sprite Frame Cache.

local getInstance ( )

static

Returns the shared instance of the Sprite Frame cache.

The instance of the Sprite Frame Cache.

static SpriteFrameCache* sharedSpriteFrameCache ( )

inlinestatic

local sharedSpriteFrameCache ( )

inlinestatic

static void destroyInstance ( )

static

Destroys the cache.

It releases all the Sprite Frames and the retained instance.

local destroyInstance ( )

static

Destroys the cache.

It releases all the Sprite Frames and the retained instance.

static void purgeSharedSpriteFrameCache ( )

inlinestatic

local purgeSharedSpriteFrameCache ( )

inlinestatic

bool init

(

)

Initialize method.

if success return true.

var init

(

)

Initialize method.

if success return true.

local init

(

)

Initialize method.

if success return true.

void addSpriteFramesWithFile

(

const std::string &

plist

)

Adds multiple Sprite Frames from a plist file.

A texture will be loaded automatically. When texture file is not specified in plist file, 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. Plist file name.

var addSpriteFrames

(

var

plist

)

Adds multiple Sprite Frames from a plist file.

A texture will be loaded automatically. When texture file is not specified in plist file, 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. Plist file name.

local addSpriteFrames

(

local

plist

)

Adds multiple Sprite Frames from a plist file.

A texture will be loaded automatically. When texture file is not specified in plist file, 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. Plist file name.

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. Plist file name. Texture file name.

var addSpriteFrames	(	var	plist,
		var	textureFileName
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames. Plist file name. Texture file name.

local addSpriteFrames	(	local	plist,
		local	textureFileName
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames. Plist file name. Texture file name.

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. Plist file name. Texture pointer.

var addSpriteFrames	(	var	plist,
		var	texture
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames. Plist file name. Texture pointer.

local addSpriteFrames	(	local	plist,
		local	texture
	)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames. Plist file name. Texture pointer.

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. Plist file content string. Texture pointer.

local addSpriteFrames	(	local	plist_content,
		local	texture
	)

Adds multiple Sprite Frames from a plist file content.

The texture will be associated with the created sprite frames. Plist file content string. Texture pointer.

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.

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

var addSpriteFrame	(	var	frame,
		var	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.

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

local addSpriteFrame	(	local	frame,
		local	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.

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

bool isSpriteFramesWithFileLoaded

(

const std::string &

plist

)

const

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

Plist file name. True if the file is loaded.

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.

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

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

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

void removeSpriteFrameByName

(

const std::string &

name

)

Deletes an sprite frame from the sprite frame cache.

The name of the sprite frame that needs to removed.

var removeSpriteFrameByName

(

var

name

)

Deletes an sprite frame from the sprite frame cache.

The name of the sprite frame that needs to removed.

local removeSpriteFrameByName

(

local

name

)

Deletes an sprite frame from the sprite frame cache.

The name of the sprite frame that needs to removed.

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. The name of the plist that needs to removed.

var removeSpriteFramesFromFile

(

var

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. The name of the plist that needs to removed.

local removeSpriteFramesFromFile

(

local

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. The name of the plist that needs to removed.

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.

The string of the plist content used to find the corresponding SpriteFrame.

local removeSpriteFramesFromFileContent

(

local

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.

The string of the plist content used to find the corresponding SpriteFrame.

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. The texture used to find the corresponding SpriteFrame.

var removeSpriteFramesFromTexture

(

var

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. The texture used to find the corresponding SpriteFrame.

local removeSpriteFramesFromTexture

(

local

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. The texture used to find the corresponding SpriteFrame.

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. A certain sprite frame name. The sprite frame.

var getSpriteFrame

(

var

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. A certain sprite frame name. The sprite frame.

local getSpriteFrame

(

local

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. A certain sprite frame name. The sprite frame.

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

inline

var spriteFrameByName ( var  name )

inline

local spriteFrameByName ( local  name )

inline

bool reloadTexture

(

const std::string &

plist

)

Reload packed texture with special file name.

Plist file name. True if the file is loaded.

var reloadTexture

(

var

plist

)

Reload packed texture with special file name.

Plist file name. True if the file is loaded.

local reloadTexture

(

local

plist

)

Reload packed texture with special file name.

Plist file name. True if the file is loaded.

---

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

• CCSpriteFrameCache.h