axmol/extensions/cocostudio/Bone.cpp

/****************************************************************************
Copyright (c) 2013-2017 Chukong Technologies Inc.
Copyright (c) 2021 Bytedance Inc.

https://axmolengine.github.io/

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

#include "Bone.h"
#include "Armature.h"
#include "ArmatureDataManager.h"
#include "TransformHelp.h"
#include "DisplayManager.h"

USING_NS_AX;

namespace cocostudio
{

Bone* Bone::create()
{

    Bone* pBone = new Bone();
    if (pBone->init())
    {
        pBone->autorelease();
        return pBone;
    }
    AX_SAFE_DELETE(pBone);
    return nullptr;
}

Bone* Bone::create(std::string_view name)
{

    Bone* pBone = new Bone();
    if (pBone->init(name))
    {
        pBone->autorelease();
        return pBone;
    }
    AX_SAFE_DELETE(pBone);
    return nullptr;
}

Bone::Bone()
    : _tweenData(nullptr)
    , _parentBone(nullptr)
    , _armature(nullptr)
    , _childArmature(nullptr)
    , _boneData(nullptr)
    , _tween(nullptr)
    , _displayManager(nullptr)
    , _ignoreMovementBoneData(false)
    , _worldTransform(Mat4::IDENTITY)
    , _boneTransformDirty(true)
    , _blendFunc(BlendFunc::ALPHA_PREMULTIPLIED)
    , _blendDirty(false)
    , _worldInfo(nullptr)
    , _armatureParentBone(nullptr)
    , _dataVersion(0)
{}

Bone::~Bone(void)
{
    AX_SAFE_DELETE(_tweenData);
    AX_SAFE_DELETE(_tween);
    AX_SAFE_DELETE(_displayManager);
    AX_SAFE_DELETE(_worldInfo);

    AX_SAFE_RELEASE_NULL(_boneData);

    AX_SAFE_RELEASE(_childArmature);
}

bool Bone::init()
{
    return Bone::init(hlookup::empty_sv);
}

bool Bone::init(std::string_view name)
{
    bool bRet = false;
    do
    {

        _name = name;

        AX_SAFE_DELETE(_tweenData);
        _tweenData = new FrameData();

        AX_SAFE_DELETE(_tween);
        _tween = new Tween();
        _tween->init(this);

        AX_SAFE_DELETE(_displayManager);
        _displayManager = new DisplayManager();
        _displayManager->init(this);

        AX_SAFE_DELETE(_worldInfo);
        _worldInfo = new BaseData();

        AX_SAFE_DELETE(_boneData);
        _boneData = new BoneData();

        bRet = true;
    } while (0);

    return bRet;
}

void Bone::setBoneData(BoneData* boneData)
{
    AXASSERT(nullptr != boneData, "_boneData must not be nullptr");

    if (_boneData != boneData)
    {
        AX_SAFE_RETAIN(boneData);
        AX_SAFE_RELEASE(_boneData);
        _boneData = boneData;
    }

    _name = _boneData->name;
    _setLocalZOrder(_boneData->zOrder);

    _displayManager->initDisplayList(boneData);
}

BoneData* Bone::getBoneData() const
{
    return _boneData;
}

void Bone::setArmature(Armature* armature)
{
    _armature = armature;
    if (_armature)
    {
        _tween->setAnimation(_armature->getAnimation());
        _dataVersion        = _armature->getArmatureData()->dataVersion;
        _armatureParentBone = _armature->getParentBone();
    }
    else
    {
        _armatureParentBone = nullptr;
    }
}

Armature* Bone::getArmature() const
{
    return _armature;
}

void Bone::update(float delta)
{
    if (_parentBone)
        _boneTransformDirty = _boneTransformDirty || _parentBone->isTransformDirty();

    if (_armatureParentBone && !_boneTransformDirty)
    {
        _boneTransformDirty = _armatureParentBone->isTransformDirty();
    }

    if (_boneTransformDirty)
    {
        _worldInfo->copy(_tweenData);
        if (_dataVersion >= VERSION_COMBINED)
        {
            TransformHelp::nodeConcat(*_worldInfo, *_boneData);
            _worldInfo->scaleX -= 1;
            _worldInfo->scaleY -= 1;
        }

        _worldInfo->x      = _worldInfo->x + _position.x;
        _worldInfo->y      = _worldInfo->y + _position.y;
        _worldInfo->scaleX = _worldInfo->scaleX * _scaleX;
        _worldInfo->scaleY = _worldInfo->scaleY * _scaleY;
        _worldInfo->skewX  = _worldInfo->skewX + _skewX + AX_DEGREES_TO_RADIANS(_rotationZ_X);
        _worldInfo->skewY  = _worldInfo->skewY + _skewY - AX_DEGREES_TO_RADIANS(_rotationZ_Y);

        if (_parentBone)
        {
            applyParentTransform(_parentBone);
        }
        else
        {
            if (_armatureParentBone)
            {
                applyParentTransform(_armatureParentBone);
            }
        }

        TransformHelp::nodeToMatrix(*_worldInfo, _worldTransform);

        if (_armatureParentBone)
        {
            _worldTransform = TransformConcat(_worldTransform, _armature->getNodeToParentTransform());
        }
    }

    DisplayFactory::updateDisplay(this, delta, _boneTransformDirty || _armature->getArmatureTransformDirty());

    for (const auto& obj : _children)
    {
        Bone* childBone = static_cast<Bone*>(obj);
        childBone->update(delta);
    }

    _boneTransformDirty = false;
}

void Bone::applyParentTransform(Bone* parent)
{
    float x            = _worldInfo->x;
    float y            = _worldInfo->y;
    _worldInfo->x      = x * parent->_worldTransform.m[0] + y * parent->_worldTransform.m[4] + parent->_worldInfo->x;
    _worldInfo->y      = x * parent->_worldTransform.m[1] + y * parent->_worldTransform.m[5] + parent->_worldInfo->y;
    _worldInfo->scaleX = _worldInfo->scaleX * parent->_worldInfo->scaleX;
    _worldInfo->scaleY = _worldInfo->scaleY * parent->_worldInfo->scaleY;
    _worldInfo->skewX  = _worldInfo->skewX + parent->_worldInfo->skewX;
    _worldInfo->skewY  = _worldInfo->skewY + parent->_worldInfo->skewY;
}

void Bone::setBlendFunc(const BlendFunc& blendFunc)
{
    if (_blendFunc.src != blendFunc.src || _blendFunc.dst != blendFunc.dst)
    {
        _blendFunc  = blendFunc;
        _blendDirty = true;
    }
}

void Bone::updateDisplayedColor(const Color3B& parentColor)
{
#ifdef AX_STUDIO_ENABLED_VIEW
    _realColor = Color3B(255, 255, 255);
#endif  // AX_STUDIO_ENABLED_VIEW
    Node::updateDisplayedColor(parentColor);
}

void Bone::updateDisplayedOpacity(uint8_t parentOpacity)
{
#ifdef AX_STUDIO_ENABLED_VIEW
    _realOpacity = 255;
#endif  // AX_STUDIO_ENABLED_VIEW
    Node::updateDisplayedOpacity(parentOpacity);
}

void Bone::updateColor()
{
    Node* display = _displayManager->getDisplayRenderNode();
    if (display != nullptr)
    {
        display->setColor(Color3B(_displayedColor.r * _tweenData->r / 255, _displayedColor.g * _tweenData->g / 255,
                                  _displayedColor.b * _tweenData->b / 255));
        display->setOpacity(_displayedOpacity * _tweenData->a / 255);
    }
}

void Bone::updateZOrder()
{
    if (_dataVersion >= VERSION_COMBINED)
    {
        int zorder = _tweenData->zOrder + _boneData->zOrder;
        setLocalZOrder(zorder);
    }
    else
    {
        setLocalZOrder(_tweenData->zOrder);
    }
}

void Bone::addChildBone(Bone* child)
{
    AXASSERT(nullptr != child, "Argument must be non-nil");
    AXASSERT(nullptr == child->_parentBone, "child already added. It can't be added again");

    if (_children.empty())
    {
        _children.reserve(4);
    }

    if (_children.getIndex(child) == AX_INVALID_INDEX)
    {
        _children.pushBack(child);
        child->setParentBone(this);
    }
}

void Bone::removeChildBone(Bone* bone, bool recursion)
{
    if (!_children.empty() && _children.getIndex(bone) != AX_INVALID_INDEX)
    {
        if (recursion)
        {
            auto ccbones = bone->_children;

            for (auto&& object : ccbones)
            {
                Bone* ccBone = static_cast<Bone*>(object);
                bone->removeChildBone(ccBone, recursion);
            }
        }

        bone->setParentBone(nullptr);

        bone->getDisplayManager()->setCurrentDecorativeDisplay(nullptr);

        _children.eraseObject(bone);
    }
}

void Bone::removeFromParent(bool recursion)
{
    if (nullptr != _parentBone)
    {
        _parentBone->removeChildBone(this, recursion);
    }
}

void Bone::setParentBone(Bone* parent)
{
    _parentBone = parent;
}

Bone* Bone::getParentBone()
{
    return _parentBone;
}

void Bone::setChildArmature(Armature* armature)
{
    if (_childArmature != armature)
    {
        if (armature == nullptr && _childArmature)
        {
            _childArmature->setParentBone(nullptr);
        }

        AX_SAFE_RETAIN(armature);
        AX_SAFE_RELEASE(_childArmature);
        _childArmature = armature;
    }
}

Armature* Bone::getChildArmature() const
{
    return _childArmature;
}

Tween* Bone::getTween()
{
    return _tween;
}

void Bone::setLocalZOrder(int zOrder)
{
    if (getLocalZOrder() != zOrder)
        Node::setLocalZOrder(zOrder);
}

Mat4 Bone::getNodeToArmatureTransform() const
{
    return _worldTransform;
}

Mat4 Bone::getNodeToWorldTransform() const
{
    return TransformConcat(_worldTransform, _armature->getNodeToWorldTransform());
}

Node* Bone::getDisplayRenderNode()
{
    return _displayManager->getDisplayRenderNode();
}

DisplayType Bone::getDisplayRenderNodeType()
{
    return _displayManager->getDisplayRenderNodeType();
}

void Bone::addDisplay(DisplayData* displayData, int index)
{
    _displayManager->addDisplay(displayData, index);
}

void Bone::addDisplay(Node* display, int index)
{
    _displayManager->addDisplay(display, index);
}

void Bone::removeDisplay(int index)
{
    _displayManager->removeDisplay(index);
}

void Bone::changeDisplayByIndex(int index, bool force)
{
    changeDisplayWithIndex(index, force);
}

void Bone::changeDisplayByName(std::string_view name, bool force)
{
    changeDisplayWithName(name, force);
}

void Bone::changeDisplayWithIndex(int index, bool force)
{
    _displayManager->changeDisplayWithIndex(index, force);
}

void Bone::changeDisplayWithName(std::string_view name, bool force)
{
    _displayManager->changeDisplayWithName(name, force);
}

ColliderDetector* Bone::getColliderDetector() const
{
    if (DecorativeDisplay* decoDisplay = _displayManager->getCurrentDecorativeDisplay())
    {
        if (ColliderDetector* detector = decoDisplay->getColliderDetector())
        {
            return detector;
        }
    }
    return nullptr;
}

#if ENABLE_PHYSICS_BOX2D_DETECT || ENABLE_PHYSICS_CHIPMUNK_DETECT
void Bone::setColliderFilter(ColliderFilter* filter)
{
    auto array = _displayManager->getDecorativeDisplayList();

    for (auto&& object : array)
    {
        DecorativeDisplay* decoDisplay = static_cast<DecorativeDisplay*>(object);
        if (ColliderDetector* detector = decoDisplay->getColliderDetector())
        {
            detector->setColliderFilter(filter);
        }
    }
}
ColliderFilter* Bone::getColliderFilter()
{
    if (DecorativeDisplay* decoDisplay = _displayManager->getCurrentDecorativeDisplay())
    {
        if (ColliderDetector* detector = decoDisplay->getColliderDetector())
        {
            return detector->getColliderFilter();
        }
    }
    return nullptr;
}
#endif

}  // namespace cocostudio