Magic_Game/src/kiwano/2d/GifSprite.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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.

#pragma once
#include <kiwano/2d/Actor.h>
#include <kiwano/core/Resource.h>
#include <kiwano/render/GifImage.h>
#include <kiwano/render/RenderContext.h>

namespace kiwano
{
KGE_DECLARE_SMART_PTR(GifSprite);

/**
 * \addtogroup Actors
 * @{
 */

/**
 * \~chinese
 * @brief GIF <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API GifSprite : public Actor
{
public:
    /// \~chinese
    /// @brief GIF<49><46><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD>
    using LoopDoneCallback = Function<void(int /* times */)>;

    /// \~chinese
    /// @brief GIF<49><46><EFBFBD>Ž<EFBFBD><C5BD><EFBFBD><EFBFBD>ص<EFBFBD>
    using DoneCallback = Function<void()>;

    GifSprite();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIF<49><46><EFBFBD><EFBFBD>
    /// @param file_path GIFͼƬ·<C6AC><C2B7>
    GifSprite(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIF<49><46><EFBFBD><EFBFBD>
    /// @param res GIFͼƬ<CDBC><C6AC>Դ
    GifSprite(const Resource& res);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIF<49><46><EFBFBD><EFBFBD>
    /// @param gif GIFͼƬ
    GifSprite(GifImagePtr gif);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼƬ
    /// @param file_path GIFͼƬ·<C6AC><C2B7>
    bool Load(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼƬ
    /// @param res GIFͼƬ<CDBC><C6AC>Դ
    bool Load(const Resource& res);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>GIFͼƬ
    /// @param gif GIFͼƬ
    bool Load(GifImagePtr gif);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD> GIF <20><><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void SetLoopCount(int loops);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD> GIF <20><><EFBFBD><EFBFBD>ÿ<EFBFBD><C3BF>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    void SetLoopDoneCallback(const LoopDoneCallback& cb);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD> GIF <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    void SetDoneCallback(const DoneCallback& cb);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD> GIF ͼ<><CDBC>
    void SetGifImage(GifImagePtr gif);

    /// \~chinese
    /// @brief <20><><EFBFBD>²<EFBFBD><C2B2><EFBFBD> GIF <20><><EFBFBD><EFBFBD>
    void RestartAnimation();

    /// \~chinese
    /// @brief <20><>ȡ GIF <20><><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD>
    LoopDoneCallback GetLoopDoneCallback() const;

    /// \~chinese
    /// @brief <20><>ȡ GIF <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ž<EFBFBD><C5BD><EFBFBD><EFBFBD>ص<EFBFBD>
    DoneCallback GetDoneCallback() const;

    /// \~chinese
    /// @brief <20><>ȡ GIF ͼƬ
    GifImagePtr GetGifImage() const;

    void OnRender(RenderContext& ctx) override;

private:
    void Update(Duration dt) override;

    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ֡
    bool IsLastFrame() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7>ѽ<EFBFBD><D1BD><EFBFBD>
    bool EndOfAnimation() const;

    /// \~chinese
    /// @brief <20>ϳ<EFBFBD><CFB3><EFBFBD>һ֡
    void ComposeNextFrame();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ǰͼ<C7B0><CDBC>֡
    void DisposeCurrentFrame();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ֡
    void OverlayNextFrame();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ϳɺ<CFB3><C9BA><EFBFBD>ͼ<EFBFBD><CDBC>֡
    void SaveComposedFrame();

    /// \~chinese
    /// @brief <20>ָ<EFBFBD><D6B8>ѱ<EFBFBD><D1B1><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>֡
    void RestoreSavedFrame();

    /// \~chinese
    /// @brief <20><><EFBFBD>յ<EFBFBD>ǰͼ<C7B0><CDBC><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void ClearCurrentFrameArea();

private:
    bool             animating_;
    int              total_loop_count_;
    int              loop_count_;
    size_t           next_index_;
    Duration         frame_elapsed_;
    LoopDoneCallback loop_cb_;
    DoneCallback     done_cb_;
    GifImagePtr      gif_;
    GifImage::Frame  frame_;
    TexturePtr       saved_frame_;
    TexturePtr       frame_to_render_;
    RenderContextPtr frame_rt_;
};

/** @} */

inline void GifSprite::SetLoopCount(int loops)
{
    total_loop_count_ = loops;
}

inline void GifSprite::SetLoopDoneCallback(const LoopDoneCallback& cb)
{
    loop_cb_ = cb;
}

inline void GifSprite::SetDoneCallback(const DoneCallback& cb)
{
    done_cb_ = cb;
}

inline GifSprite::LoopDoneCallback GifSprite::GetLoopDoneCallback() const
{
    return loop_cb_;
}

inline GifSprite::DoneCallback GifSprite::GetDoneCallback() const
{
    return done_cb_;
}

inline GifImagePtr GifSprite::GetGifImage() const
{
    return gif_;
}

inline bool GifSprite::IsLastFrame() const
{
    return (next_index_ == 0);
}

inline bool GifSprite::EndOfAnimation() const
{
    return IsLastFrame() && loop_count_ == total_loop_count_ + 1;
}
}  // namespace kiwano