axmol/extensions/cocostudio/ActionTimeline/Frame.cpp

/****************************************************************************
Copyright (c) 2013 cocos2d-x.org

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 "ActionTimeline/Frame.h"
#include "ActionTimeline/TimeLine.h"
#include "ActionTimeline/ActionTimeline.h"
#include "2d/SpriteFrameCache.h"
#include "2d/SpriteFrame.h"
#include <exception>
#include <iostream>

USING_NS_AX;

NS_TIMELINE_BEGIN

// Frame
Frame::Frame()
    : _frameIndex(0)
    , _tween(true)
    , _enterWhenPassed(false)
    , _tweenType(tweenfunc::TweenType::Linear)
    , _timeline(nullptr)
    , _node(nullptr)
{
    _easingParam.clear();
}

Frame::~Frame()
{
    _easingParam.clear();
}

void Frame::emitEvent()
{
    if (_timeline)
    {
        _timeline->getActionTimeline()->emitFrameEvent(this);
    }
}

void Frame::cloneProperty(Frame* frame)
{
    _frameIndex = frame->getFrameIndex();
    _tween      = frame->isTween();

    _tweenType = frame->getTweenType();
    setEasingParams(frame->getEasingParams());
}

void Frame::apply(float percent)
{
    if (!_tween)
        return;

    float tweenpercent = percent;
    if (_tweenType != tweenfunc::TWEEN_EASING_MAX && _tweenType != tweenfunc::Linear)
    {
        tweenpercent = tweenPercent(tweenpercent);
    }
    onApply(tweenpercent);
}

float Frame::tweenPercent(float percent)
{
    return tweenfunc::tweenTo(percent, _tweenType, _easingParam.data());
}

void Frame::setEasingParams(const std::vector<float>& easingParams)
{
    _easingParam.assign(easingParams.begin(), easingParams.end());
}

const std::vector<float>& Frame::getEasingParams() const
{
    return _easingParam;
}

// VisibleFrame
VisibleFrame* VisibleFrame::create()
{
    VisibleFrame* frame = new VisibleFrame();
    frame->autorelease();
    return frame;
}

VisibleFrame::VisibleFrame() : _visible(true) {}

void VisibleFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameIndex*/)
{
    if (_node)
    {
        _node->setVisible(_visible);
    }
}

Frame* VisibleFrame::clone()
{
    VisibleFrame* frame = VisibleFrame::create();
    frame->setVisible(_visible);

    frame->cloneProperty(this);

    return frame;
}

// TextureFrame
TextureFrame* TextureFrame::create()
{
    TextureFrame* frame = new TextureFrame();
    frame->autorelease();
    return frame;
}

TextureFrame::TextureFrame() : _sprite(nullptr), _textureName("") {}

void TextureFrame::setNode(Node* node)
{
    Frame::setNode(node);

    _sprite = dynamic_cast<Sprite*>(node);
}

void TextureFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameIndex*/)
{
    if (_sprite)
    {
        auto spriteBlendFunc     = _sprite->getBlendFunc();
        SpriteFrame* spriteFrame = SpriteFrameCache::getInstance()->findFrame(_textureName);

        if (spriteFrame != nullptr)
            _sprite->setSpriteFrame(spriteFrame);
        else
            _sprite->setTexture(_textureName);

        if (_sprite->getBlendFunc() != spriteBlendFunc)
            _sprite->setBlendFunc(spriteBlendFunc);
    }
}

Frame* TextureFrame::clone()
{
    TextureFrame* frame = TextureFrame::create();
    frame->setTextureName(_textureName);

    frame->cloneProperty(this);

    return frame;
}

// RotationFrame
RotationFrame* RotationFrame::create()
{
    RotationFrame* frame = new RotationFrame();
    frame->autorelease();
    return frame;
}

RotationFrame::RotationFrame() : _rotation(0) {}

void RotationFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setRotation(_rotation);

    if (_tween)
    {
        _betwennRotation = static_cast<RotationFrame*>(nextFrame)->_rotation - _rotation;
    }
}

void RotationFrame::onApply(float percent)
{
    if (nullptr != _node && _betwennRotation != 0)
    {
        float rotation = _rotation + percent * _betwennRotation;
        _node->setRotation(rotation);
    }
}

Frame* RotationFrame::clone()
{
    RotationFrame* frame = RotationFrame::create();
    frame->setRotation(_rotation);

    frame->cloneProperty(this);

    return frame;
}

// SkewFrame
SkewFrame* SkewFrame::create()
{
    SkewFrame* frame = new SkewFrame();
    frame->autorelease();
    return frame;
}

SkewFrame::SkewFrame() : _skewX(0), _skewY(0) {}

void SkewFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setSkewX(_skewX);
    _node->setSkewY(_skewY);

    if (_tween)
    {
        _betweenSkewX = static_cast<SkewFrame*>(nextFrame)->_skewX - _skewX;
        _betweenSkewY = static_cast<SkewFrame*>(nextFrame)->_skewY - _skewY;
    }
}

void SkewFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenSkewX != 0 || _betweenSkewY != 0))
    {
        float skewx = _skewX + percent * _betweenSkewX;
        float skewy = _skewY + percent * _betweenSkewY;

        _node->setSkewX(skewx);
        _node->setSkewY(skewy);
    }
}

Frame* SkewFrame::clone()
{
    SkewFrame* frame = SkewFrame::create();
    frame->setSkewX(_skewX);
    frame->setSkewY(_skewY);

    frame->cloneProperty(this);

    return frame;
}

// RotationSkewFrame
RotationSkewFrame* RotationSkewFrame::create()
{
    RotationSkewFrame* frame = new RotationSkewFrame();
    frame->autorelease();
    return frame;
}

RotationSkewFrame::RotationSkewFrame() {}

void RotationSkewFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setRotationSkewX(_skewX);
    _node->setRotationSkewY(_skewY);

    if (_tween)
    {
        _betweenSkewX = static_cast<RotationSkewFrame*>(nextFrame)->_skewX - _skewX;
        _betweenSkewY = static_cast<RotationSkewFrame*>(nextFrame)->_skewY - _skewY;
    }
}

void RotationSkewFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenSkewX != 0 || _betweenSkewY != 0))
    {
        float skewx = _skewX + percent * _betweenSkewX;
        float skewy = _skewY + percent * _betweenSkewY;

        _node->setRotationSkewX(skewx);
        _node->setRotationSkewY(skewy);
    }
}

Frame* RotationSkewFrame::clone()
{
    RotationSkewFrame* frame = RotationSkewFrame::create();
    frame->setSkewX(_skewX);
    frame->setSkewY(_skewY);

    frame->cloneProperty(this);

    return frame;
}

// PositionFrame
PositionFrame* PositionFrame::create()
{
    PositionFrame* frame = new PositionFrame();
    frame->autorelease();
    return frame;
}

PositionFrame::PositionFrame() : _position(0, 0) {}

void PositionFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setPosition(_position);

    if (_tween)
    {
        _betweenX = static_cast<PositionFrame*>(nextFrame)->_position.x - _position.x;
        _betweenY = static_cast<PositionFrame*>(nextFrame)->_position.y - _position.y;
    }
}

void PositionFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenX != 0 || _betweenY != 0))
    {
        Point p;
        p.x = _position.x + _betweenX * percent;
        p.y = _position.y + _betweenY * percent;

        _node->setPosition(p);
    }
}

Frame* PositionFrame::clone()
{
    PositionFrame* frame = PositionFrame::create();
    frame->setPosition(_position);

    frame->cloneProperty(this);

    return frame;
}

// ScaleFrame
ScaleFrame* ScaleFrame::create()
{
    ScaleFrame* frame = new ScaleFrame();
    frame->autorelease();
    return frame;
}

ScaleFrame::ScaleFrame() : _scaleX(1), _scaleY(1) {}

void ScaleFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setScaleX(_scaleX);
    _node->setScaleY(_scaleY);

    if (_tween)
    {
        _betweenScaleX = static_cast<ScaleFrame*>(nextFrame)->_scaleX - _scaleX;
        _betweenScaleY = static_cast<ScaleFrame*>(nextFrame)->_scaleY - _scaleY;
    }
}

void ScaleFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenScaleX != 0 || _betweenScaleY != 0))
    {
        float scaleX = _scaleX + _betweenScaleX * percent;
        float scaleY = _scaleY + _betweenScaleY * percent;

        _node->setScaleX(scaleX);
        _node->setScaleY(scaleY);
    }
}

Frame* ScaleFrame::clone()
{
    ScaleFrame* frame = ScaleFrame::create();
    frame->setScaleX(_scaleX);
    frame->setScaleY(_scaleY);

    frame->cloneProperty(this);

    return frame;
}

// AnchorPointFrame
AnchorPointFrame* AnchorPointFrame::create()
{
    AnchorPointFrame* frame = new AnchorPointFrame();
    frame->autorelease();
    return frame;
}

AnchorPointFrame::AnchorPointFrame() : _anchorPoint(0.5f, 0.5f) {}

void AnchorPointFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }
    if (_tween)
    {
        _betweenAnchorPoint = static_cast<AnchorPointFrame*>(nextFrame)->_anchorPoint - _anchorPoint;
    }
    _node->setAnchorPoint(_anchorPoint);
}

Frame* AnchorPointFrame::clone()
{
    AnchorPointFrame* frame = AnchorPointFrame::create();
    frame->setAnchorPoint(_anchorPoint);

    frame->cloneProperty(this);

    return frame;
}

void AnchorPointFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenAnchorPoint.x != 0 || _betweenAnchorPoint.y != 0))
    {
        auto applyAnchorP = _betweenAnchorPoint * percent + _anchorPoint;
        _node->setAnchorPoint(applyAnchorP);
    }
}

// InnerActionFrame
const std::string InnerActionFrame::AnimationAllName = "-- ALL --";

InnerActionFrame* InnerActionFrame::create()
{
    InnerActionFrame* frame = new InnerActionFrame();
    frame->autorelease();
    return frame;
}

InnerActionFrame::InnerActionFrame()
    : _innerActionType(InnerActionType::SingleFrame)
    , _startFrameIndex(0)
    , _endFrameIndex(0)
    , _singleFrameIndex(0)
    , _animationName("")
    , _enterWithName(false)
{}

void InnerActionFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    auto innerActiontimeline = static_cast<ActionTimeline*>(_node->getActionByTag(_node->getTag()));
    if (nullptr == innerActiontimeline)
        return;

    if (InnerActionType::SingleFrame == _innerActionType)
    {
        innerActiontimeline->gotoFrameAndPause(_singleFrameIndex);
        return;
    }

    int innerStart = _startFrameIndex;
    int innerEnd   = _endFrameIndex;
    if (_enterWithName)
    {
        if (_animationName == AnimationAllName)
        {
            innerStart = 0;
            innerEnd   = innerActiontimeline->getDuration();
        }
        else if (innerActiontimeline->IsAnimationInfoExists(_animationName))
        {
            AnimationInfo info = innerActiontimeline->getAnimationInfo(_animationName);
            innerStart         = info.startIndex;
            innerEnd           = info.endIndex;
        }
        else
        {
            AXLOG("Animation %s not exists!", _animationName.c_str());
        }
    }

    int duration = _timeline->getActionTimeline()->getDuration();
    int odddiff  = duration - _frameIndex - innerEnd + innerStart;
    if (odddiff < 0)
    {
        innerEnd += odddiff;
    }

    if (InnerActionType::NoLoopAction == _innerActionType)
    {
        innerActiontimeline->gotoFrameAndPlay(innerStart, innerEnd, false);
    }
    else if (InnerActionType::LoopAction == _innerActionType)
    {
        innerActiontimeline->gotoFrameAndPlay(innerStart, innerEnd, true);
    }
}

void InnerActionFrame::setStartFrameIndex(int frameIndex)
{
    if (_enterWithName)
    {
        AXLOG(" cannot set start when enter frame with name. setEnterWithName false firstly!");
        return;
    }

    _startFrameIndex = frameIndex;
}

void InnerActionFrame::setEndFrameIndex(int frameIndex)
{
    if (_enterWithName)
    {
        AXLOG(" cannot set end when enter frame with name. setEnterWithName false firstly!");
        return;
    }

    _endFrameIndex = frameIndex;
}

void InnerActionFrame::setAnimationName(std::string_view animationName)
{
    if (!_enterWithName)
    {
        AXLOG(" cannot set aniamtioname when enter frame with index. setEnterWithName true firstly!");
        return;
    }

    _animationName = animationName;
}

Frame* InnerActionFrame::clone()
{
    InnerActionFrame* frame = InnerActionFrame::create();
    frame->setInnerActionType(_innerActionType);
    frame->setSingleFrameIndex(_singleFrameIndex);
    if (_enterWithName)
    {
        frame->setEnterWithName(true);
        frame->setAnimationName(_animationName);
    }
    else
    {
        frame->setStartFrameIndex(_startFrameIndex);
        frame->setEndFrameIndex(_endFrameIndex);
    }
    frame->cloneProperty(this);

    return frame;
}

// ColorFrame
ColorFrame* ColorFrame::create()
{
    ColorFrame* frame = new ColorFrame();
    frame->autorelease();
    return frame;
}

ColorFrame::ColorFrame() : _color(Color3B(255, 255, 255)) {}

void ColorFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }
    _node->setColor(_color);

    if (_tween)
    {
        const Color3B& color = static_cast<ColorFrame*>(nextFrame)->_color;
        _betweenRed          = color.r - _color.r;
        _betweenGreen        = color.g - _color.g;
        _betweenBlue         = color.b - _color.b;
    }
}

void ColorFrame::onApply(float percent)
{
    if ((nullptr != _node) && (_betweenRed != 0 || _betweenGreen != 0 || _betweenBlue != 0))
    {
        Color3B color;
        color.r = _color.r + _betweenRed * percent;
        color.g = _color.g + _betweenGreen * percent;
        color.b = _color.b + _betweenBlue * percent;

        _node->setColor(color);
    }
}

Frame* ColorFrame::clone()
{
    ColorFrame* frame = ColorFrame::create();
    frame->setColor(_color);

    frame->cloneProperty(this);

    return frame;
}

// AlphaFrame
AlphaFrame* AlphaFrame::create()
{
    AlphaFrame* frame = new AlphaFrame();
    frame->autorelease();
    return frame;
}

AlphaFrame::AlphaFrame() : _alpha(255) {}

void AlphaFrame::onEnter(Frame* nextFrame, int /*currentFrameIndex*/)
{
    if (_node == nullptr)
    {
        return;
    }

    _node->setOpacity(_alpha);

    if (_tween)
    {
        _betweenAlpha = static_cast<AlphaFrame*>(nextFrame)->_alpha - _alpha;
    }
}

void AlphaFrame::onApply(float percent)
{
    if (nullptr != _node)
    {
        uint8_t alpha = _alpha + _betweenAlpha * percent;
        _node->setOpacity(alpha);
    }
}

Frame* AlphaFrame::clone()
{
    AlphaFrame* frame = AlphaFrame::create();
    frame->setAlpha(_alpha);
    frame->cloneProperty(this);

    return frame;
}

// EventFrame
EventFrame* EventFrame::create()
{
    EventFrame* frame = new EventFrame();
    frame->init();
    frame->autorelease();
    return frame;
}

void EventFrame::init()
{
    _enterWhenPassed = true;
}

EventFrame::EventFrame() : _event(""), _action(nullptr) {}

void EventFrame::setNode(ax::Node* node)
{
    Frame::setNode(node);
    _action = _timeline->getActionTimeline();
}

void EventFrame::onEnter(Frame* /*nextFrame*/, int currentFrameIndex)
{
    if (static_cast<int>(_frameIndex) < _action->getStartFrame() ||
        static_cast<int>(_frameIndex) > _action->getEndFrame())
        return;

    if (currentFrameIndex >= static_cast<int>(_frameIndex))
        emitEvent();
}

Frame* EventFrame::clone()
{
    EventFrame* frame = EventFrame::create();
    frame->setEvent(_event);

    frame->cloneProperty(this);

    return frame;
}

// ZOrderFrame
ZOrderFrame* ZOrderFrame::create()
{
    ZOrderFrame* frame = new ZOrderFrame();
    frame->autorelease();
    return frame;
}

ZOrderFrame::ZOrderFrame() : _zorder(0) {}

void ZOrderFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameIndex*/)
{
    if (_node)
        _node->setLocalZOrder(_zorder);
}

Frame* ZOrderFrame::clone()
{
    ZOrderFrame* frame = ZOrderFrame::create();
    frame->setZOrder(_zorder);

    frame->cloneProperty(this);

    return frame;
}

// BlendFuncFrame
BlendFuncFrame* BlendFuncFrame::create()
{
    BlendFuncFrame* frame = new BlendFuncFrame();
    frame->autorelease();
    return frame;
}

BlendFuncFrame::BlendFuncFrame() : _blendFunc(BlendFunc::ALPHA_PREMULTIPLIED) {}

void BlendFuncFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameIndex*/)
{
    if (_node)
    {
        auto blendnode = dynamic_cast<BlendProtocol*>(_node);
        if (blendnode)
            blendnode->setBlendFunc(_blendFunc);
    }
}

Frame* BlendFuncFrame::clone()
{
    BlendFuncFrame* frame = BlendFuncFrame::create();
    frame->setBlendFunc(_blendFunc);
    frame->cloneProperty(this);

    return frame;
}

// PlayableFrame
const std::string PlayableFrame::START_ACT          = "start";
const std::string PlayableFrame::STOP_ACT           = "stop";
const std::string PlayableFrame::PLAYABLE_EXTENTION = "playable_extension";
PlayableFrame* PlayableFrame::create()
{
    auto frame = new PlayableFrame();
    frame->autorelease();
    return frame;
}

PlayableFrame::PlayableFrame() : _playableAct("") {}

void PlayableFrame::onEnter(Frame* /*nextFrame*/, int /*currentFrameINdex*/)
{
    auto playableNode = dynamic_cast<PlayableProtocol*>(_node);
    if (nullptr == playableNode)  // may be a playable component
        playableNode = dynamic_cast<PlayableProtocol*>(_node->getComponent(PLAYABLE_EXTENTION));
    if (nullptr == playableNode)
        return;

    if (_playableAct == START_ACT)
        playableNode->start();
    else if (_playableAct == STOP_ACT)
        playableNode->stop();
}

Frame* PlayableFrame::clone()
{
    PlayableFrame* frame = PlayableFrame::create();
    frame->cloneProperty(this);
    frame->setPlayableAct(_playableAct);
    return frame;
}
NS_TIMELINE_END