sprite.h

/*
 * Copyright (C) 2018 Microchip Technology Inc.  All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef EGT_SPRITE_H
#define EGT_SPRITE_H
 
#include <egt/detail/meta.h>
#include <egt/window.h>
#include <memory>
 
namespace egt
{
inline namespace v1
{
class Painter;
class Image;
 
namespace detail
{
class SpriteImpl;
class SoftwareSprite;
class HardwareSprite;
}
 
class EGT_API Sprite : public Window
{
public:
 
    explicit Sprite(WindowHint hint = WindowHint::automatic);
 
    Sprite(const Image& image, const Size& frame_size,
           int frame_count, const Point& frame_point = {},
           WindowHint hint = WindowHint::automatic);
 
    explicit Sprite(Serializer::Properties& props) noexcept
        : Sprite(props, false)
    {
    }
 
protected:
 
    explicit Sprite(Serializer::Properties& props, bool is_derived) noexcept;
 
public:
 
    Sprite(const Sprite&) = delete;
    Sprite& operator=(const Sprite&) = delete;
    Sprite(Sprite&&) noexcept;
    Sprite& operator=(Sprite&&) noexcept;
 
    void draw(Painter& painter, const Rect& rect) override;
 
    void init(const Image& image, const Size& frame_size,
              int frame_count, const Point& frame_point = {});
 
    void show_frame(int index);
 
    void advance();
 
    EGT_NODISCARD bool is_last_frame() const;
 
    EGT_NODISCARD uint32_t frame_count() const;
 
    void change_strip(uint32_t id);
 
    uint32_t add_strip(int frame_count, const Point& frame_point = {});
 
    ~Sprite() noexcept override;
 
protected:
 
    void allocate_screen() override
    {
        Window::allocate_screen();
    }
 
    void create_impl(const Image& image, const Size& frame_size,
                     int frame_count, const Point& frame_point);
 
    std::unique_ptr<detail::SpriteImpl> m_simpl;
 
    friend class detail::SoftwareSprite;
    friend class detail::HardwareSprite;
};
 
}
}
 
#endif