anim_frame.hpp

Go to the documentation of this file.

#pragma once
 
#include <optional>
#include <string>
#include <vector>
 
#include "porytiles/domain/models/palette.hpp"
#include "porytiles/domain/models/pixel_tile.hpp"
#include "porytiles/domain/models/rgba32.hpp"
#include "porytiles/domain/models/supports_transparency.hpp"
 
namespace porytiles {
 
template <SupportsTransparency PixelType>
class AnimFrame {
  public:
    AnimFrame() = default;
 
    explicit AnimFrame(std::string frame_name) : frame_name_{std::move(frame_name)} {}
 
    AnimFrame(std::string frame_name, std::vector<PixelTile<PixelType>> tiles)
        : frame_name_{std::move(frame_name)}, tiles_{std::move(tiles)}
    {
    }
 
    [[nodiscard]] const std::string &frame_name() const
    {
        return frame_name_;
    }
 
    void frame_name(std::string name)
    {
        frame_name_ = std::move(name);
    }
 
    [[nodiscard]] const std::vector<PixelTile<PixelType>> &tiles() const
    {
        return tiles_;
    }
 
    void tiles(std::vector<PixelTile<PixelType>> t)
    {
        tiles_ = std::move(t);
    }
 
    void add_tile(PixelTile<PixelType> tile)
    {
        tiles_.push_back(std::move(tile));
    }
 
    [[nodiscard]] std::size_t tile_count() const
    {
        return tiles_.size();
    }
 
    // @pre: index must be less than tile_count()
    [[nodiscard]] const PixelTile<PixelType> &tile_at(std::size_t index) const
    {
        return tiles_.at(index);
    }
 
    [[nodiscard]] bool has_palette() const
    {
        return palette_.has_value();
    }
 
    [[nodiscard]] const Palette<Rgba32> &palette() const
    {
        return palette_.value();
    }
 
    void palette(Palette<Rgba32> pal)
    {
        palette_ = std::move(pal);
    }
 
  private:
    /*
     * Note: Frame dimensions (width/height in tiles) are stored in AnimParams since all frames in an animation
     * must share the same dimensions.
     */
    std::string frame_name_;
    std::vector<PixelTile<PixelType>> tiles_;
    std::optional<Palette<Rgba32>> palette_;
};
 
} // namespace porytiles