axmol/core/2d/AnimationCache.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.
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).

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/AnimationCache.h"
#include "2d/SpriteFrameCache.h"
#include "platform/FileUtils.h"

using namespace std;

namespace ax
{

AnimationCache* AnimationCache::s_sharedAnimationCache = nullptr;

AnimationCache* AnimationCache::getInstance()
{
    if (!s_sharedAnimationCache)
    {
        s_sharedAnimationCache = new AnimationCache();
        s_sharedAnimationCache->init();
    }

    return s_sharedAnimationCache;
}

void AnimationCache::destroyInstance()
{
    AX_SAFE_DELETE(s_sharedAnimationCache);
}

bool AnimationCache::init()
{
    return true;
}

AnimationCache::AnimationCache() {}

AnimationCache::~AnimationCache()
{
    AXLOGV("deallocing AnimationCache: {}", fmt::ptr(this));
}

void AnimationCache::addAnimation(Animation* animation, std::string_view name)
{
    _animations.insert(std::string{name}, animation);
}

void AnimationCache::removeAnimation(std::string_view name)
{
    if (name.empty())
        return;

    _animations.erase(name);
}

Animation* AnimationCache::getAnimation(std::string_view name)
{
    return _animations.at(name);
}

void AnimationCache::parseVersion1(const ValueMap& animations)
{
    SpriteFrameCache* frameCache = SpriteFrameCache::getInstance();

    for (const auto& anim : animations)
    {
        const ValueMap& animationDict = anim.second.asValueMap();
        const ValueVector& frameNames = animationDict.at("frames").asValueVector();
        float delay                   = animationDict.at("delay").asFloat();
        Animation* animation          = nullptr;

        if (frameNames.empty())
        {
            AXLOGW(
                "axmol: AnimationCache: Animation '{}' found in dictionary without any frames - cannot add to "
                "animation cache.",
                anim.first);
            continue;
        }

        ssize_t frameNameSize = frameNames.size();
        Vector<AnimationFrame*> frames(frameNameSize);

        for (auto&& frameName : frameNames)
        {
            SpriteFrame* spriteFrame = frameCache->getSpriteFrameByName(frameName.asString());

            if (!spriteFrame)
            {
                AXLOGW(
                    "axmol:AnimationCache: Animation '{}' refers to frame '{}' which is not currently in the "
                    "SpriteFrameCache. This frame will not be added to the animation.",
                    anim.first, frameName.asString());

                continue;
            }

            AnimationFrame* animFrame = AnimationFrame::create(spriteFrame, 1, ValueMap());
            frames.pushBack(animFrame);
        }

        if (frames.empty())
        {
            AXLOGW(
                "axmol:AnimationCache: None of the frames for animation '{}' were found in the SpriteFrameCache. "
                "Animation is not being added to the Animation Cache.",
                anim.first);
            continue;
        }
        else if (frames.size() != frameNameSize)
        {
            AXLOGW(
                "axmol:AnimationCache: An animation in your dictionary refers to a frame which is not in the "
                "SpriteFrameCache. Some or all of the frames for the animation '{}' may be missing.",
                anim.first);
        }

        animation = Animation::create(frames, delay, 1);

        AnimationCache::getInstance()->addAnimation(animation, anim.first);
    }
}

void AnimationCache::parseVersion2(const ValueMap& animations)
{
    SpriteFrameCache* frameCache = SpriteFrameCache::getInstance();

    for (const auto& anim : animations)
    {
        std::string name        = anim.first;
        ValueMap& animationDict = const_cast<ValueMap&>(anim.second.asValueMap());

        const Value& loops        = animationDict["loops"];
        bool restoreOriginalFrame = animationDict["restoreOriginalFrame"].asBool();

        ValueVector& frameArray = animationDict["frames"].asValueVector();

        if (frameArray.empty())
        {
            AXLOGW(
                "axmol:AnimationCache: Animation '{}' found in dictionary without any frames - cannot add to "
                "animation cache.",
                name);
            continue;
        }

        // Array of AnimationFrames
        Vector<AnimationFrame*> array(static_cast<int>(frameArray.size()));

        for (auto&& obj : frameArray)
        {
            ValueMap& entry             = obj.asValueMap();
            std::string spriteFrameName = entry["spriteframe"].asString();
            SpriteFrame* spriteFrame    = frameCache->getSpriteFrameByName(spriteFrameName);

            if (!spriteFrame)
            {
                AXLOGW(
                    "axmol:AnimationCache: Animation '{}' refers to frame '{}' which is not currently in the "
                    "SpriteFrameCache. This frame will not be added to the animation.",
                    name, spriteFrameName);

                continue;
            }

            float delayUnits = entry["delayUnits"].asFloat();
            Value& userInfo  = entry["notification"];

            AnimationFrame* animFrame = AnimationFrame::create(
                spriteFrame, delayUnits, userInfo.getType() == Value::Type::MAP ? userInfo.asValueMap() : ValueMapNull);

            array.pushBack(animFrame);
        }

        float delayPerUnit = animationDict["delayPerUnit"].asFloat();
        Animation* animation =
            Animation::create(array, delayPerUnit, loops.getType() != Value::Type::NONE ? loops.asInt() : 1);

        animation->setRestoreOriginalFrame(restoreOriginalFrame);

        AnimationCache::getInstance()->addAnimation(animation, name);
    }
}

void AnimationCache::addAnimationsWithDictionary(const ValueMap& dictionary, std::string_view plist)
{
    auto anisItr = dictionary.find("animations");
    if (anisItr == dictionary.end())
    {
        AXLOGW("axmol: AnimationCache: No animations were found in provided dictionary.");
        return;
    }

    const Value& animations = anisItr->second;
    unsigned int version    = 1;

    auto propsItr = dictionary.find("properties");
    if (propsItr != dictionary.end())
    {
        const ValueMap& properties      = propsItr->second.asValueMap();
        version                         = properties.at("format").asInt();
        const ValueVector& spritesheets = properties.at("spritesheets").asValueVector();

        for (const auto& value : spritesheets)
        {
            std::string path = FileUtils::getInstance()->fullPathFromRelativeFile(value.asString(), plist);
            SpriteFrameCache::getInstance()->addSpriteFramesWithFile(path);
        }
    }

    switch (version)
    {
    case 1:
        parseVersion1(animations.asValueMap());
        break;
    case 2:
        parseVersion2(animations.asValueMap());
        break;
    default:
        AXASSERT(false, "Invalid animation format");
    }
}

/** Read an NSDictionary from a plist file and parse it automatically for animations */
void AnimationCache::addAnimationsWithFile(std::string_view plist)
{
    AXASSERT(!plist.empty(), "Invalid texture file name");
    if (plist.empty())
    {
        AXLOGE("{} error:file name is empty!", __FUNCTION__);
        return;
    }

    ValueMap dict = FileUtils::getInstance()->getValueMapFromFile(plist);

    AXASSERT(!dict.empty(), "CCAnimationCache: File could not be found");
    if (dict.empty())
    {
        AXLOGE("AnimationCache::addAnimationsWithFile error:{} not exist!", plist);
    }

    addAnimationsWithDictionary(dict, plist);
}

}