axmol/extensions/CCArmature/CCBone.h

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

#include "utils/CCArmatureDefine.h"
#include "datas/CCDatas.h"
#include "animation/CCTween.h"
#include "external_tool/CCTexture2DMutable.h"
#include "display/CCDecorativeDisplay.h"
#include "display/CCDisplayManager.h"

namespace cocos2d { namespace extension { namespace armature {

class Armature;

class Bone : public NodeRGBA
{
public:
    /**
     * Allocates and initializes a bone.
     * @return A initialized bone which is marked as "autorelease".
     */
    static Bone *create();
    /**
     * Allocates and initializes a bone.
     *
     * @param  name If name is not null, then set name to the bone's name
     * @return A initialized bone which is marked as "autorelease".
     */
    static Bone *create(const char *name);

public:
    Bone();
    virtual ~Bone(void);

    /**
     * Initializes an empty Bone with nothing init.
     */
    virtual bool init();

    /**
     * Initializes a Bone with the specified name
     * @param name Bone's name.
     */
    virtual bool init(const char *name);

    /**
     * Add display and use  _DisplayData init the display.
     * If index already have a display, then replace it.
     * If index is current display index, then also change display to _index
     *
     * @param displayData it include the display information, like DisplayType.
     *          If you want to create a sprite display, then create a SpriteDisplayData param
     *
     * @param index the index of the display you want to replace or add to
     *          -1 : append display from back
     */
    void addDisplay(DisplayData *displayData, int index);

    void changeDisplayByIndex(int index, bool force);

    /**
     * Add a child to this bone, and it will let this child call setParent(Bone *_parent) function to set self to it's parent
     * @param child The child you want to add.
     */
    void addChildBone(Bone *child);

    /**
     * Set parent bone.
     * If _parent is NUll, then also remove this bone from armature.
     * 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).
     *
     * @param parent  the parent bone.
     *          NULL : remove this bone from armature
     */
    void setParentBone(Bone *parent);

    /**
     * Get parent bone
     * @return parent bone
     */
    Bone *getParentBone();

    /**
     * Remove itself from its parent Bone.
     * @param recursion Whether to remove Child display
     */
    void removeFromParent(bool recursion);

    /**
     * Removes a child Bone
     * @param bone  The bone you want to remove.
     */
    void removeChildBone(Bone *bone, bool recursion);

    void update(float delta);

    void updateDisplayedColor(const Color3B &parentColor);
    void updateDisplayedOpacity(GLubyte parentOpacity);

    //! Update color to render display
    void updateColor();

    Array *getChildren();
    Tween *getTween();

    virtual void setZOrder(int zOrder);
    /*
     * Whether or not the bone's transform property changed. if true, the bone will update the transform.
     */
    virtual void setTransformDirty(bool dirty);

    virtual bool isTransformDirty();

    virtual AffineTransform nodeToArmatureTransform();

public:
    /*
     *  The origin state of the Bone. Display's state is effected by _boneData, _node, _tweenData
     *  when call setData function, it will copy from the BoneData.
     */
    CC_PROPERTY(BoneData *, _boneData, BoneData);

    //! A weak reference to the Armature
    CC_PROPERTY(Armature *, _armature, Armature);

    //! A weak reference to the child Armature
    CC_PROPERTY(Armature *, _childArmature, ChildArmature);

    CC_SYNTHESIZE(DisplayManager *, _displayManager, DisplayManager)

    /*
     *	When Armature play a animation, if there is not a MovementBoneData of this bone in this MovementData, this bone will hide.
     *	Set IgnoreMovementBoneData to true, then this bone will also show.
     */
    CC_SYNTHESIZE_PASS_BY_REF(bool, _ignoreMovementBoneData, IgnoreMovementBoneData)

protected:
    Tween *_tween;				//! Calculate tween effect

    //! Used for make tween effect between every frame
    CC_SYNTHESIZE_READONLY(FrameData *, _tweenData, TweenData);

    CC_SYNTHESIZE_PASS_BY_REF(std::string, _name, Name);

    //! Lazy allocs
    void childrenAlloc(void);
    Array *_children;

    Bone *_parent;				//! A weak reference to it's parent
    bool _transformDirty;			//! Whether or not transform dirty

    //! self Transform, use this to change display's state
    AffineTransform _worldTransform;
};

}}} // namespace cocos2d { namespace extension { namespace armature {

#endif /*__CCBONE_H__*/