Animation.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * 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 GF_ANIMATION_H
#define GF_ANIMATION_H

#include <cstddef>
#include <vector>

#include "GraphicsApi.h"
#include "Rect.h"
#include "Time.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class Texture;

  class GF_GRAPHICS_API Animation {
  public:
    Animation();

    void addFrame(const Texture& texture, const RectF& bounds, Time duration);

    void addTileset(const Texture& texture, Vector2f frameSize, Vector2i layout, int frames, Time duration);

    void setLoop(bool enabled);

    const Texture& getCurrentTexture() const;

    RectF getCurrentBounds() const;

    bool update(Time time);

    void reset();

  private:
    struct Frame {
      const Texture *texture;
      RectF bounds;
      Time duration;
    };

    std::size_t m_currentFrame;
    Time m_currentDurationInFrame;
    std::vector<Frame> m_frames;
    bool m_loop;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_ANIMATION_H