gtypes.h

/*
 * File: gtypes.h
 * --------------
 * This file defines classes for representing points, dimensions, and
 * rectangles.
 *
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2018/09/09
 * - added doc comments for new documentation generation
 * @version 2018/07/14
 * - initial version, based on gtypes.h
 */


#ifndef _gtypes_h
#define _gtypes_h

#include <functional>
#include <iostream>
#include <Qt>
#include <string>

namespace sgl {

typedef std::function<void()> GThunk;

typedef std::function<int()> GThunkInt;


struct GDimension {
public:
    GDimension(double width, double height);

    /*
     * Constructs a default dimension 0, 0.
     */
    GDimension();


    string toString() const;

    /* width and height - may be directly accessed or modified */
    double width;
    double height;

    /* Private section */

    /**********************************************************************/
    /* Note: Everything below this point in this class is logically part  */
    /* of the implementation and should not be of interest to clients.    */
    /**********************************************************************/
private:
    /* Instance variables */

    /* Friend declarations */
    friend std::ostream& operator <<(std::ostream& os, const GDimension& dim);
    friend bool operator ==(const GDimension& d1, const GDimension& d2);
    friend bool operator !=(const GDimension& d1, const GDimension& d2);
    friend bool operator <(const GDimension& d1, const GDimension& d2);
    friend bool operator <=(const GDimension& d1, const GDimension& d2);
    friend bool operator >(const GDimension& d1, const GDimension& d2);
    friend bool operator >=(const GDimension& d1, const GDimension& d2);
    friend GDimension operator *(const GDimension& d, double scale);
};

std::ostream& operator <<(std::ostream& os, const GDimension& dim);

bool operator ==(const GDimension& d1, const GDimension& d2);

bool operator !=(const GDimension& d1, const GDimension& d2);

bool operator <(const GDimension& d1, const GDimension& d2);

bool operator <=(const GDimension& d1, const GDimension& d2);

bool operator >(const GDimension& d1, const GDimension& d2);

bool operator >=(const GDimension& d1, const GDimension& d2);

GDimension operator *(const GDimension& d, double scale);

enum HorizontalAlignment {
    ALIGN_CENTER,
    ALIGN_LEFT,
    ALIGN_RIGHT,
    ALIGN_HORIZONTAL_STRETCH
};

enum VerticalAlignment {
    ALIGN_MIDDLE,
    ALIGN_TOP,
    ALIGN_BOTTOM,
    ALIGN_VERTICAL_STRETCH
};

enum SwingConstants {
    SWING_CENTER,
    SWING_TOP,
    SWING_LEFT,
    SWING_BOTTOM,
    SWING_RIGHT
};
// Note: Must keep in sync with GInteractor::TextPosition.

string toString(HorizontalAlignment alignment);

string toString(VerticalAlignment alignment);

HorizontalAlignment toHorizontalAlignment(const string& alignmentStr);

Qt::Alignment toQtAlignment(HorizontalAlignment alignment);

Qt::Alignment toQtAlignment(VerticalAlignment alignment);

VerticalAlignment toVerticalAlignment(const string& alignmentStr);

struct GPoint {
public:
    GPoint(double x, double y);

    /*
     * Constructs a default GPoint 0, 0.
     */
    GPoint();

    string toString() const;

    /* x and y coordinates - may be directly accessed or modified */
    double x;
    double y;

    /* Private section */

    /**********************************************************************/
    /* Note: Everything below this point in this class is logically part  */
    /* of the implementation and should not be of interest to clients.    */
    /**********************************************************************/
private:

    /* Friend declarations */
    friend std::ostream& operator <<(std::ostream& out, const GPoint& p);
    friend bool operator ==(const GPoint& p1, const GPoint& p2);
    friend bool operator !=(const GPoint& p1, const GPoint& p2);
    friend bool operator <(const GPoint& p1, const GPoint& p2);
    friend bool operator <=(const GPoint& p1, const GPoint& p2);
    friend bool operator >(const GPoint& p1, const GPoint& p2);
    friend bool operator >=(const GPoint& p1, const GPoint& p2);
    friend GPoint operator *(const GPoint& p, double scale);
};

std::ostream& operator <<(std::ostream& os, const GPoint& pt);

bool operator ==(const GPoint& p1, const GPoint& p2);

bool operator !=(const GPoint& p1, const GPoint& p2);

bool operator <(const GPoint& p1, const GPoint& p2);

bool operator <=(const GPoint& p1, const GPoint& p2);

bool operator >(const GPoint& p1, const GPoint& p2);

bool operator >=(const GPoint& p1, const GPoint& p2);

GPoint operator *(const GPoint& p, double scale);

struct GRectangle {
public:
    GRectangle(double x = 0, double y = 0, double width = 0, double height = 0);

    GRectangle(double x, double y, const GDimension& size);

    GRectangle(const GPoint& p, double width = 0, double height = 0);

    GRectangle(const GPoint& p, const GDimension& size);

    bool contains(double x, double y) const;

    bool contains(const GPoint& pt) const;

    bool contains(const GRectangle& rect) const;

    GRectangle enlargedBy(double amount);

    bool intersects(const GRectangle& other) const;

    bool isEmpty() const;

    string toString() const;

    /* coordinates and dimension - may be directly accessed or modified */
    double x;        /* The x-coordinate of the rectangle */
    double y;        /* The y-coordinate of the rectangle */
    double width;    /* The width of the rectangle        */
    double height;   /* The height of the rectangle       */

    /* Private section */

    /**********************************************************************/
    /* Note: Everything below this point in this class is logically part  */
    /* of the implementation and should not be of interest to clients.    */
    /**********************************************************************/
private:
    /* Instance variables */


    /* Friend declarations */
    friend std::ostream& operator <<(std::ostream& os, const GRectangle& rect);
    friend bool operator ==(const GRectangle& r1, const GRectangle& r2);
    friend bool operator !=(const GRectangle& r1, const GRectangle& r2);
    friend bool operator <(const GRectangle& r1, const GRectangle& r2);
    friend bool operator <=(const GRectangle& r1, const GRectangle& r2);
    friend bool operator >(const GRectangle& r1, const GRectangle& r2);
    friend bool operator >=(const GRectangle& r1, const GRectangle& r2);
};

std::ostream& operator <<(std::ostream& os, const GRectangle& rect);

bool operator ==(const GRectangle& r1, const GRectangle& r2);

bool operator !=(const GRectangle& r1, const GRectangle& r2);

bool operator <(const GRectangle& r1, const GRectangle& r2);

bool operator <=(const GRectangle& r1, const GRectangle& r2);

bool operator >(const GRectangle& r1, const GRectangle& r2);

bool operator >=(const GRectangle& r1, const GRectangle& r2);

} // namespace sgl

#endif // _gtypes_h