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 __CCBONE_H__
|
|
|
|
#define __CCBONE_H__
|
|
|
|
|
2013-10-16 16:48:39 +08:00
|
|
|
#include "cocostudio/CCArmatureDefine.h"
|
|
|
|
#include "cocostudio/CCDatas.h"
|
|
|
|
#include "cocostudio/CCTween.h"
|
|
|
|
#include "cocostudio/CCDecorativeDisplay.h"
|
|
|
|
#include "cocostudio/CCDisplayManager.h"
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
namespace cocostudio {
|
2013-06-06 12:02:54 +08:00
|
|
|
|
|
|
|
|
2013-09-15 19:08:45 +08:00
|
|
|
class Armature;
|
2013-09-13 18:07:37 +08:00
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
class Bone : public cocos2d::NodeRGBA
|
2013-06-06 12:02:54 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Allocates and initializes a bone.
|
|
|
|
* @return A initialized bone which is marked as "autorelease".
|
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
static Bone *create();
|
2013-06-06 12:02:54 +08:00
|
|
|
/**
|
|
|
|
* Allocates and initializes a bone.
|
2013-06-07 10:52:32 +08:00
|
|
|
*
|
|
|
|
* @param name If name is not null, then set name to the bone's name
|
2013-06-06 12:02:54 +08:00
|
|
|
* @return A initialized bone which is marked as "autorelease".
|
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
static Bone *create(const char *name);
|
2013-06-06 12:02:54 +08:00
|
|
|
|
|
|
|
public:
|
2013-09-15 19:08:45 +08:00
|
|
|
Bone();
|
2013-09-16 14:13:55 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
virtual ~Bone(void);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
|
|
|
/**
|
2013-09-15 19:08:45 +08:00
|
|
|
* Initializes an empty Bone with nothing init.
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-11-05 19:53:38 +08:00
|
|
|
virtual bool init() override;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
|
|
|
/**
|
2013-09-15 19:08:45 +08:00
|
|
|
* Initializes a Bone with the specified name
|
|
|
|
* @param name Bone's name.
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-06-07 10:52:32 +08:00
|
|
|
virtual bool init(const char *name);
|
2013-06-06 12:02:54 +08:00
|
|
|
|
|
|
|
/**
|
2013-09-13 18:07:37 +08:00
|
|
|
* Add display and use displayData to init the display.
|
2013-06-06 12:02:54 +08:00
|
|
|
* If index already have a display, then replace it.
|
|
|
|
* If index is current display index, then also change display to _index
|
|
|
|
*
|
2013-06-07 10:52:32 +08:00
|
|
|
* @param displayData it include the display information, like DisplayType.
|
2013-09-15 19:08:45 +08:00
|
|
|
* If you want to create a sprite display, then create a SpriteDisplayData param
|
2013-06-06 12:02:54 +08:00
|
|
|
*
|
2013-08-01 21:40:13 +08:00
|
|
|
* @param index the index of the display you want to replace or add to
|
2013-06-06 12:02:54 +08:00
|
|
|
* -1 : append display from back
|
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
void addDisplay(DisplayData *displayData, int index);
|
2013-09-13 18:07:37 +08:00
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
void addDisplay(cocos2d::Node *display, int index);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-10-30 09:41:40 +08:00
|
|
|
void removeDisplay(int index);
|
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
void changeDisplayByIndex(int index, bool force);
|
|
|
|
|
|
|
|
/**
|
2013-09-15 19:08:45 +08:00
|
|
|
* Add a child to this bone, and it will let this child call setParent(Bone *parent) function to set self to it's parent
|
2013-09-13 18:07:37 +08:00
|
|
|
* @param child the child you want to add
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
void addChildBone(Bone *child);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
/**
|
2013-06-07 10:52:32 +08:00
|
|
|
* Set parent bone.
|
2013-09-13 18:07:37 +08:00
|
|
|
* If parent is NUll, then also remove this bone from armature.
|
2013-09-15 19:08:45 +08:00
|
|
|
* It will not set the Armature, if you want to add the bone to a Armature, you should use Armature::addBone(Bone *bone, const char* parentName).
|
2013-06-06 12:02:54 +08:00
|
|
|
*
|
2013-06-07 10:52:32 +08:00
|
|
|
* @param parent the parent bone.
|
2013-11-05 15:32:13 +08:00
|
|
|
* nullptr : remove this bone from armature
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
void setParentBone(Bone *parent);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
/**
|
2013-06-07 10:52:32 +08:00
|
|
|
* Get parent bone
|
|
|
|
* @return parent bone
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
Bone *getParentBone();
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
/**
|
2013-09-13 18:07:37 +08:00
|
|
|
* Remove itself from its parent.
|
2013-09-14 19:54:49 +08:00
|
|
|
* @param recursion whether or not to remove childBone's display
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
|
|
|
void removeFromParent(bool recursion);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
/**
|
2013-09-15 19:08:45 +08:00
|
|
|
* Removes a child Bone
|
2013-09-13 18:07:37 +08:00
|
|
|
* @param bone the bone you want to remove
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-09-15 19:08:45 +08:00
|
|
|
void removeChildBone(Bone *bone, bool recursion);
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
void update(float delta) override;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
void updateDisplayedColor(const cocos2d::Color3B &parentColor) override;
|
|
|
|
void updateDisplayedOpacity(GLubyte parentOpacity) override;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-10-30 09:41:40 +08:00
|
|
|
virtual void setColor(const cocos2d::Color3B& color) override;
|
|
|
|
virtual void setOpacity(GLubyte opacity) override;
|
|
|
|
|
2013-06-07 10:52:32 +08:00
|
|
|
//! Update color to render display
|
|
|
|
void updateColor();
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-09-13 18:07:37 +08:00
|
|
|
//! Update zorder
|
|
|
|
void updateZOrder();
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
virtual void setZOrder(int zOrder) override;
|
2013-09-13 18:07:37 +08:00
|
|
|
|
2013-09-15 19:08:45 +08:00
|
|
|
Tween *getTween();
|
2013-09-13 18:07:37 +08:00
|
|
|
|
2013-06-07 10:52:32 +08:00
|
|
|
/*
|
|
|
|
* Whether or not the bone's transform property changed. if true, the bone will update the transform.
|
|
|
|
*/
|
2013-11-05 19:53:38 +08:00
|
|
|
virtual void setTransformDirty(bool dirty) { _boneTransformDirty = dirty; }
|
|
|
|
virtual bool isTransformDirty() { return _boneTransformDirty; }
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
virtual cocos2d::AffineTransform getNodeToArmatureTransform() const;
|
|
|
|
virtual cocos2d::AffineTransform getNodeToWorldTransform() const override;
|
2013-09-13 18:07:37 +08:00
|
|
|
|
|
|
|
Node *getDisplayRenderNode();
|
2013-10-30 09:41:40 +08:00
|
|
|
DisplayType getDisplayRenderNodeType();
|
2013-09-13 18:07:37 +08:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get the ColliderBody list in this bone. The object in the Array is ColliderBody.
|
|
|
|
*/
|
2013-10-15 18:00:03 +08:00
|
|
|
virtual cocos2d::Array *getColliderBodyList();
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-01 14:36:44 +08:00
|
|
|
virtual void setColliderFilter(ColliderFilter *filter);
|
|
|
|
virtual ColliderFilter *getColliderFilter();
|
2013-11-05 19:53:38 +08:00
|
|
|
|
|
|
|
virtual void setBoneData(BoneData *boneData);
|
|
|
|
virtual BoneData *getBoneData() const;
|
|
|
|
|
|
|
|
virtual void setArmature(Armature *armature);
|
|
|
|
virtual Armature *getArmature() const;
|
|
|
|
|
|
|
|
virtual void setChildArmature(Armature *childArmature);
|
|
|
|
virtual Armature *getChildArmature() const;
|
|
|
|
|
|
|
|
virtual DisplayManager *getDisplayManager() const { return _displayManager; }
|
|
|
|
|
|
|
|
virtual void setIgnoreMovementBoneData(bool ignore) { _ignoreMovementBoneData = ignore; }
|
|
|
|
virtual bool isIgnoreMovementBoneData() const { return _ignoreMovementBoneData; }
|
|
|
|
|
2013-11-06 15:25:44 +08:00
|
|
|
/*
|
|
|
|
* This function is deprecated, please use isIgnoreMovementBoneData()
|
|
|
|
*/
|
|
|
|
CC_DEPRECATED_ATTRIBUTE virtual bool getIgnoreMovementBoneData() const { return isIgnoreMovementBoneData(); }
|
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
virtual void setBlendType(BlendType type) { _blendType = type; }
|
|
|
|
virtual BlendType getBlendType() const { return _blendType; }
|
|
|
|
|
|
|
|
virtual FrameData *getTweenData() const { return _tweenData; }
|
|
|
|
|
|
|
|
virtual void setName(const std::string &name) { _name = name; }
|
|
|
|
virtual const std::string getName() const { return _name; }
|
|
|
|
|
2013-11-06 15:25:44 +08:00
|
|
|
virtual BaseData *getWorldInfo() const { return _worldInfo; }
|
2013-11-05 19:53:38 +08:00
|
|
|
protected:
|
|
|
|
void applyParentTransform(Bone *parent);
|
|
|
|
|
2013-06-06 12:02:54 +08:00
|
|
|
/*
|
2013-09-16 12:21:18 +08:00
|
|
|
* The origin state of the Bone. Display's state is effected by _boneData, m_pNode, _tweenData
|
2013-09-15 19:08:45 +08:00
|
|
|
* when call setData function, it will copy from the BoneData.
|
2013-06-06 12:02:54 +08:00
|
|
|
*/
|
2013-11-05 19:53:38 +08:00
|
|
|
BoneData *_boneData;
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-09-15 19:08:45 +08:00
|
|
|
//! A weak reference to the Armature
|
2013-11-05 19:53:38 +08:00
|
|
|
Armature *_armature;
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-09-15 19:08:45 +08:00
|
|
|
//! A weak reference to the child Armature
|
2013-11-05 19:53:38 +08:00
|
|
|
Armature *_childArmature;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
DisplayManager *_displayManager;
|
2013-06-07 10:52:32 +08:00
|
|
|
|
|
|
|
/*
|
2013-09-15 19:08:45 +08:00
|
|
|
* When Armature play an animation, if there is not a MovementBoneData of this bone in this MovementData, this bone will be hidden.
|
2013-09-13 18:07:37 +08:00
|
|
|
* Set IgnoreMovementBoneData to true, then this bone will also be shown.
|
2013-06-07 10:52:32 +08:00
|
|
|
*/
|
2013-11-05 19:53:38 +08:00
|
|
|
bool _ignoreMovementBoneData;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
BlendType _blendType;
|
2013-10-30 09:41:40 +08:00
|
|
|
|
2013-09-16 14:56:59 +08:00
|
|
|
Tween *_tween; //! Calculate tween effect
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-09-13 18:07:37 +08:00
|
|
|
//! Used for making tween effect in every frame
|
2013-11-05 19:53:38 +08:00
|
|
|
FrameData *_tweenData;
|
2013-06-07 10:52:32 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
std::string _name;
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
Bone *_parentBone; //! A weak reference to its parent
|
2013-09-16 12:21:18 +08:00
|
|
|
bool _boneTransformDirty; //! Whether or not transform dirty
|
2013-06-07 10:52:32 +08:00
|
|
|
|
|
|
|
//! self Transform, use this to change display's state
|
2013-10-15 18:00:03 +08:00
|
|
|
cocos2d::AffineTransform _worldTransform;
|
2013-10-30 09:41:40 +08:00
|
|
|
|
2013-11-05 19:53:38 +08:00
|
|
|
BaseData *_worldInfo;
|
2013-10-30 09:41:40 +08:00
|
|
|
|
|
|
|
//! Armature's parent bone
|
|
|
|
Bone *_armatureParentBone;
|
|
|
|
|
|
|
|
//! Data version
|
|
|
|
float _dataVersion;
|
2013-06-06 12:02:54 +08:00
|
|
|
};
|
|
|
|
|
2013-10-15 18:00:03 +08:00
|
|
|
}
|
2013-06-06 12:02:54 +08:00
|
|
|
|
2013-06-07 10:52:32 +08:00
|
|
|
#endif /*__CCBONE_H__*/
|