gdrawingsurface.h

/*
 * File: gdrawingsurface.h
 * -----------------------
 *
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl namespace
 * - converted Grid functionality to 2D array/vector
 * @version 2018/09/10
 * - added doc comments for new documentation generation
 * @version 2018/08/23
 * - renamed to gdrawingsurface.h to replace Java version
 * @version 2018/07/11
 * - initial version
 */


#ifndef _gdrawingsurface_h
#define _gdrawingsurface_h

#include <string>
#include <vector>
#include <QFont>
#include <QWidget>
#include "gobjects.h"
#include "gtypes.h"

namespace sgl {

class GDrawingSurface {
public:
    virtual void clear() = 0;

    virtual void conditionalRepaint();

    virtual void conditionalRepaintRegion(int x, int y, int width, int height);

    virtual void conditionalRepaintRegion(const GRectangle& bounds);

    virtual void draw(GObject* gobj) = 0;

    virtual void draw(GObject* gobj, double x, double y);

    virtual void draw(GObject& gobj);

    virtual void draw(GObject& gobj, double x, double y);

    virtual void draw(QPainter* painter) = 0;

    virtual void drawArc(double x, double y, double width, double height, double start, double sweep);

    virtual void drawImage(const string& filename, double x = 0, double y = 0);

    virtual void drawLine(const GPoint& p0, const GPoint& p1);

    virtual void drawLine(double x0, double y0, double x1, double y1);

    virtual void drawOval(const GRectangle& bounds);

    virtual void drawOval(double x, double y, double width, double height);

    virtual GPoint drawPolarLine(const GPoint& p0, double r, double theta);

    virtual GPoint drawPolarLine(double x0, double y0, double r, double theta);

    virtual void drawPixel(double x, double y);

    virtual void drawPixel(double x, double y, int color);

    virtual void drawPixel(double x, double y, const string& color);

    virtual void drawPolygon(std::initializer_list<double> coords);

    virtual void drawPolygon(std::initializer_list<GPoint> points);

    virtual void drawRect(const GRectangle& bounds);

    virtual void drawRect(double x, double y, double width, double height);

    virtual void drawString(const string& text, double x, double y);

    virtual void fillArc(double x, double y, double width, double height, double start, double sweep);

    virtual void fillOval(const GRectangle& bounds);

    virtual void fillOval(double x, double y, double width, double height);

    virtual void fillPolygon(std::initializer_list<double> coords);

    virtual void fillPolygon(std::initializer_list<GPoint> coords);

    virtual void fillRect(const GRectangle& bounds);

    virtual void fillRect(double x, double y, double width, double height);

    virtual int getARGB(double x, double y) const;

    virtual string getBackground() const;

    virtual int getBackgroundInt() const;

    virtual string getColor() const;

    virtual int getColorInt() const;

    virtual string getFillColor() const;

    virtual int getFillColorInt() const;

    virtual string getFont() const;

    virtual string getForeground() const;

    virtual int getForegroundInt() const;

    virtual GObject::LineStyle getLineStyle() const;

    virtual double getLineWidth() const;

    virtual int getPixel(double x, double y) const = 0;

    virtual int getPixelARGB(double x, double y) const = 0;

    virtual std::vector<std::vector<int>> getPixels() const = 0;

    virtual int** getPixelsArray() const = 0;

    virtual std::vector<std::vector<int>> getPixelsARGB() const = 0;

    virtual int** getPixelsArrayARGB() const = 0;

    virtual string getPixelString(double x, double y) const;

    virtual int getRGB(double x, double y) const;

    virtual string getRGBString(double x, double y) const;

    virtual bool isAutoRepaint() const;

    virtual bool isRepaintImmediately() const;

    virtual void repaint() = 0;

    virtual void repaintRegion(int x, int y, int width, int height) = 0;

    virtual void repaintRegion(const GRectangle& bounds);

    virtual void setAutoRepaint(bool autoRepaint);

    virtual void setBackground(int color);

    virtual void setBackground(const string& color);

    virtual void setColor(int color);

    virtual void setColor(const string& color);

    virtual void setFillColor(int color);

    virtual void setFillColor(const string& color);

    virtual void setFont(const QFont& font);

    virtual void setFont(const string& font);

    virtual void setForeground(int color);

    virtual void setForeground(const string& color);

    virtual void setLineWidth(double lineWidth);

    virtual void setLineStyle(GObject::LineStyle lineStyle);

    virtual void setPixel(double x, double y, int rgb) = 0;

    virtual void setPixel(double x, double y, int r, int g, int b);

    virtual void setPixel(double x, double y, const string& color);

    virtual void setPixelARGB(double x, double y, int argb) = 0;

    virtual void setPixelARGB(double x, double y, int a, int r, int g, int b);

    virtual void setPixels(int** pixels, int width = -1, int height = -1) = 0;

    virtual void setPixels(const std::vector<std::vector<int>>& pixels) = 0;

    virtual void setPixelsARGB(int** pixelsARGB, int width = -1, int height = -1) = 0;

    virtual void setPixelsARGB(const std::vector<std::vector<int>>& pixelsARGB) = 0;

    virtual void setRepaintImmediately(bool autoRepaint);

    virtual void setRGB(double x, double y, int rgb);

    virtual void setRGB(double x, double y, int r, int g, int b);

    virtual void setRGB(double x, double y, const string& color);

protected:
    GDrawingSurface();
    virtual ~GDrawingSurface();

    GDrawingSurface* _forwardTarget;
    string _backgroundColor;
    string _color;
    string _fillColor;
    string _font;
    int _backgroundColorInt;
    int _colorInt;
    int _fillColorInt;
    GObject::LineStyle _lineStyle;
    double _lineWidth;
    bool _autoRepaint;

    void checkBounds(const string& member, double x, double y, double width, double height) const;

    void checkColor(const string& member, int rgb) const;

    void checkSize(const string& member, double width, double height) const;

    virtual void initializeGObject(GObject& obj, bool filled = false);

    virtual void initializeGObject(GObject* obj, bool filled = false);

    virtual void setDrawingForwardTarget(GDrawingSurface* forwardTarget);
};

class GForwardDrawingSurface : public virtual GDrawingSurface {
public:
    void clear() override;
    void draw(GObject* gobj) override;
    void draw(GObject* gobj, double x, double y) override;
    void draw(GObject& gobj) override;
    void draw(GObject& gobj, double x, double y) override;
    void draw(QPainter* painter) override;
    int getPixel(double x, double y) const override;
    int getPixelARGB(double x, double y) const override;
    std::vector<std::vector<int>> getPixels() const override;
    int** getPixelsArray() const override;
    std::vector<std::vector<int>> getPixelsARGB() const override;
    int** getPixelsArrayARGB() const override;
    bool isAutoRepaint() const override;
    void repaint() override;
    void repaintRegion(int x, int y, int width, int height) override;
    void setAutoRepaint(bool autoRepaint) override;
    void setBackground(int color) override;
    void setBackground(const string& color) override;
    void setColor(int color) override;
    void setColor(const string& color) override;
    void setFillColor(int color) override;
    void setFillColor(const string& color) override;
    void setFont(const QFont& font) override;
    void setFont(const string& font) override;
    void setLineWidth(double lineWidth) override;
    void setPixel(double x, double y, int rgb) override;
    void setPixel(double x, double y, int r, int g, int b) override;
    void setPixelARGB(double x, double y, int argb) override;
    void setPixelARGB(double x, double y, int a, int r, int g, int b) override;
    void setPixels(int** pixels, int width = -1, int height = -1) override;
    void setPixels(const std::vector<std::vector<int>>& pixels) override;
    void setPixelsARGB(int** pixelsARGB, int width = -1, int height = -1) override;
    void setPixelsARGB(const std::vector<std::vector<int>>& pixelsARGB) override;
    void setRepaintImmediately(bool repaintImmediately) override;

protected:
    virtual void ensureForwardTarget() = 0;
    virtual void ensureForwardTargetConstHack() const;
};

} // namespace sgl

#endif // _gcanvas_h