tiler.h

Go to the documentation of this file.

/*
    MIT License

    Copyright (c) 2018-2021, Alexey Dynda

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
#ifndef _NANO_ENGINE_TILER_H_
#define _NANO_ENGINE_TILER_H_

#include "canvas/rect.h"
#include "canvas/canvas.h"
#include "v2/lcd/base/display.h"

#ifndef NE_MAX_TILE_ROWS
#define NE_MAX_TILE_ROWS 20 
#endif

/* The table below defines arguments for NanoEngineTiler.          *
 *                            canvas                    bits   */
// Tiles for monochrome displays
#define TILE_128x64_MONO NanoCanvas<128, 64, 1> 
#define TILE_8x8_MONO NanoCanvas<8, 8, 1>       
#define TILE_16x16_MONO NanoCanvas<16, 16, 1>   
#define TILE_32x32_MONO NanoCanvas<32, 32, 1>   
// Tiles for 4-bit displays
#define TILE_16x16_GRAY4 NanoCanvas<16, 16, 4> 
// Tiles for 8-bit displays
#define TILE_8x8_RGB8 NanoCanvas<8, 8, 8>       
#define TILE_16x16_RGB8 NanoCanvas<16, 16, 8>   
#define TILE_32x32_RGB8 NanoCanvas<32, 32, 8>   
#define TILE_8x8_MONO_8 NanoCanvas<8, 8, 1>     
#define TILE_16x16_MONO_8 NanoCanvas<16, 16, 1> 
// Tiles for 16-bit displays
#define TILE_8x8_RGB16 NanoCanvas<8, 8, 16>     
#define TILE_16x16_RGB16 NanoCanvas<16, 16, 16> 
// Adafruit tiles
#define ADATILE_8x8_MONO AdafruitCanvas1, 8, 8, 3   
#define ADATILE_8x8_RGB8 AdafruitCanvas8, 8, 8, 3   
#define ADATILE_8x8_RGB16 AdafruitCanvas16, 8, 8, 3 


typedef bool (*TNanoEngineOnDraw)(void);

template <class C, class D> class NanoEngine;

template <class C, class D> class NanoEngineTiler;

template <class T> class NanoEngineObject
{
public:
    template <class C, class D> friend class NanoEngineTiler;

    NanoEngineObject() = default;

    virtual void draw() = 0;

    virtual void update() = 0;

    virtual void refresh() = 0;

    void focus()
    {
        m_focused = true;
        refresh();
    }

    void defocus()
    {
        m_focused = false;
        refresh();
    }

    bool isFocused()
    {
        return m_focused;
    }

    bool hasTiler()
    {
        return m_tiler != nullptr;
    }

    T &getTiler()
    {
        return *(static_cast<T *>(m_tiler));
    }

protected:
    T *m_tiler = nullptr;                  
    NanoEngineObject<T> *m_next = nullptr; 

    void setTiler(T *tiler)
    {
        m_tiler = tiler;
    }

private:
    bool m_focused = false;
};

template <class C, class D> class NanoEngineTiler
{
protected:
    explicit NanoEngineTiler(D &display)
        : m_display(display)
        , m_onDraw(nullptr)
        , offset{0, 0}
        , m_first(nullptr)
    {
        refresh();
    };

public:
    typedef NanoEngineTiler<C, D> TilerT;
    void refresh()
    {
        memset(m_refreshFlags, 0xFF, sizeof(m_refreshFlags));
    }

    void refresh(const NanoRect &rect)
    {
        refresh(rect.p1.x, rect.p1.y, rect.p2.x, rect.p2.y);
    }

    void refresh(const NanoPoint &point) __attribute__((noinline))
    {
        if ( (point.x < 0) || (point.y < 0) || ((point.y / canvas.height()) >= NE_MAX_TILE_ROWS) )
            return;
        m_refreshFlags[(point.y / canvas.height())] |= (1 << (point.x / canvas.width()));
    }

    void refresh(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline))
    {
        if ( y2 < 0 || x2 < 0 )
            return;
        if ( y1 < 0 )
            y1 = 0;
        if ( x1 < 0 )
            x1 = 0;
        y1 = y1 / canvas.height();
        y2 = lcd_gfx_min((y2 / canvas.height()), NE_MAX_TILE_ROWS - 1);
        for ( uint8_t x = x1 / canvas.width(); x <= (x2 / canvas.width()); x++ )
        {
            for ( uint8_t y = y1; y <= y2; y++ )
            {
                m_refreshFlags[y] |= (1 << x);
            }
        }
    }

    void refreshWorld(const NanoRect &rect)
    {
        refreshWorld(rect.p1.x, rect.p1.y, rect.p2.x, rect.p2.y);
    }

    void refreshWorld(lcdint_t x1, lcdint_t y1, lcdint_t x2, lcdint_t y2) __attribute__((noinline))
    {
        refresh(x1 - offset.x, y1 - offset.y, x2 - offset.x, y2 - offset.y);
    }

    void refreshWorld(const NanoPoint &point)
    {
        refresh(point - offset);
    }

    void localCoordinates()
    {
        canvas.offset -= offset;
    }

    void worldCoordinates()
    {
        canvas.offset += offset;
    }

    void moveTo(const NanoPoint &position)
    {
        offset = position;
    }

    void moveToAndRefresh(const NanoPoint &position)
    {
        moveTo(position);
        refresh();
    }

    const NanoPoint &getPosition() const
    {
        return offset;
    }

    void drawCallback(TNanoEngineOnDraw callback)
    {
        m_onDraw = callback;
    }

    bool collision(const NanoPoint &p, const NanoRect &rect)
    {
        return rect.collision(p);
    }

    void insert(NanoEngineObject<TilerT> &object) __attribute__((noinline))
    {
        object.m_next = this->m_first;
        object.setTiler(this);
        m_first = &object;
        object.refresh();
    }

    void remove(NanoEngineObject<TilerT> &object) __attribute__((noinline))
    {
        if ( this->m_first == nullptr )
        {
        }
        else if ( &object == m_first )
        {
            object.refresh();
            this->m_first = object.m_next;
            object.m_next = nullptr;
            object.m_tiler = nullptr;
        }
        else
        {
            NanoEngineObject<TilerT> *p = this->m_first;
            while ( p->m_next )
            {
                if ( p->m_next == &object )
                {
                    object.refresh();
                    p->m_next = object.m_next;
                    object.m_next = nullptr;
                    object.m_tiler = nullptr;
                    break;
                }
                p = p->m_next;
            }
        }
    }

    void update() __attribute__((noinline))
    {
        NanoEngineObject<TilerT> *p = m_first;
        while ( p )
        {
            p->update();
            p = p->m_next;
        }
    }

    C &getCanvas()
    {
        return canvas;
    }

    D &getDisplay()
    {
        return m_display;
    }

protected:
    D &m_display;

    TNanoEngineOnDraw m_onDraw;

    uint16_t m_refreshFlags[NE_MAX_TILE_ROWS];

    void displayBuffer() __attribute__((noinline));

    void displayPopup(const char *msg);

private:
    C canvas;

    NanoPoint offset;

    NanoEngineObject<TilerT> *m_first = nullptr;

    void draw() __attribute__((noinline))
    {
        NanoEngineObject<TilerT> *p = m_first;
        while ( p )
        {
            p->draw();
            p = p->m_next;
        }
    }
};

template <class C, class D> void NanoEngineTiler<C, D>::displayBuffer()
{
    //    printf("--------------\n");
    for ( lcduint_t y = 0; y < m_display.height(); y = y + canvas.height() )
    {
        uint16_t flag = m_refreshFlags[y / canvas.height()];
        m_refreshFlags[y / canvas.height()] = 0;
        //        printf("|%d%d%d%d%d%d%d%d|\n", flag & 1, (flag >> 1) & 1, (flag >> 2) & 1, (flag >> 3) & 1, (flag >>
        //        4) & 1, (flag >> 5) & 1,(flag >> 6) & 1,(flag >> 7) & 1 );
        for ( lcduint_t x = 0; x < m_display.width(); x = x + canvas.width() )
        {
            if ( flag & 0x01 )
            {
                canvas.setOffset(x + offset.x, y + offset.y);
                if ( m_onDraw == nullptr )
                {
                    canvas.clear();
                    draw();
                    this->m_display.drawCanvas(x, y, canvas);
                }
                else if ( m_onDraw() )
                {
                    draw();
                    this->m_display.drawCanvas(x, y, canvas);
                }
            }
            flag >>= 1;
        }
    }
}

template <class C, class D> void NanoEngineTiler<C, D>::displayPopup(const char *msg)
{
    lcduint_t height = 0;
    lcduint_t width = m_display.getFont().getTextSize(msg, &height);
    NanoRect rect = {
        {((m_display.width() - (lcdint_t)width) >> 1) - 8, ((m_display.height() - (lcdint_t)height) >> 1) - 4},
        {((m_display.width() + (lcdint_t)width) >> 1) + 8, ((m_display.height() + (lcdint_t)height) >> 1) + 4}};
    // TODO: It would be nice to calculate message height
    NanoPoint textPos = {(m_display.width() - (lcdint_t)width) >> 1, (m_display.height() - height) >> 1};
    refresh(rect);
    for ( lcduint_t y = 0; y < m_display.height(); y = y + canvas.height() )
    {
        uint16_t flag = m_refreshFlags[y / canvas.height()];
        m_refreshFlags[y / canvas.height()] = 0;
        for ( lcduint_t x = 0; x < m_display.width(); x = x + canvas.width() )
        {
            if ( flag & 0x01 )
            {
                canvas.setOffset(x + offset.x, y + offset.y);
                if ( !m_onDraw )
                {
                    canvas.clear();
                    draw();
                }
                else if ( m_onDraw() )
                {
                    draw();
                }
                canvas.setOffset(x, y);
                canvas.setColor(RGB_COLOR8(0, 0, 0));
                canvas.fillRect(rect);
                canvas.setColor(RGB_COLOR8(192, 192, 192));
                canvas.drawRect(rect);
                canvas.printFixed(textPos.x, textPos.y, msg);

                m_display.drawCanvas(x, y, canvas);
            }
            flag >>= 1;
        }
    }
}

#endif