FrameAnimation.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/animation/TweenAnimation.h>
#include <kiwano/render/Bitmap.h>
 
namespace kiwano
{
 
struct KGE_API SpriteFrame
{
    SpriteFrame() = default;
 
    explicit SpriteFrame(RefPtr<Image> image, const Rect& src_rect = Rect(), bool reset_sprite_size = true);
 
    inline static Vector<SpriteFrame> SplitBitmap(RefPtr<Bitmap> bitmap, int cols, int rows, int max_num = -1,
                                                  float padding_x = 0, float padding_y = 0)
    {
        return SpriteFrame::SplitBitmap(bitmap, Rect(Point(), bitmap->GetSize()), cols, rows, max_num, padding_x,
                                        padding_y);
    }
 
    static Vector<SpriteFrame> SplitBitmap(RefPtr<Bitmap> bitmap, const Rect& src_rect, int cols, int rows,
                                           int max_num = -1, float padding_x = 0, float padding_y = 0);
 
    bool           reset_sprite_size = true;
    RefPtr<Image>  image;
    RefPtr<Bitmap> bitmap;
    Rect           src_rect;
};
 
struct KGE_API FrameSequence
{
    FrameSequence() = default;
 
    inline FrameSequence(Duration dur, const Vector<SpriteFrame>& frames)
        : duration(dur)
        , frames(frames)
    {
    }
 
    FrameSequence Reverse() const;
 
    Duration            duration;
    Vector<SpriteFrame> frames;
};
 
class KGE_API FrameAnimation : public TweenAnimation
{
public:
    FrameAnimation();
 
    explicit FrameAnimation(const Vector<FrameSequence>& frame_seq_list);
 
    const Vector<FrameSequence>& GetFrameSequences() const;
 
    const FrameSequence& GetCurrentFrameSequence() const;
 
    void SetFrameSequences(const Vector<FrameSequence>& frame_seq_list);
 
    FrameAnimation* Clone() const override;
 
    FrameAnimation* Reverse() const override;
 
protected:
    void Init(Actor* target) override;
 
    void UpdateTween(Actor* target, float percent) override;
 
    void SetTargetFrame(Actor* target, const SpriteFrame& frame);
 
private:
    size_t                current_index_;
    Vector<float>         progress_;
    Vector<FrameSequence> frame_seq_list_;
};
 
inline const Vector<FrameSequence>& FrameAnimation::GetFrameSequences() const
{
    return frame_seq_list_;
}
 
inline const FrameSequence& FrameAnimation::GetCurrentFrameSequence() const
{
    return frame_seq_list_[current_index_];
}
 
}  // namespace kiwano