axmol/cocos/editor-support/cocostudio/CCArmatureDataManager.h

210 lines
6.9 KiB
C
Raw Normal View History

2013-06-06 12:02:54 +08:00
/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
2013-06-06 12:02:54 +08:00
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 __CCARMATUREDATAMANAGER_H__
#define __CCARMATUREDATAMANAGER_H__
#include "editor-support/cocostudio/CCArmatureDefine.h"
#include "editor-support/cocostudio/CCDatas.h"
#include "editor-support/cocostudio/CocosStudioExport.h"
2013-06-06 12:02:54 +08:00
namespace cocostudio {
2013-06-06 12:02:54 +08:00
struct RelativeData
{
std::vector<std::string> plistFiles;
std::vector<std::string> armatures;
std::vector<std::string> animations;
std::vector<std::string> textures;
};
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief format and manage armature configuration and armature animation
2013-06-06 12:02:54 +08:00
*/
class CC_STUDIO_DLL ArmatureDataManager : public cocos2d::Ref
2013-06-06 12:02:54 +08:00
{
public:
2015-06-17 13:16:06 +08:00
/** @deprecated Use getInstance() instead */
CC_DEPRECATED_ATTRIBUTE static ArmatureDataManager *sharedArmatureDataManager() { return ArmatureDataManager::getInstance(); }
/** @deprecated Use destroyInstance() instead */
2013-12-27 20:54:05 +08:00
CC_DEPRECATED_ATTRIBUTE static void purge() { ArmatureDataManager::destroyInstance(); };
2013-09-17 23:03:33 +08:00
static ArmatureDataManager *getInstance();
2013-12-27 20:54:05 +08:00
static void destroyInstance();
2013-09-17 23:03:33 +08:00
2013-06-06 12:02:54 +08:00
private:
2015-06-17 13:16:06 +08:00
/**
2013-09-16 14:13:55 +08:00
* @js ctor
*/
ArmatureDataManager(void);
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~ArmatureDataManager(void);
2013-06-06 12:02:54 +08:00
public:
2013-09-13 18:07:37 +08:00
/**
* Init ArmatureDataManager
2013-06-06 12:02:54 +08:00
*/
virtual bool init();
2013-09-13 18:07:37 +08:00
/**
* Add armature data
* @param id The id of the armature data
* @param armatureData ArmatureData *
2013-09-13 18:07:37 +08:00
*/
void addArmatureData(const std::string& id, ArmatureData *armatureData, const std::string& configFilePath = "");
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief get armature data
* @param id the id of the armature data you want to get
* @return ArmatureData *
2013-09-13 18:07:37 +08:00
*/
ArmatureData *getArmatureData(const std::string& id);
2013-09-13 18:07:37 +08:00
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief remove armature data
* @param id the id of the armature data you want to get
2013-06-06 12:02:54 +08:00
*/
void removeArmatureData(const std::string& id);
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief add animation data
* @param id the id of the animation data
* @return AnimationData *
2013-06-06 12:02:54 +08:00
*/
void addAnimationData(const std::string& id, AnimationData *animationData, const std::string& configFilePath = "");
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief get animation data from _animationDatas(Dictionary)
* @param id the id of the animation data you want to get
* @return AnimationData *
2013-06-06 12:02:54 +08:00
*/
AnimationData *getAnimationData(const std::string& id);
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief remove animation data
* @param id the id of the animation data
2013-06-06 12:02:54 +08:00
*/
void removeAnimationData(const std::string& id);
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief add texture data
* @param id the id of the texture data
* @return TextureData *
2013-06-06 12:02:54 +08:00
*/
void addTextureData(const std::string& id, TextureData *textureData, const std::string& configFilePath = "");
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief get texture data
* @param id the id of the texture data you want to get
* @return TextureData *
2013-06-06 12:02:54 +08:00
*/
TextureData *getTextureData(const std::string& id);
2013-09-13 18:07:37 +08:00
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief remove texture data
* @param id the id of the texture data you want to get
2013-06-06 12:02:54 +08:00
*/
void removeTextureData(const std::string& id);
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager.
2013-09-13 18:07:37 +08:00
*/
void addArmatureFileInfo(const std::string& configFilePath);
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager.
* It will load data in a new thread
2013-09-13 18:07:37 +08:00
*/
void addArmatureFileInfoAsync(const std::string& configFilePath, cocos2d::Ref *target, cocos2d::SEL_SCHEDULE selector);
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager.
2013-06-06 12:02:54 +08:00
*/
void addArmatureFileInfo(const std::string& imagePath, const std::string& plistPath, const std::string& configFilePath);
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager.
* It will load data in a new thread
2013-09-13 18:07:37 +08:00
*/
void addArmatureFileInfoAsync(const std::string& imagePath, const std::string& plistPath, const std::string& configFilePath, cocos2d::Ref *target, cocos2d::SEL_SCHEDULE selector);
2013-09-13 18:07:37 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief Add sprite frame to CCSpriteFrameCache, it will save display name and it's relative image name
2013-06-06 12:02:54 +08:00
*/
void addSpriteFrameFromFile(const std::string& plistPath, const std::string& imagePath, const std::string& configFilePath = "");
virtual void removeArmatureFileInfo(const std::string& configFilePath);
2013-09-13 18:07:37 +08:00
2013-06-06 12:02:54 +08:00
2013-09-13 18:07:37 +08:00
/**
* @brief Judge whether or not need auto load sprite file
2013-09-13 18:07:37 +08:00
*/
bool isAutoLoadSpriteFile();
2013-12-17 19:32:16 +08:00
const cocos2d::Map<std::string, ArmatureData*>& getArmatureDatas() const;
const cocos2d::Map<std::string, AnimationData*>& getAnimationDatas() const;
const cocos2d::Map<std::string, TextureData*>& getTextureDatas() const;
protected:
void addRelativeData(const std::string& configFilePath);
RelativeData *getRelativeData(const std::string& configFilePath);
2013-06-06 12:02:54 +08:00
private:
/**
* @brief save armature datas
2015-06-17 13:16:06 +08:00
* @key std::string
* @value ArmatureData *
2013-06-06 12:02:54 +08:00
*/
2013-12-17 19:32:16 +08:00
cocos2d::Map<std::string, ArmatureData*> _armarureDatas;
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief save animation datas
* @key std::string
* @value AnimationData *
2013-06-06 12:02:54 +08:00
*/
2013-12-17 19:32:16 +08:00
cocos2d::Map<std::string, AnimationData*> _animationDatas;
2013-06-06 12:02:54 +08:00
/**
2015-06-17 13:16:06 +08:00
* @brief save texture datas
* @key std::string
* @value TextureData *
2013-06-06 12:02:54 +08:00
*/
2013-12-17 19:32:16 +08:00
cocos2d::Map<std::string, TextureData*> _textureDatas;
2013-06-06 12:02:54 +08:00
2013-09-15 20:24:25 +08:00
bool _autoLoadSpriteFile;
2013-12-26 10:23:51 +08:00
std::unordered_map<std::string, RelativeData> _relativeDatas;
2013-06-06 12:02:54 +08:00
};
}
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
#endif/*__CCARMATUREDATAMANAGER_H__*/