tile2x2.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/stdint.h"
 
#include "fl/math/geometry.h"
#include "fl/stl/pair.h"
#include "fl/stl/span.h"
#include "fl/math/xymap.h"
#include "fl/stl/vector.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
 
class XYMap;  // IWYU pragma: keep
class XYRasterU8Sparse;
 
class Tile2x2_u8 {
 
  public:
    static void Rasterize(const span<const Tile2x2_u8> &tiles,
                          XYRasterU8Sparse *output) FL_NO_EXCEPT;
 
    Tile2x2_u8() FL_NO_EXCEPT = default;
    Tile2x2_u8(const vec2<u16> &origin) FL_NO_EXCEPT : mOrigin(origin) {}
    Tile2x2_u8(const Tile2x2_u8 &) FL_NO_EXCEPT = default;
    Tile2x2_u8 &operator=(const Tile2x2_u8 &) FL_NO_EXCEPT = default;
    Tile2x2_u8(Tile2x2_u8 &&) FL_NO_EXCEPT = default;
 
    void scale(u8 scale) FL_NO_EXCEPT;
 
    void setOrigin(u16 x, u16 y) FL_NO_EXCEPT { mOrigin = vec2<u16>(x, y); }
 
    u8 &operator()(int x, int y) FL_NO_EXCEPT { return at(x, y); }
    u8 &at(int x, int y) FL_NO_EXCEPT { return mTile[y][x]; }
    const u8 &at(int x, int y) const FL_NO_EXCEPT { return mTile[y][x]; }
 
    u8 &lower_left() FL_NO_EXCEPT { return at(0, 0); }
    u8 &upper_left() FL_NO_EXCEPT { return at(0, 1); }
    u8 &lower_right() FL_NO_EXCEPT { return at(1, 0); }
    u8 &upper_right() FL_NO_EXCEPT { return at(1, 1); }
 
    const u8 &lower_left() const FL_NO_EXCEPT { return at(0, 0); }
    const u8 &upper_left() const FL_NO_EXCEPT { return at(0, 1); }
    const u8 &lower_right() const FL_NO_EXCEPT { return at(1, 0); }
    const u8 &upper_right() const FL_NO_EXCEPT { return at(1, 1); }
 
    u8 maxValue() const FL_NO_EXCEPT;
 
    static Tile2x2_u8 MaxTile(const Tile2x2_u8 &a, const Tile2x2_u8 &b) FL_NO_EXCEPT;
 
    vec2<u16> origin() const FL_NO_EXCEPT { return mOrigin; }

    rect<u16> bounds() const FL_NO_EXCEPT;
 
    // Draws the subpixel tile to the led array.
    void draw(const CRGB &color, const XYMap &xymap, fl::span<CRGB> out) const FL_NO_EXCEPT;
 
    // Inlined, yet customizable drawing access. This will only send you pixels
    // that are within the bounds of the XYMap.
    // Why use a template? Speed.
    // You have an array of Tile2x2_u8 in a draw list and you need to dispatch
    // them fast. Templates will inline completely for max speed.
    template <typename XYVisitor>
    void draw(const XYMap &xymap, XYVisitor &visitor) const FL_NO_EXCEPT {
        for (u16 x = 0; x < 2; ++x) {
            for (u16 y = 0; y < 2; ++y) {
                u8 value = at(x, y);
                if (value > 0) {
                    int xx = mOrigin.x + x;
                    int yy = mOrigin.y + y;
                    if (xymap.has(xx, yy)) {
                        // we know index cannot be -1 because we checked has(xx, yy) above.
                        u16 ux = static_cast<u16>(xx);
                        u16 uy = static_cast<u16>(yy);
                        int index = xymap.mapToIndex(ux, uy);
                        if (index >= 0) {
                            u32 uindex = static_cast<u32>(index);
                            vec2<u16> pt(ux, uy);
                            visitor.draw(pt, uindex, value);
                        } else {
                          // Unexpected because has(xx, yy) is true above therefore
                          // index cannot be < 0. TODO: low level log this.
                        }
                    }
                }
            }
        }
    }
 
  private:
    u8 mTile[2][2] = {};
    // Subpixels can be rendered outside the viewport so this must be signed.
    vec2<u16> mOrigin;
};
 
class Tile2x2_u8_wrap {
    // This is a class that is like a Tile2x2_u8 but wraps around the edges.
    // This is useful for cylinder mapping where the x-coordinate wraps around
    // the width of the cylinder and the y-coordinate wraps around the height.
    // This converts a tile2x2 to a wrapped x,y version.
  public:
    using Entry = fl::pair<vec2<u16>, u8>;  // absolute position, alpha
    using Data = Entry[2][2];
 
    Tile2x2_u8_wrap() FL_NO_EXCEPT;
    Tile2x2_u8_wrap(const Tile2x2_u8 &from, u16 width) FL_NO_EXCEPT;
    Tile2x2_u8_wrap(const Tile2x2_u8 &from, u16 width, u16 height) FL_NO_EXCEPT;
 
    Tile2x2_u8_wrap(const Data& data) FL_NO_EXCEPT;
 
    // Returns the absolute position and the alpha.
    Entry &at(u16 x, u16 y) FL_NO_EXCEPT;
    const Entry &at(u16 x, u16 y) const FL_NO_EXCEPT;
 
    // Interpolates between two wrapped tiles and returns up to 2 interpolated tiles
    static vector_fixed<Tile2x2_u8_wrap, 2> Interpolate(const Tile2x2_u8_wrap& a, const Tile2x2_u8_wrap& b, float t) FL_NO_EXCEPT;
 
  private:
    Data mData = {};
};
 
} // namespace fl