animator.hpp

Go to the documentation of this file.

/*
  Wizard Engine
  Copyright (C) 2023-2024 Zana Domán
 
  This software is provided 'as-is', without any express or implied
  warranty. In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#ifndef WIZARD_ENGINE_ANIMATOR_HPP
#define WIZARD_ENGINE_ANIMATOR_HPP
 
#include <wizard_engine/animatable.hpp>
#include <wizard_engine/assets.hpp>
#include <wizard_engine/export.hpp>
 
namespace wze {
class animator final {
  public:
    explicit animator(
        std::vector<std::pair<std::shared_ptr<texture>, uint16_t>> const&
            frames = {},
        std::vector<std::weak_ptr<animatable>> const& targets = {});
 
    [[nodiscard]] std::vector<
        std::pair<std::shared_ptr<texture>, uint16_t>> const&
    frames() const;
 
    [[nodiscard]] std::vector<std::pair<std::shared_ptr<texture>, uint16_t>>&
    frames();
 
    [[nodiscard]] std::vector<std::weak_ptr<animatable>> const& targets() const;
 
    [[nodiscard]] std::vector<std::weak_ptr<animatable>>& targets();
 
    [[nodiscard]] size_t current_frame() const;
 
    void set_current_frame(size_t current_frame);
 
    bool play();
 
    void reset();
 
  private:
    std::vector<std::pair<std::shared_ptr<texture>, uint16_t>> _frames;
    std::vector<std::weak_ptr<animatable>> _targets;
    size_t _current_frame;
    uint16_t _remaining_time;
};
} /* namespace wze */
 
#endif /* WIZARD_ENGINE_ANIMATOR_HPP */