2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
|
|
Copyright (c) 2009 Jason Booth
|
|
|
|
Copyright (c) 2009 Robert J Payne
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __SPRITE_CCSPRITE_FRAME_CACHE_H__
|
|
|
|
#define __SPRITE_CCSPRITE_FRAME_CACHE_H__
|
|
|
|
|
|
|
|
#include <set>
|
|
|
|
#include <unordered_map>
|
|
|
|
#include <string>
|
|
|
|
#include "2d/CCSpriteFrame.h"
|
2021-08-13 14:52:58 +08:00
|
|
|
#include "2d/CCSpriteSheetLoader.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
#include "base/CCRef.h"
|
|
|
|
#include "base/CCValue.h"
|
|
|
|
#include "base/CCMap.h"
|
2021-08-13 14:52:58 +08:00
|
|
|
#include "base/CCData.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
NS_CC_BEGIN
|
|
|
|
|
|
|
|
class Sprite;
|
|
|
|
class Texture2D;
|
|
|
|
class PolygonInfo;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup _2d
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** @class SpriteFrameCache
|
|
|
|
* @brief 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
- `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
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
Use one of the following tools to create the .plist file and sprite sheet:
|
|
|
|
- [TexturePacker](https://www.codeandweb.com/texturepacker/cocos2d)
|
|
|
|
- [Zwoptex](https://zwopple.com/zwoptex/)
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
@since v0.9
|
|
|
|
@js cc.spriteFrameCache
|
|
|
|
*/
|
|
|
|
class CC_DLL SpriteFrameCache : public Ref
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/** Returns the shared instance of the Sprite Frame cache.
|
|
|
|
*
|
|
|
|
* @return The instance of the Sprite Frame Cache.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
static SpriteFrameCache* getInstance();
|
|
|
|
|
|
|
|
/** Destroys the cache. It releases all the Sprite Frames and the retained instance.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @js NA
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
static void destroyInstance();
|
|
|
|
|
|
|
|
/** Destructor.
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~SpriteFrameCache();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Initialize method.
|
|
|
|
*
|
|
|
|
* @return if success return true.
|
|
|
|
*/
|
|
|
|
bool init();
|
|
|
|
|
|
|
|
/** 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
* If you want to use another texture, you should use the addSpriteFramesWithFile(const std::string& plist, const
|
|
|
|
* std::string& textureFileName) method.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @js addSpriteFrames
|
|
|
|
* @lua addSpriteFrames
|
|
|
|
*
|
2021-08-13 14:52:58 +08:00
|
|
|
* @param spriteSheetFileName file name.
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param spriteSheetFormat
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void addSpriteFramesWithFile(const std::string& spriteSheetFileName,
|
|
|
|
uint32_t spriteSheetFormat = SpriteSheetFormat::PLIST);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-08-17 07:04:51 +08:00
|
|
|
/** 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
|
|
|
|
*
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param spriteSheetFileName Plist file name.
|
2021-08-17 07:04:51 +08:00
|
|
|
* @param textureFileName Texture file name.
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param spriteSheetFormat
|
2021-08-17 07:04:51 +08:00
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void addSpriteFramesWithFile(const std::string& spriteSheetFileName,
|
|
|
|
const std::string& textureFileName,
|
|
|
|
uint32_t spriteSheetFormat = SpriteSheetFormat::PLIST);
|
2021-08-17 07:04:51 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Adds multiple Sprite Frames from a plist file. The texture will be associated with the created sprite frames.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @js addSpriteFrames
|
|
|
|
* @lua addSpriteFrames
|
|
|
|
*
|
2021-08-13 14:52:58 +08:00
|
|
|
* @param spriteSheetFileName file name.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param texture Texture pointer.
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param spriteSheetFormat
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void addSpriteFramesWithFile(const std::string& spriteSheetFileName,
|
|
|
|
Texture2D* texture,
|
|
|
|
uint32_t spriteSheetFormat = SpriteSheetFormat::PLIST);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Adds multiple Sprite Frames from a plist file content. The texture will be associated with the created sprite
|
|
|
|
* frames.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @js NA
|
|
|
|
* @lua addSpriteFrames
|
|
|
|
*
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param content file content string.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param texture Texture pointer.
|
2021-08-17 12:04:45 +08:00
|
|
|
* @param spriteSheetFormat
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void addSpriteFramesWithFileContent(const Data& content,
|
|
|
|
Texture2D* texture,
|
|
|
|
uint32_t spriteSheetFormat = SpriteSheetFormat::PLIST);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** 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.
|
|
|
|
*
|
|
|
|
* @param frame A certain sprite frame.
|
|
|
|
* @param frameName The name of the sprite frame.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void addSpriteFrame(SpriteFrame* frame, const std::string& frameName);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** Check if multiple Sprite Frames from a plist file have been loaded.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*
|
|
|
|
* @param plist Plist file name.
|
|
|
|
* @return True if the file is loaded.
|
|
|
|
*/
|
2019-11-23 20:27:39 +08:00
|
|
|
bool isSpriteFramesWithFileLoaded(const std::string& plist) const;
|
|
|
|
|
|
|
|
/** 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();
|
|
|
|
|
|
|
|
/** 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @js NA
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
void removeUnusedSpriteFrames();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Deletes an sprite frame from the sprite frame cache.
|
2019-11-23 20:27:39 +08:00
|
|
|
*
|
|
|
|
* @param name The name of the sprite frame that needs to removed.
|
|
|
|
*/
|
|
|
|
void removeSpriteFrameByName(const std::string& name);
|
|
|
|
|
|
|
|
/** Removes multiple Sprite Frames from a plist file.
|
2021-12-25 10:04:45 +08:00
|
|
|
* 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
|
|
|
|
*
|
|
|
|
* @param plist The name of the plist that needs to removed.
|
|
|
|
*/
|
2019-11-23 20:27:39 +08:00
|
|
|
void removeSpriteFramesFromFile(const std::string& plist);
|
|
|
|
|
|
|
|
/** Removes multiple Sprite Frames from a plist file content.
|
2021-12-25 10:04:45 +08:00
|
|
|
* Sprite Frames stored in this file will be removed.
|
|
|
|
* It is convenient to call this method when a specific texture needs to be removed.
|
|
|
|
*
|
|
|
|
* @param plist_content The string of the plist content that needs to removed.
|
|
|
|
* @js NA
|
|
|
|
*/
|
2019-11-23 20:27:39 +08:00
|
|
|
void removeSpriteFramesFromFileContent(const std::string& plist_content);
|
|
|
|
|
|
|
|
/** 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.
|
|
|
|
*
|
|
|
|
* @param texture The texture that needs to removed.
|
|
|
|
*/
|
|
|
|
void removeSpriteFramesFromTexture(Texture2D* 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.
|
|
|
|
* @js getSpriteFrame
|
|
|
|
* @lua getSpriteFrame
|
|
|
|
*
|
|
|
|
* @param name A certain sprite frame name.
|
|
|
|
* @return The sprite frame.
|
|
|
|
*/
|
|
|
|
SpriteFrame* getSpriteFrameByName(const std::string& name);
|
|
|
|
|
2021-08-13 14:52:58 +08:00
|
|
|
bool reloadTexture(const std::string& spriteSheetFileName);
|
|
|
|
|
|
|
|
SpriteFrame* findFrame(const std::string& frame);
|
|
|
|
|
|
|
|
/** Record SpriteFrame with plist and frame name, add frame name
|
2021-12-25 10:04:45 +08:00
|
|
|
* and plist to index
|
|
|
|
*/
|
|
|
|
void insertFrame(const std::shared_ptr<SpriteSheet>& spriteSheet,
|
|
|
|
const std::string& frameName,
|
|
|
|
SpriteFrame* frameObj);
|
2021-08-13 14:52:58 +08:00
|
|
|
|
|
|
|
/** Delete frame from cache, rebuild index
|
2021-12-25 10:04:45 +08:00
|
|
|
*/
|
2021-08-13 14:52:58 +08:00
|
|
|
bool eraseFrame(const std::string& frameName);
|
|
|
|
|
|
|
|
void addSpriteFrameCapInset(SpriteFrame* spriteFrame, const Rect& capInsets, Texture2D* texture);
|
|
|
|
|
2021-08-20 12:43:19 +08:00
|
|
|
void registerSpriteSheetLoader(std::shared_ptr<ISpriteSheetLoader> loader);
|
2021-08-17 12:04:45 +08:00
|
|
|
void deregisterSpriteSheetLoader(uint32_t spriteSheetFormat);
|
2021-08-13 14:52:58 +08:00
|
|
|
|
2021-08-17 12:04:45 +08:00
|
|
|
ISpriteSheetLoader* getSpriteSheetLoader(uint32_t spriteSheetFormat);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
protected:
|
|
|
|
// MARMALADE: Made this protected not private, as deriving from this class is pretty useful
|
2021-12-25 10:04:45 +08:00
|
|
|
SpriteFrameCache() {}
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** Removes multiple Sprite Frames from Dictionary.
|
2021-12-25 10:04:45 +08:00
|
|
|
* @since v0.99.5
|
|
|
|
*/
|
2019-11-23 20:27:39 +08:00
|
|
|
void removeSpriteFramesFromDictionary(ValueMap& dictionary);
|
|
|
|
|
2021-08-13 14:52:58 +08:00
|
|
|
/** Delete a list of frames from cache, rebuild index
|
2021-12-25 10:04:45 +08:00
|
|
|
*/
|
2021-08-13 14:52:58 +08:00
|
|
|
bool eraseFrames(const std::vector<std::string>& frame);
|
|
|
|
/** Delete frame from index and SpriteFrame is kept.
|
2021-12-25 10:04:45 +08:00
|
|
|
*/
|
2021-08-13 14:52:58 +08:00
|
|
|
bool removeSpriteSheet(const std::string& spriteSheetFileName);
|
|
|
|
/** Clear index and all SpriteFrames.
|
2021-12-25 10:04:45 +08:00
|
|
|
*/
|
2021-08-13 14:52:58 +08:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
inline bool hasFrame(const std::string& frame) const;
|
|
|
|
inline bool isSpriteSheetInUse(const std::string& spriteSheetFileName) const;
|
|
|
|
|
|
|
|
inline Map<std::string, SpriteFrame*>& getSpriteFrames();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
void markPlistFull(const std::string& spriteSheetFileName, bool full)
|
|
|
|
{
|
|
|
|
_spriteSheets[spriteSheetFileName]->full = full;
|
|
|
|
}
|
2021-08-13 14:52:58 +08:00
|
|
|
bool isPlistFull(const std::string& spriteSheetFileName) const
|
|
|
|
{
|
|
|
|
auto&& it = _spriteSheets.find(spriteSheetFileName);
|
|
|
|
return it == _spriteSheets.end() ? false : it->second->full;
|
|
|
|
}
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-08-13 14:52:58 +08:00
|
|
|
private:
|
|
|
|
Map<std::string, SpriteFrame*> _spriteFrames;
|
|
|
|
std::unordered_map<std::string, std::shared_ptr<SpriteSheet>> _spriteSheets;
|
|
|
|
std::unordered_map<std::string, std::shared_ptr<SpriteSheet>> _spriteFrameToSpriteSheetMap;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-08-20 12:43:19 +08:00
|
|
|
std::map<uint32_t, std::shared_ptr<ISpriteSheetLoader>> _spriteSheetLoaders;
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
// end of _2d group
|
|
|
|
/// @}
|
|
|
|
|
|
|
|
NS_CC_END
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
#endif // __SPRITE_CCSPRITE_FRAME_CACHE_H__
|