SpriteFrameCache Class Reference

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

#include <SpriteFrameCache.h>

Public Member Functions
virtual	~SpriteFrameCache ()
	Destructor.
bool	init ()
	Initialize method.
void	addSpriteFramesWithFile (std::string_view spriteSheetFileName, uint32_t spriteSheetFormat=SpriteSheetFormat::PLIST)
	Adds multiple Sprite Frames from a plist file.
void	addSpriteFramesWithFile (std::string_view spriteSheetFileName, std::string_view textureFileName, uint32_t spriteSheetFormat=SpriteSheetFormat::PLIST)
	Adds multiple Sprite Frames from a plist file.
void	addSpriteFramesWithFile (std::string_view spriteSheetFileName, Texture2D *texture, uint32_t spriteSheetFormat=SpriteSheetFormat::PLIST)
	Adds multiple Sprite Frames from a plist file.
void	addSpriteFramesWithFileContent (const Data &content, Texture2D *texture, uint32_t spriteSheetFormat=SpriteSheetFormat::PLIST)
	Adds multiple Sprite Frames from a plist file content.
void	addSpriteFrame (SpriteFrame *frame, std::string_view frameName)
	Adds an sprite frame with a given name.
bool	isSpriteFramesWithFileLoaded (std::string_view plist) const
	Check if multiple Sprite Frames from a plist file have been loaded.
void	removeSpriteFrames ()
	Purges the dictionary of loaded sprite frames.
void	removeUnusedSpriteFrames ()
	Removes unused sprite frames.
void	removeSpriteFrameByName (std::string_view name)
	Deletes an sprite frame from the sprite frame cache.
void	removeSpriteFramesFromFile (std::string_view plist)
	Removes multiple Sprite Frames from a plist file.
void	removeSpriteFramesFromFileContent (std::string_view plist_content)
	Removes multiple Sprite Frames from a plist file content.
void	removeSpriteFramesFromTexture (Texture2D *texture)
	Removes all Sprite Frames associated with the specified textures.
SpriteFrame *	getSpriteFrameByName (std::string_view name)
	Returns an Sprite Frame that was previously added.
void	insertFrame (const std::shared_ptr< SpriteSheet > &spriteSheet, std::string_view frameName, SpriteFrame *frameObj)
	Record SpriteFrame with plist and frame name, add frame name and plist to index.
bool	eraseFrame (std::string_view frameName)
	Delete frame from cache, rebuild index.

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

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	(	std::string_view	spriteSheetFileName,
		uint32_t	spriteSheetFormat = SpriteSheetFormat::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(std::string_view plist, const std::string& textureFileName) method. @js addSpriteFrames @lua addSpriteFrames

Parameters

spriteSheetFileName	file name.
spriteSheetFormat

addSpriteFramesWithFile() [2/3]

void addSpriteFramesWithFile	(	std::string_view	spriteSheetFileName,
		std::string_view	textureFileName,
		uint32_t	spriteSheetFormat = SpriteSheetFormat::PLIST )

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

spriteSheetFileName	Plist file name.
textureFileName	Texture file name.
spriteSheetFormat

addSpriteFramesWithFile() [3/3]

void addSpriteFramesWithFile	(	std::string_view	spriteSheetFileName,
		Texture2D *	texture,
		uint32_t	spriteSheetFormat = SpriteSheetFormat::PLIST )

Adds multiple Sprite Frames from a plist file.

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

Parameters

spriteSheetFileName	file name.
texture	Texture pointer.
spriteSheetFormat

addSpriteFramesWithFileContent()

void addSpriteFramesWithFileContent	(	const Data &	content,
		Texture2D *	texture,
		uint32_t	spriteSheetFormat = SpriteSheetFormat::PLIST )

Adds multiple Sprite Frames from a plist file content.

The texture will be associated with the created sprite frames. @js NA @lua addSpriteFrames

Parameters

content	file content string.
texture	Texture pointer.
spriteSheetFormat

addSpriteFrame()

void addSpriteFrame	(	SpriteFrame *	frame,
		std::string_view	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

(

std::string_view

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

(

std::string_view

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

(

std::string_view

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

(

std::string_view

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

(

std::string_view

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:

• SpriteFrameCache.h