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
{
 
class KGE_API GifSprite : public Actor
{
public:
    using LoopDoneCallback = Function<void(int /* times */)>;
 
    using DoneCallback = Function<void()>;
 
    GifSprite();
 
    GifSprite(StringView file_path);
 
    GifSprite(const Resource& res);
 
    GifSprite(RefPtr<GifImage> gif);
 
    bool Load(StringView file_path);
 
    bool Load(const Resource& res);
 
    bool Load(RefPtr<GifImage> gif);
 
    void SetLoopCount(int loops);
 
    void SetLoopDoneCallback(const LoopDoneCallback& cb);
 
    void SetDoneCallback(const DoneCallback& cb);
 
    void SetGifImage(RefPtr<GifImage> gif);
 
    void RestartAnimation();
 
    LoopDoneCallback GetLoopDoneCallback() const;
 
    DoneCallback GetDoneCallback() const;
 
    RefPtr<GifImage> GetGifImage() const;
 
    void OnRender(RenderContext& ctx) override;
 
private:
    void Update(Duration dt) override;
 
    bool IsLastFrame() const;
 
    bool EndOfAnimation() const;
 
    void ComposeNextFrame();
 
    void DisposeCurrentFrame();
 
    void OverlayNextFrame();
 
    void SaveComposedFrame();
 
    void RestoreSavedFrame();
 
    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_;
    RefPtr<GifImage>      gif_;
    GifImage::Frame       frame_;
    RefPtr<Texture>       saved_frame_;
    RefPtr<Texture>       frame_to_render_;
    RefPtr<RenderContext> 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 RefPtr<GifImage> 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