gui-cs.Terminal.Gui/Terminal.Gui/Types/Rectangle.cs

//
// Derived from System.Drawing.Rectangle.cs
//
// Author:
//   Mike Kestner ([email protected])
//
// Copyright (C) 2001 Mike Kestner
// Copyright (C) 2004 Novell, Inc.  http://www.novell.com 
//

namespace Terminal.Gui;

/// <summary>Stores a set of four integers that represent the location and size of a rectangle</summary>
public struct Rectangle
{
    private int width;
    private int height;

    /// <summary>Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.</summary>
    public int X;

    /// <summary>Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.</summary>
    public int Y;

    /// <summary>Gets or sets the width of this Rect structure.</summary>
    public int Width
    {
        get => width;
        set
        {
            if (value < 0)
            {
                throw new ArgumentException ("Width must be greater or equal to 0.");
            }

            width = value;
        }
    }

    /// <summary>Gets or sets the height of this Rectangle structure.</summary>
    public int Height
    {
        get => height;
        set
        {
            if (value < 0)
            {
                throw new ArgumentException ("Height must be greater or equal to 0.");
            }

            height = value;
        }
    }

    /// <summary>Empty Shared Field</summary>
    /// <remarks>An uninitialized Rectangle Structure.</remarks>
    public static readonly Rectangle Empty;

    /// <summary>FromLTRB Shared Method</summary>
    /// <remarks>Produces a Rectangle structure from left, top, right and bottom coordinates.</remarks>
    public static Rectangle FromLTRB (
        int left,
        int top,
        int right,
        int bottom
    )
    {
        return new Rectangle (
                         left,
                         top,
                         right - left,
                         bottom - top
                        );
    }

    /// <summary>Produces a new Rect by inflating an existing Rect by the specified coordinate values.</summary>
    /// <remarks>
    ///     Produces a new Rect by inflating an existing Rect by the specified coordinate values. The rectangle is
    ///     enlarged in both directions along an axis.
    /// </remarks>
    public static Rectangle Inflate (Rectangle rect, int x, int y)
    {
        var r = new Rectangle (rect.Location, rect.Size);
        r.Inflate (x, y);

        return r;
    }

    /// <summary>Inflates an existing Rect by the specified coordinate values.</summary>
    /// <remarks>
    ///     This method enlarges this rectangle, not a copy of it. The rectangle is enlarged in both directions along an
    ///     axis.
    /// </remarks>
    public void Inflate (int width, int height)
    {
        // Set dims first so we don't lose the original values on exception
        Width += width * 2;
        Height += height * 2;

        X -= width;
        Y -= height;
    }

    /// <summary>Inflates an existing Rect by the specified Sizwe.</summary>
    /// <remarks>
    ///     This method enlarges this rectangle, not a copy of it. The rectangle is enlarged in both directions along an
    ///     axis.
    /// </remarks>
    public void Inflate (Size size) { Inflate (size.Width, size.Height); }

    /// <summary>Intersect Shared Method</summary>
    /// <remarks>Produces a new Rectangle by intersecting 2 existing Rectangles. Returns Empty if there is no intersection.</remarks>
    public static Rectangle Intersect (Rectangle a, Rectangle b)
    {
        // MS.NET returns a non-empty rectangle if the two rectangles
        // touch each other
        if (!a.IntersectsWithInclusive (b))
        {
            return Empty;
        }

        return FromLTRB (
                         Math.Max (a.Left, b.Left),
                         Math.Max (a.Top, b.Top),
                         Math.Min (a.Right, b.Right),
                         Math.Min (a.Bottom, b.Bottom)
                        );
    }

    /// <summary>Intersect Method</summary>
    /// <remarks>Replaces the Rectangle with the intersection of itself and another Rectangle.</remarks>
    public void Intersect (Rectangle rect) { this = Intersect (this, rect); }

    /// <summary>Produces the uninion of two rectangles.</summary>
    /// <remarks>Produces a new Rectangle from the union of 2 existing Rectangles.</remarks>
    public static Rectangle Union (Rectangle a, Rectangle b)
    {
        //int x1 = Math.Min (a.X, b.X);
        //int x2 = Math.Max (a.X + a.Width, b.X + b.Width);
        //int y1 = Math.Min (a.Y, b.Y);oS
        //int y2 = Math.Max (a.Y + a.Height, b.Y + b.Height);
        //return new Rect (x1, y1, x2 - x1, y2 - y1);

        int x1 = Math.Min (a.X, b.X);
        int x2 = Math.Max (a.X + Math.Abs (a.Width), b.X + Math.Abs (b.Width));
        int y1 = Math.Min (a.Y, b.Y);
        int y2 = Math.Max (a.Y + Math.Abs (a.Height), b.Y + Math.Abs (b.Height));

        return new Rectangle (x1, y1, x2 - x1, y2 - y1);
    }

    /// <summary>Equality Operator</summary>
    /// <remarks>
    ///     Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size
    ///     properties of the two Rectangles.
    /// </remarks>
    public static bool operator == (Rectangle left, Rectangle right) { return left.Location == right.Location && left.Size == right.Size; }

    /// <summary>Inequality Operator</summary>
    /// <remarks>
    ///     Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size
    ///     properties of the two Rectangles.
    /// </remarks>
    public static bool operator != (Rectangle left, Rectangle right) { return left.Location != right.Location || left.Size != right.Size; }

    // -----------------------
    // Public Constructors
    // -----------------------

    /// <summary>Rectangle Constructor</summary>
    /// <remarks>Creates a Rectangle from Point and Size values.</remarks>
    public Rectangle (Point location, Size size)
    {
        X = location.X;
        Y = location.Y;
        width = size.Width;
        height = size.Height;
        Width = width;
        Height = height;
    }

    /// <summary>Rectangle Constructor</summary>
    /// <remarks>Creates a Rectangle from a specified x,y location and width and height values.</remarks>
    public Rectangle (int x, int y, int width, int height)
    {
        X = x;
        Y = y;
        this.width = width;
        this.height = height;
        Width = this.width;
        Height = this.height;
    }

    /// <summary>Bottom Property</summary>
    /// <remarks>The Y coordinate of the bottom edge of the Rectangle. Read only.</remarks>
    public int Bottom => Y + Height;

    /// <summary>IsEmpty Property</summary>
    /// <remarks>Indicates if the width or height are zero. Read only.</remarks>
    public bool IsEmpty => X == 0 && Y == 0 && Width == 0 && Height == 0;

    /// <summary>Left Property</summary>
    /// <remarks>The X coordinate of the left edge of the Rectangle. Read only.</remarks>
    public int Left => X;

    /// <summary>Location Property</summary>
    /// <remarks>The Location of the top-left corner of the Rectangle.</remarks>
    public Point Location
    {
        get => new (X, Y);
        set
        {
            X = value.X;
            Y = value.Y;
        }
    }

    /// <summary>Right Property</summary>
    /// <remarks>The X coordinate of the right edge of the Rectangle. Read only.</remarks>
    public int Right => X + Width;

    /// <summary>Size Property</summary>
    /// <remarks>The Size of the Rectangle.</remarks>
    public Size Size
    {
        get => new (Width, Height);
        set
        {
            Width = value.Width;
            Height = value.Height;
        }
    }

    /// <summary>Top Property</summary>
    /// <remarks>The Y coordinate of the top edge of the Rectangle. Read only.</remarks>
    public int Top => Y;

    /// <summary>Contains Method</summary>
    /// <remarks>Checks if an x,y coordinate lies within this Rectangle.</remarks>
    public bool Contains (int x, int y) { return x >= Left && x < Right && y >= Top && y < Bottom; }

    /// <summary>Contains Method</summary>
    /// <remarks>Checks if a Point lies within this Rectangle.</remarks>
    public bool Contains (Point pt) { return Contains (pt.X, pt.Y); }

    /// <summary>Contains Method</summary>
    /// <remarks>Checks if a Rectangle lies entirely within this Rectangle.</remarks>
    public bool Contains (Rectangle rect) { return rect == Intersect (this, rect); }

    /// <summary>Equals Method</summary>
    /// <remarks>Checks equivalence of this Rectangle and another object.</remarks>
    public override bool Equals (object obj)
    {
        if (!(obj is Rectangle))
        {
            return false;
        }

        return this == (Rectangle)obj;
    }

    /// <summary>GetHashCode Method</summary>
    /// <remarks>Calculates a hashing value.</remarks>
    public override int GetHashCode () { return (Height + Width) ^ (X + Y); }

    /// <summary>IntersectsWith Method</summary>
    /// <remarks>Checks if a Rectangle intersects with this one.</remarks>
    public bool IntersectsWith (Rectangle rect) { return !(Left >= rect.Right || Right <= rect.Left || Top >= rect.Bottom || Bottom <= rect.Top); }

    private bool IntersectsWithInclusive (Rectangle r) { return !(Left > r.Right || Right < r.Left || Top > r.Bottom || Bottom < r.Top); }

    /// <summary>Offset Method</summary>
    /// <remarks>Moves the Rectangle a specified distance.</remarks>
    public void Offset (int x, int y)
    {
        X += x;
        Y += y;
    }

    /// <summary>Offset Method</summary>
    /// <remarks>Moves the Rectangle a specified distance.</remarks>
    public void Offset (Point pos)
    {
        X += pos.X;
        Y += pos.Y;
    }

    /// <summary>ToString Method</summary>
    /// <remarks>Formats the Rectangle as a string in (x,y,w,h) notation.</remarks>
    public override string ToString () { return $"{{X={X},Y={Y},Width={Width},Height={Height}}}"; }
}