/*
 * File: gobjects.h
 * ----------------
 * This file exports a hierarchy of graphical shapes based on
 * the model developed for the ACM Java Graphics.
 * <include src="pictures/ClassHierarchies/GObjectHierarchy-h.html">
 *
 * TODO: add get/setX, Y, size?
 * TODO: get fill color as RGB int?
 * TODO: operator << for gobjects? they already have toString()
 *
 * @version 2016/11/07
 * - alphabetized all members
 * - modified all members that accept std::string to take const std::string&
 * @version 2016/10/15
 * - made GRect() constructor public
 * @version 2016/10/12
 * - added contains to GRoundRect
 * @version 2016/09/27
 * - added get/setText methods to GLabel
 */

#ifndef _gobjects_h
#define _gobjects_h

#include "gtypes.h"
#include "gwindow.h"
#include "vector.h"

// forward declaration of class
class GCompound;

/*
 * Class: GObject
 * --------------
 * This class is the common superclass of all graphical objects that can
 * be displayed on a graphical window.  The class <code>GObject</code>
 * itself is an <b><i>abstract class</i></b>, which means that you are not
 * allowed to construct a <code>GObject</code> directly but must instead
 * construct one of the concrete subclasses.
 * <include src="pictures/ClassHierarchies/GObjectHierarchy.html">
 *
 * <p>Most methods used for graphics take a pointer to a <code>GObject</code>
 * rather than the <code>GObject</code> itself.  Applications that use
 * <code>GObject</code> pointers therefore use the arrow operator
 * (<code>-&gt;</code>) to apply methods to the object pointer.
 * For examples illustrating the use of the <code>GObject</code> class, see
 * the descriptions of the individual subclasses.
 */
class GObject {
public:
    /*
     * Destructor: ~GObject
     * --------------------
     * Frees the storage for the object.
     */
    virtual ~GObject();

    /*
     * Method: contains
     * Usage: if (gobj->contains(pt)) ...
     *        if (gobj->contains(x, y)) ...
     * ------------------------------------
     * Returns <code>true</code> if the specified point is inside the object.
     */
    virtual bool contains(double x, double y) const;
    bool contains(const GPoint& pt) const;

    /*
     * Method: getBounds
     * Usage: GRectangle rect = gobj->getBounds();
     * -------------------------------------------
     * Returns the bounding box of this object, which is defined to be the
     * smallest rectangle that covers everything drawn by the figure.  The
     * coordinates of this rectangle do not necessarily match the location
     * returned by <code>getLocation</code>.  Given a <code>GLabel</code>
     * object, for example, <code>getLocation</code> returns the coordinates
     * of the point on the baseline at which the string begins; the
     * <code>getBounds</code> method, by contrast, returns a rectangle that
     * covers the entire window area occupied by the string.
     */
    virtual GRectangle getBounds() const = 0;

    /*
     * Method: getColor
     * Usage: string color = gobj->getColor();
     * ---------------------------------------
     * Returns the color used to display this object.  This color is
     * always returned as a string in the form <code>"#rrggbb"</code>,
     * where <code>rr</code>, <code>gg</code>, and <code>bb</code> are
     * the red, green, and blue components of the color, expressed as
     * two-digit hexadecimal values.
     */
    std::string getColor() const;

    /*
     * Method: getHeight
     * Usage: double height = gobj->getHeight();
     * -----------------------------------------
     * Returns the height of this object, which is defined to be the height
     * of the bounding box.
     */
    double getHeight() const;

    /*
     * Method: getLocation
     * Usage: GPoint pt = gobj->getLocation();
     * ---------------------------------------
     * Returns the location of this object as a <code>GPoint</code>.
     */
    GPoint getLocation() const;

    /*
     * Method: getLineWidth
     * Usage: double lineWidth = gobj->getLineWidth();
     * -----------------------------------------------
     * Returns the width of the line used to draw this object.
     */
    double getLineWidth() const;

    /*
     * Method: getParent
     * Usage: GCompound *parent = gobj->getParent();
     * ---------------------------------------------
     * Returns a pointer to the <code>GCompound</code> that contains this
     * object.  Every <code>GWindow</code> is initialized to contain a single
     * <code>GCompound</code> that is aligned with the window.  Adding
     * objects to the window adds them to that <code>GCompound</code>,
     * which means that every object you add to the window has a parent.
     * Calling <code>getParent</code> on the top-level <code>GCompound</code>
     * returns <code>nullptr</code>.
     */
    GCompound* getParent() const;

    /*
     * Method: getSize
     * Usage: GDimension size = gobj->getSize();
     * -----------------------------------------
     * Returns the size of the object as a <code>GDimension</code>.
     */
    GDimension getSize() const;

    /*
     * Method: getType
     * Usage: string type = gobj->getType();
     * -------------------------------------
     * Returns the concrete type of the object as a string, as in
     * <code>"GOval"</code> or <code>"GRect"</code>.
     */
    virtual std::string getType() const = 0;

    /*
     * Method: getWidth
     * Usage: double width = gobj->getWidth();
     * ---------------------------------------
     * Returns the width of this object, which is defined to be the width of
     * the bounding box.
     */
    double getWidth() const;

    /*
     * Method: getX
     * Usage: double x = gobj->getX();
     * -------------------------------
     * Returns the <i>x</i>-coordinate of the object.
     */
    double getX() const;

    /*
     * Method: getY
     * Usage: double y = gobj->getY();
     * -------------------------------
     * Returns the <i>y</i>-coordinate of the object.
     */
    double getY() const;

    /*
     * Method: isVisible
     * Usage: if (gobj->isVisible()) ...
     * ---------------------------------
     * Returns <code>true</code> if this object is visible.
     */
    bool isVisible() const;

    /*
     * Method: move
     * Usage: gobj->move(dx, dy);
     * --------------------------
     * Moves the object on the screen using the displacements
     * <code>dx</code> and <code>dy</code>.
     */
    void move(double dx, double dy);

    /*
     * Method: rotate
     * Usage: gobj->rotate(theta);
     * ---------------------------
     * Transforms the object by rotating it <code>theta</code> degrees
     * counterclockwise around its origin.
     */
    void rotate(double theta);

    /*
     * Method: scale
     * Usage: gobj->scale(sf);
     *        gobj->scale(sx, sy);
     * ---------------------------
     * Scales the object by the specified scale factors.  Most clients will use
     * the first form, which scales the object by <code>sf</code> in both
     * dimensions, so that invoking <code>gobj->scale(2)</code> doubles the
     * size of the object.  The second form applies independent scale factors
     * to the <i>x</i> and <i>y</i> dimensions.
     */
    void scale(double sf);
    void scale(double sx, double sy);

    /*
     * Method: sendBackward
     * Usage: gobj->sendBackward();
     * ----------------------------
     * Moves this object one step toward the back in the <i>z</i> dimension.
     * If it was already at the back of the stack, nothing happens.
     */
    void sendBackward();

    /*
     * Method: sendForward
     * Usage: gobj->sendForward();
     * ---------------------------
     * Moves this object one step toward the front in the <i>z</i> dimension.
     * If it was already at the front of the stack, nothing happens.
     */
    void sendForward();

    /*
     * Method: sendToBack
     * Usage: gobj->sendToBack();
     * --------------------------
     * Moves this object to the back of the display in the <i>z</i> dimension.
     * By moving it to the back, this object will appear to be behind the other
     * graphical objects on the display and may be obscured by other objects
     * in front.
     */
    void sendToBack();

    /*
     * Method: sendToFront
     * Usage: gobj->sendToFront();
     * ---------------------------
     * Moves this object to the front of the display in the <i>z</i> dimension.
     * By moving it to the front, this object will appear to be on top of the
     * other graphical objects on the display and may hide any objects that
     * are further back.
     */
    void sendToFront();

    /*
     * Globally turns on/off the anti-aliasing feature that smooths out the
     * edges of onscreen shapes.  On by default.
     */
    static void setAntiAliasing(bool value);

    /*
     * Method: setColor
     * Usage: gobj->setColor(color);
     * -----------------------------
     * Sets the color used to display this object.  The <code>color</code>
     * string is usually one of the predefined color names:
     *
     *    <code>BLACK</code>,
     *    <code>BLUE</code>,
     *    <code>CYAN</code>,
     *    <code>DARK_GRAY</code>,
     *    <code>GRAY</code>,
     *    <code>GREEN</code>,
     *    <code>LIGHT_GRAY</code>,
     *    <code>MAGENTA</code>,
     *    <code>ORANGE</code>,
     *    <code>PINK</code>,
     *    <code>RED</code>,
     *    <code>WHITE</code>, and
     *    <code>YELLOW</code>.
     *
     * The case of the individual letters in the color name is ignored, as
     * are spaces and underscores, so that the color <code>DARK_GRAY</code>
     * can be written as <code>"Dark Gray"</code>.
     *
     * <p>The color can also be specified as a string in the form
     * <code>"#rrggbb"</code> where <code>rr</code>, <code>gg</code>, and
     * <code>bb</code> are pairs of hexadecimal digits indicating the
     * red, green, and blue components of the color, respectively.
     */
    void setColor(int rgb);
    void setColor(const std::string& color);

    /*
     * Method: setLineWidth
     * Usage: gobj->setLineWidth(lineWidth);
     * -------------------------------------
     * Sets the width of the line used to draw this object.
     */
    void setLineWidth(double lineWidth);

    /*
     * Method: setLocation
     * Usage: gobj->setLocation(pt);
     *        gobj->setLocation(x, y);
     * -------------------------------
     * Sets the location of this object to the specified point.
     */
    void setLocation(double x, double y);
    void setLocation(const GPoint& pt);

    /*
     * Method: setVisible
     * Usage: gobj->setVisible(flag);
     * ------------------------------
     * Sets whether this object is visible.
     */
    void setVisible(bool flag);

    /*
     * Method: toString
     * Usage: gobj->toString();
     * ------------------------
     * Returns a printable representation of the object.
     */
    virtual std::string toString() const = 0;

    /* Private section */
private:
    // forbid assignment between objects
    const GObject& operator =(const GObject&) {
        return *this;
    }
    
    // forbid copy construction
    GObject(const GObject&) {
        // empty
    }

    /* Instance variables */
protected:
    double x;                       /* The x coordinate of the origin     */
    double y;                       /* The y coordinate of the origin     */
    double lineWidth;               /* The width of the line in pixels    */
    std::string color;              /* The color of the object            */
    bool visible;                   /* Indicates if object is visible     */
    bool transformed;               /* Indicates if object is transformed */
    GCompound* parent;              /* Pointer to the parent              */

protected:
    GObject();

    friend class G3DRect;
    friend class GArc;
    friend class GButton;
    friend class GCheckBox;
    friend class GChooser;
    friend class GCompound;
    friend class GImage;
    friend class GInteractor;
    friend class GLabel;
    friend class GLine;
    friend class GOval;
    friend class GPolygon;
    friend class GRect;
    friend class GRoundRect;
    friend class GSlider;
    friend class GTextField;
};

/*
 * Class: GRect
 * ------------
 * This class represents a graphical object whose appearance consists of
 * a rectangular box.  For example, the following code adds a filled, red
 * <nobr>200<font class=sansserif size=-1>x</font>100</nobr> rectangle
 * at the upper left corner of the graphics window:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws a red rectangle at (0, 0)." << endl;
 *       GRect *rect = new GRect(0, 0, 200, 100);
 *       rect->setFilled(true);
 *       rect->setColor("RED");
 *       gw.add(rect);
 *       return 0;
 *    }
 *</pre>
 */
class GRect : public GObject {
public:
    /*
     * Constructor: GRect
     * Usage: GRect *rect = new GRect(width, height);
     *        GRect *rect = new GRect(x, y, width, height);
     * ----------------------------------------------------
     * Constructs a rectangle with the specified width and height.  The first
     * form is positioned at the origin; the second at the coordinates
     * given by <code>x</code> and <code>y</code>.
     */
    GRect();
    GRect(double width, double height);
    GRect(double x, double y, double width, double height);

    /*
     * Destructor: ~GRect
     * ------------------
     * Frees any resources maintained by this object.
     */
    virtual ~GRect();

    /*
     * Method: getFillColor
     * Usage: string color = rect->getFillColor();
     * -------------------------------------------
     * Returns the color used to display the filled region of this rectangle.  If
     * none has been set, <code>getFillColor</code> returns the empty string.
     */
    std::string getFillColor() const;

    /*
     * Method: isFilled
     * Usage: if (rect->isFilled()) ...
     * --------------------------------
     * Returns <code>true</code> if the rectangle is filled.
     */
    bool isFilled() const;

    /*
     * Method: setBounds
     * Usage: rect->setBounds(rect);
     *        rect->setBounds(x, y, width, height);
     * --------------------------------------------
     * Changes the bounds of this rectangle to the specified values.
     */
    void setBounds(double x, double y, double width, double height);
    void setBounds(const GRectangle& size);

    /*
     * Method: setFillColor
     * Usage: rect->setFillColor(color);
     * ---------------------------------
     * Sets the color used to display the filled region of this rectangle.
     * As a side effect, sets this object to be filled (setFilled(true)).
     * If an empty string is passed, sets filled to false.
     */
    void setFillColor(int rgb);
    void setFillColor(const std::string& color);

    /*
     * Method: setFilled
     * Usage: rect->setFilled(flag);
     * -----------------------------
     * Sets the fill status for the rectangle, where <code>false</code> is
     * outlined and <code>true</code> is filled.
     */
    void setFilled(bool flag);

    /*
     * Method: setSize
     * Usage: rect->setSize(size);
     *        rect->setSize(width, height);
     * ------------------------------------
     * Changes the size of this rectangle to the specified width and height.
     */
    void setSize(double width, double height);
    void setSize(const GDimension& size);

    /* Prototypes for the virtual methods */
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

protected:
    /* Instance variables */
    double width;           /* The width of the rectangle              */
    double height;          /* The height of the rectangle             */
    bool fillFlag;          /* Indicates whether the object is filled  */
    std::string fillColor;  /* Color used to fill the object           */

    /* Protected methods */
    virtual void createGRect(double width, double height);
};

/*
 * Class: GRoundRect
 * -----------------
 * This class represents a graphical object whose appearance consists
 * of a rectangular box with rounded corners.
 */
class GRoundRect : public GRect {
public:
    /*
     * Constructor: GRoundRect
     * Usage: GRoundRect *rect = new GRoundRect(width, height);
     *        GRoundRect *rect = new GRoundRect(width, height, corner);
     *        GRoundRect *rect = new GRoundRect(x, y, width, height);
     *        GRoundRect *rect = new GRoundRect(x, y, width, height, corner);
     * ----------------------------------------------------------------------
     * Constructs a new rectangle with the specified width and height.  If
     * the <code>x</code> and <code>y</code> parameters are specified, they
     * are used to specify the origin.  The <code>corner</code> parameter
     * specifies the diameter of the arc forming the corner.
     */
    GRoundRect(double width, double height);
    GRoundRect(double width, double height, double corner);
    GRoundRect(double x, double y, double width, double height);
    GRoundRect(double x, double y, double width, double height, double corner);

    /*
     * Destructor: ~GRoundRect
     * -----------------------
     * Frees any resources maintained by this object.
     */
    virtual ~GRoundRect();

    /*
     * Method: contains
     * Usage: if (grrect->contains(pt)) ...
     *        if (grrect->contains(x, y)) ...
     * --------------------------------------
     * Returns <code>true</code> if the specified point is inside the object.
     */
    virtual bool contains(double x, double y) const;

    /* Prototypes for the virtual methods */
    virtual std::string getType() const;
    virtual std::string toString() const;

protected:
    double corner;

    /* Protected methods */
    void createGRoundRect(double width, double height, double corner);
};

/*
 * Class: G3DRect
 * --------------
 * This graphical object subclass represents a rectangular box that can
 * be raised or lowered.
 */
class G3DRect : public GRect {
public:
    /*
     * Constructor: G3DRect
     * Usage: G3DRect *rect = new G3DRect(width, height);
     *        G3DRect *rect = new G3DRect(width, height, raised);
     *        G3DRect *rect = new G3DRect(x, y, width, height);
     *        G3DRect *rect = new G3DRect(x, y, width, height, raised);
     * ----------------------------------------------------------------
     * Constructs a new 3D rectangle with the specified width and height.  If
     * the <code>x</code> and <code>y</code> parameters are specified, they
     * are used to specify the origin.  The <code>raised</code> parameter
     * determines whether the rectangle should be drawn with highlights that
     * suggest that it is raised about the background.
     */
    G3DRect(double width, double height);
    G3DRect(double width, double height, bool raised);
    G3DRect(double x, double y, double width, double height);
    G3DRect(double x, double y, double width, double height, bool raised);

    /*
     * Destructor: ~G3DRect
     * --------------------
     * Frees any resources maintained by this object.
     */
    virtual ~G3DRect();

    /*
     * Method: isRaised
     * Usage: if (rect->isRaised()) ...
     * --------------------------------
     * Returns <code>true</code> if this object appears raised.
     */
    bool isRaised() const;

    /*
     * Method: setRaised
     * Usage: rect->setRaised(raised);
     * -------------------------------
     * Indicates whether this object appears raised.
     */
    void setRaised(bool raised);

    /* Prototypes for the virtual methods */
    virtual std::string getType() const;
    virtual std::string toString() const;

protected:
    bool raised;

    /* Protected methods */
    void createG3DRect(double width, double height, bool raised);
};

/*
 * Class: GOval
 * ------------
 * This graphical object subclass represents an oval inscribed in
 * a rectangular box.  For example, the following code displays a
 * filled green oval inscribed in the graphics window:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws a green oval filling the window." << endl;
 *       GOval *oval = new GOval(gw.getWidth(), gw.getHeight());
 *       oval->setFilled(true);
 *       oval->setColor("GREEN");
 *       gw.add(oval);
 *       return 0;
 *    }
 *</pre>
 */
class GOval : public GObject {
public:
    /*
     * Constructor: GOval
     * Usage: GOval *oval = new GOval(width, height);
     *        GOval *oval = new GOval(x, y, width, height);
     * ----------------------------------------------------
     * Constructs a new oval inscribed in the specified rectangle.  The
     * first form is positioned at the origin; the second at the coordinates
     * given by <code>x</code> and <code>y</code>.
     */
    GOval(double width, double height);
    GOval(double x, double y, double width, double height);

    /*
     * Destructor: ~GOval
     * ------------------
     * Frees any resources maintained by this object.
     */
    virtual ~GOval();

    /*
     * Method: getFillColor
     * Usage: string color = oval->getFillColor();
     * -------------------------------------------
     * Returns the color used to display the filled region of this oval.  If
     * none has been set, <code>getFillColor</code> returns the empty string.
     */
    std::string getFillColor() const;

    /*
     * Method: isFilled
     * Usage: if (oval->isFilled()) ...
     * --------------------------------
     * Returns <code>true</code> if the oval is filled.
     */
    bool isFilled() const;

    /*
     * Method: setSize
     * Usage: oval->setSize(size);
     *        oval->setSize(width, height);
     * ------------------------------------
     * Changes the size of the bounding rectangle to the specified width
     * and height.
     */
    void setSize(double width, double height);
    void setSize(const GDimension& size);

    /*
     * Method: setBounds
     * Usage: oval->setBounds(rect);
     *        oval->setBounds(x, y, width, height);
     * --------------------------------------------
     * Changes the bounds of the oval to the specified values.
     */
    void setBounds(double x, double y, double width, double height);
    void setBounds(const GRectangle& size);

    /*
     * Method: setFillColor
     * Usage: oval->setFillColor(color);
     * ---------------------------------
     * Sets the color used to display the filled region of this oval.
     * As a side effect, sets this object to be filled (setFilled(true)).
     * If an empty string is passed, sets filled to false.
     */
    void setFillColor(const std::string& color);
    void setFillColor(int rgb);

    /*
     * Method: setFilled
     * Usage: oval->setFilled(flag);
     * -----------------------------
     * Sets the fill status for the oval, where <code>false</code> is
     * outlined and <code>true</code> is filled.
     */
    void setFilled(bool flag);

    /* Prototypes for the virtual methods */
    virtual bool contains(double x, double y) const;
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

protected:
    /* Instance variables */
    double width;           /* The width of the bounding rectangle     */
    double height;          /* The height of the bounding rectangle    */
    bool fillFlag;          /* Indicates whether the object is filled  */
    std::string fillColor;  /* Color used to fill the object           */

    /* Protected methods */
    void createGOval(double width, double height);
};

/*
 * Class: GArc
 * -----------
 * This graphical object subclass represents an elliptical arc.  The
 * arc is specified by the following parameters:
 *
 * <p><ul>
 *   <li>The coordinates of the bounding rectangle (<code>x</code>,
 *       <code>y</code>, <code>width</code>, <code>height</code>)
 *   <li>The angle at which the arc starts (<code>start</code>)
 *   <li>The number of degrees that the arc covers (<code>sweep</code>)
 * </ul>
 *
 * <p>All angles in a <code>GArc</code> description are measured in
 * degrees moving counterclockwise from the +<i>x</i> axis.  Negative
 * values for either <code>start</code> or <code>sweep</code> indicate
 * motion in a clockwise direction.
 * <include src="pictures/GObjectDiagrams/GArcGeometry.html">
 */
class GArc : public GObject {
public:
    /*
     * Constructor: GArc
     * Usage: GArc *arc = new GArc(width, height, start, sweep);
     *        GArc *arc = new GArc(x, y, width, height, start, sweep);
     * ---------------------------------------------------------------
     * Creates a new <code>GArc</code> object consisting of an elliptical arc.
     * The first form creates a <code>GArc</code> whose origin is the point
     * (0,&nbsp;0); the second form positions the <code>GArc</code> at the
     * point (<code>x</code>, <code>y</code>).
     * <include src="pictures/GObjectDiagrams/GArcExamples.html">
     */
    GArc(double width, double height, double start, double sweep);
    GArc(double x, double y, double width, double height,
         double start, double sweep);

    /*
     * Method: getEndPoint
     * Usage: GPoint pt = arc->getEndPoint();
     * --------------------------------------
     * Returns the point at which the arc ends.
     */
    GPoint getEndPoint() const;

    /*
     * Method: getFillColor
     * Usage: string color = arc->getFillColor();
     * ------------------------------------------
     * Returns the color used to display the filled region of this arc.  If
     * none has been set, <code>getFillColor</code> returns the empty string.
     */
    std::string getFillColor() const;

    /*
     * Method: getFrameRectangle
     * Usage: GRectangle rect = arc->getFrameRectangle();
     * --------------------------------------------------
     * Returns the boundaries of the rectangle used to frame the arc.
     */
    GRectangle getFrameRectangle() const;

    /*
     * Method: getStartAngle
     * Usage: double angle = arc->getStartAngle();
     * -------------------------------------------
     * Returns the starting angle for this <code>GArc</code> object.
     */
    double getStartAngle() const;

    /*
     * Method: getStartPoint
     * Usage: GPoint pt = arc->getStartPoint();
     * ----------------------------------------
     * Returns the point at which the arc starts.
     */
    GPoint getStartPoint() const;

    /*
     * Method: getSweepAngle
     * Usage: double angle = arc->getSweepAngle();
     * -------------------------------------------
     * Returns the sweep angle for this <code>GArc</code> object.
     */
    double getSweepAngle() const;

    /*
     * Method: isFilled
     * Usage: if (arc->isFilled()) ...
     * -------------------------------
     * Returns <code>true</code> if the arc is filled.
     */
    bool isFilled() const;

    /*
     * Method: setFillColor
     * Usage: arc->setFillColor(color);
     * --------------------------------
     * Sets the color used to display the filled region of this arc.
     * Colors are specified as strings as described in the notes for the
     * <a href="GObject-class.html#Method:setColor"><code>setColor</code></a>
     * method.
     */
    void setFillColor(const std::string& color);
    void setFillColor(int rgb);

    /*
     * Method: setFilled
     * Usage: arc->setFilled(flag);
     * ----------------------------
     * Sets the fill status for the arc, where <code>false</code> is
     * outlined and <code>true</code> is filled.  If a <code>GArc</code> is
     * unfilled, the figure consists only of the arc itself.  If a
     * <code>GArc</code> is filled, the figure consists of the
     * pie-shaped wedge formed by connecting the endpoints of the arc to
     * the center.  As an example, the following program draws a 270-degree
     * arc starting at 45 degrees, filled in yellow, much like the character
     * in the PacMan video game:
     *
     *<pre>
     *    int main() {
     *       GWindow gw;
     *       cout << "This program draws the PacMan character." << endl;
     *       double cx = gw.getWidth() / 2;
     *       double cy = gw.getHeight() / 2;
     *       double r = 25;
     *       GArc *pacman = new GArc(cx - r, cy - r, 2 * r, 2 * r, 45, 270);
     *       pacman->setFilled(true);
     *       pacman->setFillColor("YELLOW");
     *       gw.add(pacman);
     *       return 0;
     *    }
     *</pre>
     * <include src="pictures/GObjectDiagrams/PacMan.html">
     */
    void setFilled(bool flag);

    /*
     * Method: setFrameRectangle
     * Usage: arc->setFrameRectangle(rect);
     *        arc->setFrameRectangle(x, y, width, height);
     * ---------------------------------------------------
     * Changes the boundaries of the rectangle used to frame the arc.
     */
    void setFrameRectangle(const GRectangle& rect);
    void setFrameRectangle(double x, double y, double width, double height);

    /*
     * Method: setStartAngle
     * Usage: arc->setStartAngle(start);
     * ---------------------------------
     * Sets the starting angle for this <code>GArc</code> object.
     */
    void setStartAngle(double start);

    /*
     * Method: setSweepAngle
     * Usage: arc->setSweepAngle(start);
     * ---------------------------------
     * Sets the sweep angle for this <code>GArc</code> object.
     */
    void setSweepAngle(double start);

    /* Prototypes for the virtual methods */
    virtual bool contains(double x, double y) const;
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

private:
    bool containsAngle(double theta) const;
    void createGArc(double width, double height, double start, double sweep);
    GPoint getArcPoint(double theta) const;

    /* Instance variables */
    double start;                   /* Starting angle of the arc       */
    double sweep;                   /* How many degrees the arc runs   */
    double frameWidth;              /* The width of the bounding box   */
    double frameHeight;             /* The height of the bounding box  */
    std::string fillColor;          /* The color of the interior       */
    bool fillFlag;                  /* Indicates if the arc is filled  */
};

/*
 * Class: GCompound
 * ----------------
 * This graphical object subclass consists of a collection
 * of other graphical objects.  Once assembled, the internal objects
 * can be manipulated as a unit.  The <code>GCompound</code> keeps
 * track of its own position, and all items within it are drawn
 * relative to that location.
 */
class GCompound : public GObject {
public:
    /*
     * Constructor: GCompound
     * Usage: GCompound *comp = new GCompound();
     * -----------------------------------------
     * Creates a <code>GCompound</code> object with no internal components.
     */
    GCompound();

    /*
     * Method: add
     * Usage: comp->add(gobj);
     *        comp->add(gobj, x, y);
     * -----------------------------
     * Adds a new graphical object to the <code>GCompound</code>.  The second
     * form moves the object to the point (<code>x</code>, <code>y</code>) first.
     */
    void add(GObject* gobj);
    void add(GObject* gobj, double x, double y);

    /*
     * Method: getElement
     * Usage: GObject* gobj = comp->getElement(index);
     * -----------------------------------------------
     * Returns a pointer to the graphical object at the specified index,
     * numbering from back to front in the the <i>z</i> dimension.
     */
    GObject* getElement(int index) const;

    /*
     * Method: getElementAt
     * Usage: GObject* gobj = comp->getElementAt(x, y);
     * ------------------------------------------------
     * Returns a pointer to the first graphical object that contains the given
     * (x, y) point, or a null pointer if no object in this compound touches it.
     */
    GObject* getElementAt(double x, double y) const;

    /*
     * Method: getElementCount
     * Usage: int n = comp->getElementCount();
     * ---------------------------------------
     * Returns the number of graphical objects stored in the
     * <code>GCompound</code>.
     */
    int getElementCount() const;

    /*
     * Method: remove
     * Usage: comp->remove(gobj);
     * --------------------------
     * Removes the specified object from the <code>GCompound</code>.
     */
    void remove(GObject* gobj);

    /*
     * Method: removeAll
     * Usage: comp->removeAll();
     * -------------------------
     * Removes all graphical objects from the <code>GCompound</code>.
     */
    void removeAll();

    /* Prototypes for the virtual methods */
    virtual bool contains(double x, double y) const;
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

private:
    void sendBackward(GObject* gobj);
    void sendForward(GObject* gobj);
    void sendToBack(GObject* gobj);
    void sendToFront(GObject* gobj);
    int findGObject(GObject* gobj) const;
    void removeAt(int index);

    /* Instance variables */
    Vector<GObject*> contents;

    /* Friend declarations */
    friend class GObject;
};

/*
 * Class: GImage
 * -------------
 * This graphical object subclass represents an image from a file.
 * For example, the following code displays a <code>GImage</code>
 * containing the Stanford tree at the center of the window, assuming
 * that the image file <code>StanfordTree.png</code> exists, either in
 * the current directory or an <code>images</code> subdirectory:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws the Stanford tree." << endl;
 *       GImage *tree = new GImage("StanfordTree.png");
 *       double x = (gw.getWidth() - tree->getWidth()) / 2;
 *       double y = (gw.getHeight() - tree->getHeight()) / 2;
 *       gw.add(tree, x, y);
 *       return 0;
 *    }
 *</pre>
 */
class GImage : public GObject {
public:
    /*
     * Constructor: GImage
     * Usage: GImage* image = new GImage(filename);
     *        GImage* image = new GImage(filename, x, y);
     * --------------------------------------------------
     * Constructs a new image by loading the image from the specified
     * file, which is either in the current directory or a subdirectory named
     * <code>images</code>.  By default, the upper left corner of the image
     * appears at the origin; the second form automatically sets the location
     * to the point (<code>x</code>, <code>y</code>).
     */
    GImage(const std::string& filename);
    GImage(const std::string& filename, double x, double y);

    /* Prototypes for the virtual methods */
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

private:
    std::string filename;
    double width;
    double height;

    void createGImage(const std::string& filename);
};

/*
 * Class: GLabel
 * -------------
 * This graphical object subclass represents a text string.  For
 * example, the following code adds a <code>GLabel</code> containing
 * the string <code>"hello, world"</code> to the center of the window:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws the 'hello, world' message." << endl;
 *       GLabel *label = new GLabel("hello, world");
 *       label->setFont("SansSerif-18");
 *       double x = (gw.getWidth() - label->getWidth()) / 2;
 *       double y = (gw.getHeight() + label->getFontAscent()) / 2;
 *       gw.add(label, x, y);
 *       return 0;
 *    }
 *</pre>
 *
 * Controlling the appearance and positioning of a <code>GLabel</code>
 * depends on understanding the following terms:
 *
 * <p><ul>
 *   <li>The <b><i>baseline</i></b> is the horizontal line on which the
 *       characters rest.
 *   <li>The <b><i>origin</i></b> is the point on the baseline at which
 *       the label begins.
 *   <li>The <b><i>height</i></b> is the distance that separate two
 *       successive lines.
 *   <li>The <b><i>ascent</i></b> is the maximum distance a character
 *       in this font extends above the baseline.
 *   <li>The <b><i>descent</i></b> is the maximum distance a character
 *       in this font extends below the baseline.
 * </ul>
 * <include src="pictures/GObjectDiagrams/GLabelGeometry.html">
 */
class GLabel : public GObject {
public:
    /*
     * Constructor: GLabel
     * Usage: GLabel *label = new GLabel(str);
     *        GLabel *label = new GLabel(str, x, y);
     * ---------------------------------------------
     * Creates a <code>GLabel</code> object containing the specified string.
     * By default, the baseline of the first character appears at the origin;
     * the second form automatically resets the location of the
     * <code>GLabel</code> to the point (<code>x</code>, <code>y</code>).
     */
    GLabel(const std::string& str = "");
    GLabel(const std::string& str, double x, double y);

    /*
     * Method: getFont
     * Usage: string font = label->getFont();
     * --------------------------------------
     * Returns the current font for the <code>GLabel</code>.
     */
    std::string getFont() const;

    /*
     * Method: getFontAscent
     * Usage: double ascent = label->getFontAscent();
     * ----------------------------------------------
     * Returns the maximum distance strings in this font extend above
     * the baseline.
     */
    double getFontAscent() const;

    /*
     * Method: getFontDescent
     * Usage: double descent = label->getFontDescent();
     * ------------------------------------------------
     * Returns the maximum distance strings in this font descend below
     * the baseline.
     */
    double getFontDescent() const;

    /*
     * Method: getLabel
     * Usage: string str = label->getLabel();
     * --------------------------------------
     * Returns the string displayed by this object.
     */
    std::string getLabel() const;
    std::string getText() const;

    /*
     * Method: setFont
     * Usage: label->setFont(font);
     * ----------------------------
     * Changes the font used to display the <code>GLabel</code> as specified by
     * the string <code>font</code>, which has the following format:
     *
     *<pre>
     *    family-style-size
     *</pre>
     *
     * where both <code>style</code> and <code>size</code> are optional.
     * If any of these elements are missing or specified as an asterisk,
     * the existing value is retained.
     */
    void setFont(const std::string& font);

    /*
     * Method: setLabel
     * Usage: label->setLabel(str);
     * ----------------------------
     * Changes the string stored within the <code>GLabel</code> object, so that
     * a new text string appears on the display.
     */
    void setLabel(const std::string& str);
    void setText(const std::string& str);

    /* Prototypes for the virtual methods */
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

private:
    /* Instance variables */
    std::string str;                /* The string displayed by the label */
    std::string font;               /* The font string of the label      */
    double width;                   /* Width of the bounding box         */
    double height;                  /* Height of the bounding box        */
    double ascent;                  /* Font ascent                       */
    double descent;                 /* Font descent                      */

    void createGLabel(const std::string& str);
};

/*
 * Class: GLine
 * ------------
 * This graphical object subclass represents a line segment.  For
 * example, the following code adds lines that mark the diagonals
 * of the graphics window:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws the diagonals on the window." << endl;
 *       gw.add(new GLine(0, 0, gw.getWidth(), gw.getHeight()));
 *       gw.add(new GLine(0, gw.getHeight(), gw.getWidth(), 0));
 *       return 0;
 *    }
 *</pre>
 */
class GLine : public GObject {
public:
    /*
     * Constructor: GLine
     * Usage: GLine* gline = new GLine(x0, y0, x1, y1);
     * ------------------------------------------------
     * Constructs a line segment from its endpoints.  The point
     * (<code>x0</code>,&nbsp;<code>y0</code>) defines the start of the
     * line and the point (<code>x1</code>,&nbsp;<code>y1</code>) defines
     * the end.
     */
    GLine(double x0, double y0, double x1, double y1);

    /*
     * Method: getEndPoint
     * Usage: GPoint pt = line->getEndPoint();
     * ---------------------------------------
     * Returns the point at which the line ends.
     */
    GPoint getEndPoint() const;

    /*
     * Method: getStartPoint
     * Usage: GPoint pt = line->getStartPoint();
     * -----------------------------------------
     * Returns the point at which the line starts.
     */
    GPoint getStartPoint() const;

    /*
     * Method: setEndPoint
     * Usage: line->setEndPoint(x, y);
     * -------------------------------
     * Sets the end point in the line to (<code>x</code>,&nbsp;<code>y</code>),
     * leaving the start point unchanged.  This method is therefore different from
     * <code>setLocation</code>, which moves both components of the line segment.
     */
    void setEndPoint(double x, double y);

    /*
     * Method: setStartPoint
     * Usage: line->setStartPoint(x, y);
     * ---------------------------------
     * Sets the initial point in the line to (<code>x</code>,&nbsp;<code>y</code>),
     * leaving the end point unchanged.  This method is therefore different from
     * <code>setLocation</code>, which moves both components of the line segment.
     */
    void setStartPoint(double x, double y);

    /* Prototypes for the virtual methods */
    virtual bool contains(double x, double y) const;
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

protected:
    /* Instance variables */
    double dx;                   /* The x displacement of the line */
    double dy;                   /* The y displacement of the line */
};

/*
 * Class: GPolygon
 * ---------------
 * This graphical object subclass represents a polygon bounded by
 * line segments.  The <code>GPolygon</code> constructor creates an
 * empty polygon.  To complete the figure, you need to add vertices
 * to the polygon using the methods
 * <a href="#Method:addVertex"><code>addVertex</code></a>,
 * <a href="#Method:addEdge"><code>addEdge</code></a>,
 * and <a href="#Method:addPolarEdge"><code>addPolarEdge</code></a>.
 * As an example, the following code adds a filled red octagon to
 * the center of the window:
 *
 *<pre>
 *    int main() {
 *       GWindow gw;
 *       cout << "This program draws a red octagon." << endl;
 *       double edge = 75;
 *       GPolygon* stopSign = new GPolygon();
 *       stopSign->addVertex(-edge / 2, edge / 2 + edge / sqrt(2.0));
 *       for (int i = 0; i < 8; i++) {
 *          stopSign->addPolarEdge(edge, 45 * i);
 *       }
 *       stopSign->setFilled(true);
 *       stopSign->setColor("RED");
 *       gw.add(stopSign, gw.getWidth() / 2, gw.getHeight() / 2);
 *       return 0;
 *    }
 *</pre>
 * <include src="pictures/GObjectDiagrams/StopSign.html">
 */
class GPolygon : public GObject {
public:
    /*
     * Constructor: GPolygon
     * Usage: GPolygon *poly = new GPolygon();
     * ---------------------------------------
     * Constructs a new empty polygon at the origin.
     */
    GPolygon();

    /*
     * Method: addEdge
     * Usage: poly->addEdge(dx, dy);
     * -----------------------------
     * Adds an edge to the polygon whose components are given by the displacements
     * <code>dx</code> and <code>dy</code> from the last vertex.
     */
    void addEdge(double dx, double dy);

    /*
     * Method: addPolarEdge
     * Usage: poly->addPolarEdge(r, theta);
     * ------------------------------------
     * Adds an edge to the polygon specified in polar coordinates.  The length
     * of the edge is given by <code>r</code>, and the edge extends in
     * direction <code>theta</code>, measured in degrees counterclockwise
     * from the +x axis.
     */
    void addPolarEdge(double r, double theta);

    /*
     * Method: addVertex
     * Usage: poly->addVertex(x, y);
     * -----------------------------
     * Adds a vertex at (<code>x</code>, <code>y</code>) relative to the polygon
     * origin.
     */
    void addVertex(double x, double y);

    /*
     * Method: getFillColor
     * Usage: string color = poly->getFillColor();
     * -------------------------------------------
     * Returns the color used to display the filled region of this polygon.  If
     * none has been set, <code>getFillColor</code> returns the empty string.
     */
    std::string getFillColor() const;

    /*
     * Method: getVertices
     * Usage: Vector<GPoint> vec = poly->getVertices();
     * ------------------------------------------------
     * Returns a vector of the points in the polygon.
     */
    Vector<GPoint> getVertices() const;

    /*
     * Method: isFilled
     * Usage: if (poly->isFilled()) ...
     * --------------------------------
     * Returns <code>true</code> if the polygon is filled.
     */
    bool isFilled() const;

    /*
     * Method: setFillColor
     * Usage: poly->setFillColor(color);
     * ---------------------------------
     * Sets the color used to display the filled region of this polygon.
     */
    void setFillColor(const std::string& color);
    void setFillColor(int rgb);

    /*
     * Method: setFilled
     * Usage: poly->setFilled(flag);
     * -----------------------------
     * Sets the fill status for the polygon, where <code>false</code> is
     * outlined and <code>true</code> is filled.
     */
    void setFilled(bool flag);

    /* Prototypes for the virtual methods */
    virtual bool contains(double x, double y) const;
    virtual GRectangle getBounds() const;
    virtual std::string getType() const;
    virtual std::string toString() const;

private:
    /* Instance variables */
    Vector<GPoint> vertices;        /* The vertices of the polygon   */
    double cx;                      /* The most recent x coordinate  */
    double cy;                      /* The most recent y coordinate  */
    std::string fillColor;          /* The color of the interior     */
    bool fillFlag;                  /* Indicates if object is filled */
};

#include "private/init.h"   // ensure that Stanford C++ lib is initialized

#endif // _gobjects_h
