windowframework.h

/*
 * File: windowframework.h
 * Authors: Alexander Epp, Rain Epp
 * Project: CMPUT274 Final Project
 * Description: Defines a cross-platform drawing interface
 */

#pragma once
#include "util.h"
#include "vec.h"

/*
 * The WindowFramework interface is used to standardize drawing to the screen
 * across the Arduino and desktop platforms.
 * 
 * Despite the name, this class is also responsible for initializing any
 * platform-specific libraries used elsewhere (e.g. Serial for Arduino).
 */

class WindowFramework
{
public:
    WindowFramework();

    /*
     * Update framework; return false if should quit. This function should be
     * called regularly when drawing or otherwise not idling, since it
     * will eventually show drawn pixels on the screen (although not necessarily
     * in a real-time manner), which drawPixel() is not guaranteed to do.
     */
    virtual bool tick() = 0;
    /*
     * Idles -- returns false if should quit.
     */
    virtual bool idle() = 0;
    
    /*
     * Clear all screen pixels to a given colour.
     */
    virtual void clear(fvec3 colour) = 0;
    /*
     * Draw a single pixel to the screen (x, y are standard Cartesian coordinates, e.i.,
     * x ranges from 0 (left) to width (right)
     * y ranges from 0 (bottom) to height (top).
     * The pixel is not guaranteed to be drawn immediately (although it might be
     * for certain implementations), and so tick() should be called regularly
     * when drawing pixels.
     */
    virtual void drawPixel(uint16_t x, uint16_t y, fvec3 colour) = 0;

    // Get window width in pixels
    virtual uint16_t width() = 0;
    // Get window height in pixels
    virtual uint16_t height() = 0;

    virtual ~WindowFramework();
};