axmol/core/2d/ParallaxNode.cpp

/****************************************************************************
Copyright (c) 2008-2010 Ricardo Quesada
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2011      Zynga Inc.
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

https://axmol.dev/

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 "2d/ParallaxNode.h"

NS_AX_BEGIN

class PointObject : public Object
{
public:
    static PointObject* create(Vec2 ratio, Vec2 offset)
    {
        PointObject* ret = new PointObject();
        ret->initWithPoint(ratio, offset);
        ret->autorelease();
        return ret;
    }

    bool initWithPoint(Vec2 ratio, Vec2 offset)
    {
        _ratio  = ratio;
        _offset = offset;
        _child  = nullptr;
        return true;
    }

    const Vec2& getRatio() const { return _ratio; }
    void setRatio(const Vec2& ratio) { _ratio = ratio; }

    const Vec2& getOffset() const { return _offset; }
    void setOffset(const Vec2& offset) { _offset = offset; }

    Node* getChild() const { return _child; }
    void setChild(Node* child) { _child = child; }

private:
    Vec2 _ratio;
    Vec2 _offset;
    Node* _child;  // weak ref
};

ParallaxNode::ParallaxNode()
{
    _parallaxArray.reserve(5);
    _lastPosition.set(-100.0f, -100.0f);
}

ParallaxNode::~ParallaxNode()
{
}

ParallaxNode* ParallaxNode::create()
{
    ParallaxNode* ret = new ParallaxNode();
    ret->autorelease();
    return ret;
}

void ParallaxNode::addChild(Node* /*child*/, int /*zOrder*/, int /*tag*/)
{
    AXASSERT(0, "ParallaxNode: use addChild:z:parallaxRatio:positionOffset instead");
}

void ParallaxNode::addChild(Node* /*child*/, int /*zOrder*/, std::string_view /*name*/)
{
    AXASSERT(0, "ParallaxNode: use addChild:z:parallaxRatio:positionOffset instead");
}

void ParallaxNode::addChild(Node* child, int z, const Vec2& ratio, const Vec2& offset)
{
    AXASSERT(child != nullptr, "Argument must be non-nil");
    PointObject* obj = PointObject::create(ratio, offset);
    obj->setChild(child);
    _parallaxArray.pushBack(obj);

    Vec2 pos = this->absolutePosition();
    pos.x    = -pos.x + pos.x * ratio.x + offset.x;
    pos.y    = -pos.y + pos.y * ratio.y + offset.y;
    child->setPosition(pos);

    Node::addChild(child, z, child->getName());
}

void ParallaxNode::removeChild(Node* child, bool cleanup)
{
    for (auto iter = _parallaxArray.begin(); iter != _parallaxArray.end(); ++iter)
    {
        PointObject* point = (PointObject*)*iter;
        if (point->getChild() == child)
        {
            _parallaxArray.erase(iter);
            break;
        }
    }
    Node::removeChild(child, cleanup);
}

void ParallaxNode::removeAllChildrenWithCleanup(bool cleanup)
{
    _parallaxArray.clear();
    Node::removeAllChildrenWithCleanup(cleanup);
}

Vec2 ParallaxNode::absolutePosition()
{
    Vec2 ret = _position;
    Node* cn = this;
    while (cn->getParent() != nullptr)
    {
        cn  = cn->getParent();
        ret = ret + cn->getPosition();
    }
    return ret;
}

/*
The positions are updated at visit because:
- using a timer is not guaranteed that it will called after all the positions were updated
- overriding "draw" will only precise if the children have a z > 0
*/
void ParallaxNode::visit(Renderer* renderer, const Mat4& parentTransform, uint32_t parentFlags)
{
    //    Vec2 pos = position_;
    //    Vec2    pos = [self convertToWorldSpace:Vec2::ZERO];
    Vec2 pos = this->absolutePosition();
    if (!pos.equals(_lastPosition))
    {
        for (auto item : _parallaxArray)
        {
            auto point = static_cast<PointObject*>(item);
            float x            = -pos.x + pos.x * point->getRatio().x + point->getOffset().x;
            float y            = -pos.y + pos.y * point->getRatio().y + point->getOffset().y;
            point->getChild()->setPosition(x, y);
        }
        _lastPosition = pos;
    }
    Node::visit(renderer, parentTransform, parentFlags);
}

NS_AX_END