cocos2d-x  3.0rc1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
SpriteFrameCache Class Reference

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

#include <CCSpriteFrameCache.h>

Inheritance diagram for SpriteFrameCache:
Ref

Public Member Functions

virtual ~SpriteFrameCache ()
bool init (void)
void addSpriteFramesWithFile (const std::string &plist)
 Adds multiple Sprite Frames from a plist file. More...
 
var addSpriteFrames ( var plist)
 Adds multiple Sprite Frames from a plist file. More...
 
local addSpriteFrames ( local 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 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 removeSpriteFramesFromTexture (Texture2D *texture)
 Removes all Sprite Frames associated with the specified textures. More...
 
SpriteFramegetSpriteFrameByName (const std::string &name)
 Returns an Sprite Frame that was previously added. More...
 
var getSpriteFrame ( var name)
 Returns an Sprite Frame that was previously added. More...
 
local getSpriteFrame ( local name)
 Returns an Sprite Frame that was previously added. More...
 
CC_DEPRECATED_ATTRIBUTE
SpriteFrame
spriteFrameByName (const std::string &name)
local spriteFrameByName ( local name)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Static Public Member Functions

static SpriteFrameCachegetInstance (void)
 Returns the shared instance of the Sprite Frame cache. More...
 
var getInstance ()
 Returns the shared instance of the Sprite Frame cache. More...
 
local getInstance ()
 Returns the shared instance of the Sprite Frame cache. More...
 
static CC_DEPRECATED_ATTRIBUTE
SpriteFrameCache
sharedSpriteFrameCache ()
local sharedSpriteFrameCache ()
static void destroyInstance ()
 Destroys the cache. More...
 
static CC_DEPRECATED_ATTRIBUTE void purgeSharedSpriteFrameCache ()
local purgeSharedSpriteFrameCache ()

Protected Member Functions

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

Protected Attributes

Map< std::string, SpriteFrame * > _spriteFrames
ValueMap _spriteFramesAliases
std::set< std::string > * _loadedFileNames
var _loadedFileNames
local _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

SpriteFrameCache ( )
inlineprotected
var SpriteFrameCache ( )
inlineprotected
local SpriteFrameCache ( )
inlineprotected
virtual ~SpriteFrameCache ( )
virtual

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.

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.

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.

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.

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

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

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
var addSpriteFrames ( var  plist,
var  textureFileName 
)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames.

Since
v0.99.5
local addSpriteFrames ( local  plist,
local  textureFileName 
)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames.

Since
v0.99.5
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.

var addSpriteFrames ( var  plist,
var  texture 
)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames.

local addSpriteFrames ( local  plist,
local  texture 
)

Adds multiple Sprite Frames from a plist file.

The texture will be associated with the created sprite frames.

static void destroyInstance ( )
static

Destroys the cache.

It releases all the Sprite Frames and the retained instance.

var 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 SpriteFrameCache*
getInstance
( void  )
static

Returns the shared instance of the Sprite Frame cache.

var getInstance (   )
static

Returns the shared instance of the Sprite Frame cache.

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

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.

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.

bool init ( void  )
var init (   )
local init (   )
static CC_DEPRECATED_ATTRIBUTE
void
purgeSharedSpriteFrameCache
( )
inlinestatic
var purgeSharedSpriteFrameCache ( )
inlinestatic
local purgeSharedSpriteFrameCache ( )
inlinestatic
void removeSpriteFrameByName ( const std::string &  name)

Deletes an sprite frame from the sprite frame cache.

var removeSpriteFrameByName ( var  name)

Deletes an sprite frame from the sprite frame cache.

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

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

Since
v0.99.5
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.

Since
v0.99.5
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.
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.

Since
v0.995.
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.

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.

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

static CC_DEPRECATED_ATTRIBUTE
SpriteFrameCache*
sharedSpriteFrameCache
( )
inlinestatic
var sharedSpriteFrameCache ( )
inlinestatic
local sharedSpriteFrameCache ( )
inlinestatic
CC_DEPRECATED_ATTRIBUTE
SpriteFrame* spriteFrameByName
( const std::string &  name)
inline
var spriteFrameByName ( var  name)
inline
local spriteFrameByName ( local  name)
inline

Member Data Documentation

std::set<std::string>
* _loadedFileNames
protected
var _loadedFileNames
protected
local _loadedFileNames
protected
Map<std::string, SpriteFrame*>
_spriteFrames
protected
var _spriteFrames
protected
local _spriteFrames
protected
ValueMap _spriteFramesAliases
protected
var _spriteFramesAliases
protected
local _spriteFramesAliases
protected

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