CCSpriteFrameCache

#ifndef __SPRITE_CCSPRITE_FRAME_CACHE_H__

#define __SPRITE_CCSPRITE_FRAME_CACHE_H__

/*

 * To create sprite frames and texture atlas, use this tool:

 *http://zwoptex.zwopple.com/

 */

#include "sprite_nodes/CCSpriteFrame.h"

#include "textures/CCTexture2D.h"

#include "cocoa/CCObject.h"

#include <set>

#include <string>

NS_CC_BEGIN

class CCDictionary;

class CCArray;

class CCSprite;

/**

 * @addtogroup sprite_nodes

 * @{

 */

/** @brief Singleton that handles the loading of the sprite frames.

 It saves in a cache the sprite frames.

 @since v0.9

 */

class CC_DLL CCSpriteFrameCache : public CCObject

{

protected:

    // MARMALADE: Made this protected not private, as deriving from this class is pretty useful

    CCSpriteFrameCache(void) : m_pSpriteFrames(NULL), m_pSpriteFramesAliases(NULL){}

public:

    bool init(void);

    ~CCSpriteFrameCache(void);

private:

    /*Adds multiple Sprite Frames with a dictionary. The texture will be associated with the created sprite frames.

     */

    void addSpriteFramesWithDictionary(CCDictionary* pobDictionary, CCTexture2D *pobTexture);

public:

    /** 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:texture method.

     */

    void addSpriteFramesWithFile(const char *pszPlist);

    /** 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 char* plist, const char* textureFileName);

    /** Adds multiple Sprite Frames from a plist file. The texture will be associated with the created sprite frames. */

    void addSpriteFramesWithFile(const char *pszPlist, CCTexture2D *pobTexture);

    /** 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 addSpriteFrame(CCSpriteFrame *pobFrame, const char *pszFrameName);

    /** 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 removeSpriteFrames(void);

    /** 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 removeUnusedSpriteFrames(void);

    /** Deletes an sprite frame from the sprite frame cache. */

    void removeSpriteFrameByName(const char *pszName);

    /** 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 removeSpriteFramesFromFile(const char* plist);

private:

    /** Removes multiple Sprite Frames from CCDictionary.

    * @since v0.99.5

    */

    void removeSpriteFramesFromDictionary(CCDictionary* dictionary);

public:

    /** 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 removeSpriteFramesFromTexture(CCTexture2D* texture);

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

     */

    CCSpriteFrame* spriteFrameByName(const char *pszName);

public:

    /** Returns the shared instance of the Sprite Frame cache */

    static CCSpriteFrameCache* sharedSpriteFrameCache(void);

    /** Purges the cache. It releases all the Sprite Frames and the retained instance. */

    static void purgeSharedSpriteFrameCache(void);

private:

    // MARMALADE: Made this protected not private, as deriving from this class is pretty useful

//    CCSpriteFrameCache(void) : m_pSpriteFrames(NULL), m_pSpriteFramesAliases(NULL){}

protected:

    CCDictionary* m_pSpriteFrames;

    CCDictionary* m_pSpriteFramesAliases;

    std::set<std::string>*  m_pLoadedFileNames;

};

// end of sprite_nodes group

/// @}

NS_CC_END

#endif // __SPRITE_CCSPRITE_FRAME_CACHE_H__