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

582 lines
13 KiB
C
Raw Normal View History

2013-06-06 12:02:54 +08:00
/****************************************************************************
Copyright (c) 2013 cocos2d-x.org
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 __CCARMATURE_DATAS_H__
#define __CCARMATURE_DATAS_H__
2013-06-06 12:02:54 +08:00
#include "cocostudio/CCArmatureDefine.h"
#include "cocostudio/CCTweenFunction.h"
2013-06-06 12:02:54 +08:00
2013-09-13 18:07:37 +08:00
#define CC_CREATE_NO_PARAM_NO_INIT(varType)\
2013-06-06 12:02:54 +08:00
public: \
2013-09-13 18:07:37 +08:00
static inline varType *create(void){ \
varType *var = new varType();\
if (var)\
2013-06-06 12:02:54 +08:00
{\
2013-09-13 18:07:37 +08:00
var->autorelease();\
return var;\
2013-06-06 12:02:54 +08:00
}\
2013-09-13 18:07:37 +08:00
CC_SAFE_DELETE(var);\
return nullptr;\
2013-06-06 12:02:54 +08:00
}
2013-09-13 18:07:37 +08:00
#define CC_CREATE_NO_PARAM(varType)\
2013-06-06 12:02:54 +08:00
public: \
2013-09-13 18:07:37 +08:00
static inline varType *create(void){ \
varType *var = new varType();\
if (var && var->init())\
2013-06-06 12:02:54 +08:00
{\
2013-09-13 18:07:37 +08:00
var->autorelease();\
return var;\
2013-06-06 12:02:54 +08:00
}\
2013-09-13 18:07:37 +08:00
CC_SAFE_DELETE(var);\
return nullptr;\
2013-06-06 12:02:54 +08:00
}
namespace cocostudio {
2013-06-07 10:52:32 +08:00
2013-06-06 12:02:54 +08:00
/**
* The base node include a lot of attributes.
* @js NA
* @lua NA
*/
class BaseData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(BaseData)
2013-06-07 10:52:32 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
BaseData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~BaseData(void);
2013-06-07 10:52:32 +08:00
/*
2013-09-13 18:07:37 +08:00
* Copy data from node
* @param node A BaseData to copy data
2013-06-07 10:52:32 +08:00
*/
virtual void copy(const BaseData *node);
2013-06-07 10:52:32 +08:00
/*
* Calculate two BaseData's between value(to - from) and set to self
2013-06-07 10:52:32 +08:00
*
* @param from from BaseData
* @param to to BaseData
2013-06-07 10:52:32 +08:00
*/
virtual void subtract(BaseData *from, BaseData *to, bool limit);
2013-09-13 18:07:37 +08:00
virtual void setColor(const cocos2d::Color4B &color);
virtual cocos2d::Color4B getColor();
2013-06-07 10:52:32 +08:00
public:
2013-09-13 18:07:37 +08:00
float x; //! position x attribute
float y; //! position y attribute
int zOrder; //! zorder attribute, used to order the Bone's depth order
2013-06-07 19:48:31 +08:00
2013-06-07 10:52:32 +08:00
/**
* x y skewX skewY scaleX scaleY used to calculate transform matrix
* skewX, skewY can have rotation effect
* To get more matrix information, you can have a look at this pape : http://www.senocular.com/flash/tutorials/transformmatrix/
*/
float skewX;
float skewY;
float scaleX;
float scaleY;
2013-09-13 18:07:37 +08:00
float tweenRotate; //! SkewX, SkewY, and TweenRotate effect the rotation
2013-06-07 10:52:32 +08:00
2013-09-13 18:07:37 +08:00
bool isUseColorInfo; //! Whether or not this frame have the color changed Info
2013-06-07 10:52:32 +08:00
int a, r, g, b;
2013-06-06 12:02:54 +08:00
};
2013-06-06 12:02:54 +08:00
/**
2013-09-13 18:07:37 +08:00
* DisplayType distinguish which type your display is.
2013-06-06 12:02:54 +08:00
*/
2013-06-07 10:52:32 +08:00
enum DisplayType
{
2013-09-13 18:07:37 +08:00
CS_DISPLAY_SPRITE, //! display is a single Sprite
CS_DISPLAY_ARMATURE, //! display is a Armature
2013-09-13 18:07:37 +08:00
CS_DISPLAY_PARTICLE, //! display is a CCParticle.
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
CS_DISPLAY_MAX
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class DisplayData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(DisplayData)
2013-06-06 12:02:54 +08:00
2013-09-13 18:07:37 +08:00
static const char *changeDisplayToTexture(const char *displayName);
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
DisplayData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
virtual ~DisplayData(void);
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
DisplayType displayType; //! mark which type your display is
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class SpriteDisplayData : public DisplayData
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(SpriteDisplayData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
SpriteDisplayData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
virtual ~SpriteDisplayData();
2013-06-06 12:02:54 +08:00
void setParam(const char *pszDisplayName) { this->displayName = pszDisplayName; }
void copy(SpriteDisplayData *displayData);
2013-06-06 12:02:54 +08:00
public:
2013-06-07 10:52:32 +08:00
/**
* If DisplayType is CS_DISPLAY_SPRITE, then Bone will use this image name to create a Sprite from CCSpriteFrameCache.
2013-09-15 20:24:25 +08:00
* It should note that when use this name to create Sprite from CCSpriteFrameCache, you should use _displayName + ".png", because when use Texture Packer to pack single image file, the name have ".png".
2013-06-07 10:52:32 +08:00
*
* If DisplayType is CS_DISPLAY_ARMATURE, the name is the Armature's name. When Bone init display and type is CS_DISPLAY_ARMATURE,
* then Bone will create a Armature.
2013-06-07 10:52:32 +08:00
*/
std::string displayName;
2013-06-06 12:02:54 +08:00
BaseData skinData;
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class ArmatureDisplayData : public DisplayData
2013-06-07 10:52:32 +08:00
{
2013-06-06 12:02:54 +08:00
public:
CC_CREATE_NO_PARAM_NO_INIT(ArmatureDisplayData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
ArmatureDisplayData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
virtual ~ArmatureDisplayData();
2013-06-06 12:02:54 +08:00
void setParam(const char *pszDisplayName) { this->displayName = pszDisplayName; }
void copy(ArmatureDisplayData *displayData);
2013-06-06 12:02:54 +08:00
public:
2013-06-07 10:52:32 +08:00
/**
* If DisplayType is CS_DISPLAY_SPRITE, then Bone will use this image name to create a Sprite from CCSpriteFrameCache.
2013-09-15 20:24:25 +08:00
* It should note that when use this name to create Sprite from CCSpriteFrameCache, you should use _displayName + ".png", because when use Texture Packer to pack single image file, the name have ".png".
2013-06-07 10:52:32 +08:00
*
* If DisplayType is CS_DISPLAY_ARMATURE, the name is the Armature's name. When Bone init display and type is CS_DISPLAY_ARMATURE,
* then Bone will create a Armature.
2013-06-07 10:52:32 +08:00
*/
std::string displayName;
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class ParticleDisplayData : public DisplayData
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(ParticleDisplayData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
ParticleDisplayData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
virtual ~ParticleDisplayData() {};
2013-06-06 12:02:54 +08:00
void setParam(const char *pszPlistName) { this->plist = pszPlistName; }
2013-06-06 12:02:54 +08:00
void copy(ParticleDisplayData *displayData);
2013-06-07 10:52:32 +08:00
public:
std::string plist;
2013-06-06 12:02:54 +08:00
};
/**
* BoneData used to init a Bone.
* BoneData keeps a DisplayData list, a Bone can have many display to change.
* The display information saved in the DisplayData
* @js NA
* @lua NA
2013-06-06 12:02:54 +08:00
*/
class BoneData : public BaseData
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM(BoneData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
BoneData(void);
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~BoneData(void);
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
virtual bool init();
2013-06-06 12:02:54 +08:00
void addDisplayData(DisplayData *displayData);
DisplayData *getDisplayData(int index);
2013-06-06 12:02:54 +08:00
public:
2013-09-13 18:07:37 +08:00
std::string name; //! the bone's name
std::string parentName; //! the bone parent's name
cocos2d::Array displayDataList; //! save DisplayData informations for the Bone
cocos2d::AffineTransform boneDataTransform;
2013-06-06 12:02:54 +08:00
};
2013-06-06 12:02:54 +08:00
/**
* ArmatureData saved the Armature name and Bonedata needed for the CCBones in this Armature
* When we create a Armature, we need to get each Bone's BoneData as it's init information.
* So we can get a BoneData from the Dictionary saved in the ArmatureData.
* @js NA
* @lua NA
2013-06-06 12:02:54 +08:00
*/
class ArmatureData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM(ArmatureData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
ArmatureData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~ArmatureData();
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
bool init();
void addBoneData(BoneData *boneData);
BoneData *getBoneData(const char *boneName);
2013-06-06 12:02:54 +08:00
public:
2013-06-07 10:52:32 +08:00
std::string name;
cocos2d::Dictionary boneDataDic;
2013-09-13 18:07:37 +08:00
float dataVersion;
};
enum BlendType
2013-09-13 18:07:37 +08:00
{
BLEND_NORMAL,
BLEND_LAYER,
BLEND_DARKEN,
BLEND_MULTIPLY,
BLEND_LIGHTEN,
BLEND_SCREEN,
BLEND_OVERLAY,
BLEND_HARD_LIGHT,
BLEND_ADD,
BLEND_SUBSTRACT,
BLEND_DIFFERENCE,
BLEND_INVERT,
BLEND_ALPHA,
BLEND_ERASE
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class FrameData : public BaseData
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(FrameData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
FrameData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~FrameData();
2013-06-06 12:02:54 +08:00
virtual void copy(const BaseData *baseData);
2013-06-06 12:02:54 +08:00
public:
2013-09-13 18:07:37 +08:00
int frameID;
int duration; //! The frame will last duration frames
TweenType tweenEasing; //! Every frame's tween easing effect
2013-09-17 20:14:08 +08:00
bool isTween; //! Whether it's a tween key frame
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
/**
* The current display index when change to this frame.
2013-09-13 18:07:37 +08:00
* If value is -1, then display will not be shown.
2013-06-07 10:52:32 +08:00
*/
int displayIndex;
2013-06-06 12:02:54 +08:00
BlendType blendType;
2013-09-13 18:07:37 +08:00
std::string strEvent;
2013-06-07 10:52:32 +08:00
/**
2013-09-13 18:07:37 +08:00
* strMovement, strEvent, strSound, strSoundEffect do not support yet
2013-06-07 10:52:32 +08:00
*/
2013-09-13 18:07:37 +08:00
std::string strMovement;
std::string strSound;
std::string strSoundEffect;
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class MovementBoneData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM(MovementBoneData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
MovementBoneData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~MovementBoneData(void);
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
virtual bool init();
2013-06-06 12:02:54 +08:00
void addFrameData(FrameData *frameData);
FrameData *getFrameData(int index);
2013-06-06 12:02:54 +08:00
public:
2013-09-13 18:07:37 +08:00
float delay; //! movement delay percent, this value can produce a delay effect
float scale; //! scale this movement
float duration; //! this Bone in this movement will last m_iDuration frames
2013-09-13 18:07:37 +08:00
std::string name; //! bone name
2013-06-06 12:02:54 +08:00
cocos2d::Array frameList;
2013-06-06 12:02:54 +08:00
};
/**
* @js NA
* @lua NA
*/
class MovementData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(MovementData)
2013-06-07 10:52:32 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
MovementData(void);
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~MovementData(void);
2013-06-07 10:52:32 +08:00
void addMovementBoneData(MovementBoneData *movBoneData);
MovementBoneData *getMovementBoneData(const char *boneName);
2013-06-07 10:52:32 +08:00
public:
std::string name;
int duration; //! the frames this movement will last
2013-09-13 18:07:37 +08:00
float scale; //! scale this movement
2013-06-07 10:52:32 +08:00
/**
2013-09-13 18:07:37 +08:00
* Change to this movement will last durationTo frames. Use this effect can avoid too suddenly changing.
2013-06-07 10:52:32 +08:00
*
2013-09-13 18:07:37 +08:00
* Example : current movement is "stand", we want to change to "run", then we fill durationTo frames before
2013-06-07 10:52:32 +08:00
* change to "run" instead of changing to "run" directly.
*/
int durationTo;
/*
2013-09-13 18:07:37 +08:00
* This is different from duration, durationTween contain tween effect.
* duration is the raw time that the animation will last, it's the same with the time you edit in the Action Editor.
* durationTween is the actual time you want this animation last.
* Example : If we edit 10 frames in the flash, then duration is 10. When we set durationTween to 50, the movement will last 50 frames, the extra 40 frames will auto filled with tween effect
2013-06-07 10:52:32 +08:00
*/
int durationTween;
2013-09-13 18:07:37 +08:00
bool loop; //! whether the movement was looped
2013-06-07 19:48:31 +08:00
2013-06-07 10:52:32 +08:00
/**
* Which tween easing effect the movement use
* TWEEN_EASING_MAX : use the value from MovementData get from flash design panel
2013-06-07 10:52:32 +08:00
*/
TweenType tweenEasing;
2013-06-07 10:52:32 +08:00
/**
2013-09-13 18:07:37 +08:00
* @brief save movment bone data
* @key const char *
* @value MovementBoneData *
2013-09-13 18:07:37 +08:00
*/
cocos2d::Dictionary movBoneDataDic;
2013-06-06 12:02:54 +08:00
};
2013-06-06 12:02:54 +08:00
/**
* AnimationData include all movement infomation for the Armature
* The struct is AnimationData -> MovementData -> MovementBoneData -> FrameData
2013-06-06 12:02:54 +08:00
* -> MovementFrameData
* @js NA
* @lua NA
2013-06-06 12:02:54 +08:00
*/
class AnimationData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM_NO_INIT(AnimationData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
AnimationData(void);
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~AnimationData(void);
2013-06-06 12:02:54 +08:00
void addMovement(MovementData *movData);
MovementData *getMovement(const char *movementName);
2013-06-07 10:52:32 +08:00
int getMovementCount();
2013-06-06 12:02:54 +08:00
public:
2013-06-07 10:52:32 +08:00
std::string name;
cocos2d::Dictionary movementDataDic;
2013-06-07 10:52:32 +08:00
std::vector<std::string> movementNames;
2013-06-06 12:02:54 +08:00
};
struct ContourVertex2 : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
ContourVertex2(float xx, float yy)
2013-06-07 10:52:32 +08:00
{
this->x = xx;
this->y = yy;
2013-06-07 10:52:32 +08:00
}
float x;
float y;
2013-06-06 12:02:54 +08:00
};
/*
* ContourData include a contour vertex information
* @js NA
* @lua NA
2013-06-06 12:02:54 +08:00
*/
class ContourData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM(ContourData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
ContourData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~ContourData(void);
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
virtual bool init();
virtual void addVertex(cocos2d::Point *vertex);
2013-06-06 12:02:54 +08:00
public:
cocos2d::Array vertexList; //! Save contour vertex info, vertex saved in a Point
2013-06-06 12:02:54 +08:00
};
/*
* TextureData include a texture's information
* @js NA
* @lua NA
2013-06-06 12:02:54 +08:00
*/
class TextureData : public cocos2d::Object
2013-06-06 12:02:54 +08:00
{
public:
CC_CREATE_NO_PARAM(TextureData)
2013-06-06 12:02:54 +08:00
public:
2013-09-16 14:13:55 +08:00
/**
* @js ctor
*/
TextureData();
2013-09-16 14:13:55 +08:00
/**
* @js NA
* @lua NA
*/
~TextureData(void);
2013-06-06 12:02:54 +08:00
2013-06-07 10:52:32 +08:00
virtual bool init();
2013-06-06 12:02:54 +08:00
void addContourData(ContourData *contourData);
ContourData *getContourData(int index);
2013-06-06 12:02:54 +08:00
public:
2013-06-07 19:48:31 +08:00
2013-09-13 18:07:37 +08:00
float height; //! The texture's width, height
float width;
2013-06-06 12:02:54 +08:00
2013-09-13 18:07:37 +08:00
float pivotX; //! The texture's anchor point
2013-06-07 10:52:32 +08:00
float pivotY;
2013-06-06 12:02:54 +08:00
2013-09-13 18:07:37 +08:00
std::string name; //! The texture's name
2013-06-06 12:02:54 +08:00
cocos2d::Array contourDataList;
2013-06-06 12:02:54 +08:00
};
2013-06-06 12:02:54 +08:00
}
2013-06-06 12:02:54 +08:00
#endif /*__CCARMATURE_DATAS_H__*/