// Copyright (c) 2010-2014 SharpDX - Alexandre Mutel // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. using System; using System.Globalization; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using SharpDX.Mathematics.Interop; namespace SharpDX { /// /// Define a Rectangle. This structure is slightly different from System.Drawing.Rectangle as it is /// internally storing Left,Top,Right,Bottom instead of Left,Top,Width,Height. /// [StructLayout(LayoutKind.Sequential)] public struct Rectangle : IEquatable { /// /// The left. /// public int Left; /// /// The top. /// public int Top; /// /// The right. /// public int Right; /// /// The bottom. /// public int Bottom; /// /// An empty rectangle. /// public static readonly Rectangle Empty; static Rectangle() { Empty = new Rectangle(); } /// /// Initializes a new instance of the struct. /// /// The left. /// The top. /// The width. /// The height. public Rectangle(int x, int y, int width, int height) { Left = x; Top = y; Right = x + width; Bottom = y + height; } /// /// Gets or sets the X position. /// /// The X position. public int X { get { return Left; } set { Right = value + Width; Left = value; } } /// /// Gets or sets the Y position. /// /// The Y position. public int Y { get { return Top; } set { Bottom = value + Height; Top = value; } } /// /// Gets or sets the width. /// /// The width. public int Width { get { return Right - Left; } set { Right = Left + value; } } /// /// Gets or sets the height. /// /// The height. public int Height { get { return Bottom - Top; } set { Bottom = Top + value; } } /// /// Gets a value that indicates whether the rectangle is empty. /// /// /// true if [is empty]; otherwise, false. /// public bool IsEmpty { get { return (Width == 0) && (Height == 0) && (X == 0) && (Y == 0); } } ///// ///// Gets or sets the location. ///// ///// ///// The location. ///// //public Point Location //{ // get // { // return new Point(X, Y); // } // set // { // X = value.X; // Y = value.Y; // } //} ///// ///// Gets the Point that specifies the center of the rectangle. ///// ///// ///// The center. ///// //public Point Center //{ // get // { // return new Point(X + (Width / 2), Y + (Height / 2)); // } //} ///// ///// Gets or sets the size of the rectangle. ///// ///// The size of the rectangle. //public Size2 Size //{ // get // { // return new Size2(Width, Height); // } // set // { // Width = value.Width; // Height = value.Height; // } //} ///// ///// Gets the position of the top-left corner of the rectangle. ///// ///// The top-left corner of the rectangle. //public Point TopLeft { get { return new Point(_left, _top); } } ///// ///// Gets the position of the top-right corner of the rectangle. ///// ///// The top-right corner of the rectangle. //public Point TopRight { get { return new Point(_right, _top); } } ///// ///// Gets the position of the bottom-left corner of the rectangle. ///// ///// The bottom-left corner of the rectangle. //public Point BottomLeft { get { return new Point(_left, _bottom); } } ///// ///// Gets the position of the bottom-right corner of the rectangle. ///// ///// The bottom-right corner of the rectangle. //public Point BottomRight { get { return new Point(_right, _bottom); } } ///// Changes the position of the rectangle. ///// The values to adjust the position of the rectangle by. //public void Offset(Point amount) //{ // Offset(amount.X, amount.Y); //} /// Changes the position of the rectangle. /// Change in the x-position. /// Change in the y-position. public void Offset(int offsetX, int offsetY) { X += offsetX; Y += offsetY; } /// Pushes the edges of the rectangle out by the horizontal and vertical values specified. /// Value to push the sides out by. /// Value to push the top and bottom out by. public void Inflate(int horizontalAmount, int verticalAmount) { X -= horizontalAmount; Y -= verticalAmount; Width += horizontalAmount * 2; Height += verticalAmount * 2; } /// Determines whether this rectangle contains a specified point represented by its x- and y-coordinates. /// The x-coordinate of the specified point. /// The y-coordinate of the specified point. public bool Contains(int x, int y) { return (X <= x) && (x < Right) && (Y <= y) && (y < Bottom); } ///// Determines whether this rectangle contains a specified Point. ///// The Point to evaluate. //public bool Contains(Point value) //{ // bool result; // Contains(ref value, out result); // return result; //} ///// Determines whether this rectangle contains a specified Point. ///// The Point to evaluate. ///// [OutAttribute] true if the specified Point is contained within this rectangle; false otherwise. //public void Contains(ref Point value, out bool result) //{ // result = (X <= value.X) && (value.X < Right) && (Y <= value.Y) && (value.Y < Bottom); //} /// Determines whether this rectangle entirely contains a specified rectangle. /// The rectangle to evaluate. public bool Contains(Rectangle value) { bool result; Contains(ref value, out result); return result; } /// Determines whether this rectangle entirely contains a specified rectangle. /// The rectangle to evaluate. /// [OutAttribute] On exit, is true if this rectangle entirely contains the specified rectangle, or false if not. public void Contains(ref Rectangle value, out bool result) { result = (X <= value.X) && (value.Right <= Right) && (Y <= value.Y) && (value.Bottom <= Bottom); } /// /// Checks, if specified point is inside . /// /// X point coordinate. /// Y point coordinate. /// true if point is inside , otherwise false. public bool Contains(float x, float y) { return (x >= Left && x <= Right && y >= Top && y <= Bottom); } ///// ///// Checks, if specified is inside . ///// ///// Coordinate . ///// true if is inside , otherwise false. //public bool Contains(Vector2 vector2D) //{ // return Contains(vector2D.X, vector2D.Y); //} /// Determines whether a specified rectangle intersects with this rectangle. /// The rectangle to evaluate. public bool Intersects(Rectangle value) { bool result; Intersects(ref value, out result); return result; } /// /// Determines whether a specified rectangle intersects with this rectangle. /// /// The rectangle to evaluate /// [OutAttribute] true if the specified rectangle intersects with this one; false otherwise. public void Intersects(ref Rectangle value, out bool result) { result = (value.X < Right) && (X < value.Right) && (value.Y < Bottom) && (Y < value.Bottom); } /// /// Creates a rectangle defining the area where one rectangle overlaps with another rectangle. /// /// The first rectangle to compare. /// The second rectangle to compare. /// The intersection rectangle. public static Rectangle Intersect(Rectangle value1, Rectangle value2) { Rectangle result; Intersect(ref value1, ref value2, out result); return result; } /// Creates a rectangle defining the area where one rectangle overlaps with another rectangle. /// The first rectangle to compare. /// The second rectangle to compare. /// [OutAttribute] The area where the two first parameters overlap. public static void Intersect(ref Rectangle value1, ref Rectangle value2, out Rectangle result) { int newLeft = (value1.X > value2.X) ? value1.X : value2.X; int newTop = (value1.Y > value2.Y) ? value1.Y : value2.Y; int newRight = (value1.Right < value2.Right) ? value1.Right : value2.Right; int newBottom = (value1.Bottom < value2.Bottom) ? value1.Bottom : value2.Bottom; if ((newRight > newLeft) && (newBottom > newTop)) { result = new Rectangle(newLeft, newTop, newRight - newLeft, newBottom - newTop); } else { result = Empty; } } /// /// Creates a new rectangle that exactly contains two other rectangles. /// /// The first rectangle to contain. /// The second rectangle to contain. /// The union rectangle. public static Rectangle Union(Rectangle value1, Rectangle value2) { Rectangle result; Union(ref value1, ref value2, out result); return result; } /// /// Creates a new rectangle that exactly contains two other rectangles. /// /// The first rectangle to contain. /// The second rectangle to contain. /// [OutAttribute] The rectangle that must be the union of the first two rectangles. public static void Union(ref Rectangle value1, ref Rectangle value2, out Rectangle result) { var left = Math.Min(value1.Left, value2.Left); var right = Math.Max(value1.Right, value2.Right); var top = Math.Min(value1.Top, value2.Top); var bottom = Math.Max(value1.Bottom, value2.Bottom); result = new Rectangle(left, top, right - left, bottom - top); } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// /// true if the specified is equal to this instance; otherwise, false. /// public override bool Equals(object obj) { if(!(obj is Rectangle)) return false; var strongValue = (Rectangle)obj; return Equals(ref strongValue); } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// /// true if the specified is equal to this instance; otherwise, false. /// [MethodImpl((MethodImplOptions)0x100)] // MethodImplOptions.AggressiveInlining public bool Equals(ref Rectangle other) { return other.Left == Left && other.Top == Top && other.Right == Right && other.Bottom == Bottom; } /// /// Determines whether the specified is equal to this instance. /// /// The to compare with this instance. /// /// true if the specified is equal to this instance; otherwise, false. /// [MethodImpl((MethodImplOptions)0x100)] // MethodImplOptions.AggressiveInlining public bool Equals(Rectangle other) { return Equals(ref other); } /// /// Returns a hash code for this instance. /// /// /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. /// public override int GetHashCode() { unchecked { int result = Left; result = (result * 397) ^ Top; result = (result * 397) ^ Right; result = (result * 397) ^ Bottom; return result; } } /// /// Implements the operator ==. /// /// The left. /// The right. /// The result of the operator. [MethodImpl((MethodImplOptions)0x100)] // MethodImplOptions.AggressiveInlining public static bool operator ==(Rectangle left, Rectangle right) { return left.Equals(ref right); } /// /// Implements the operator !=. /// /// The left. /// The right. /// The result of the operator. [MethodImpl((MethodImplOptions)0x100)] // MethodImplOptions.AggressiveInlining public static bool operator !=(Rectangle left, Rectangle right) { return !left.Equals(ref right); } ///// ///// Performs an implicit conversion to the structure. ///// ///// Performs direct converstion from int to float. ///// The source value. ///// The converted structure. //public static implicit operator RectangleF(Rectangle value) //{ // return new RectangleF(value.X, value.Y, value.Width, value.Height); //} public override string ToString() { return string.Format(CultureInfo.InvariantCulture, "X:{0} Y:{1} Width:{2} Height:{3}", X, Y, Width, Height); } internal void MakeXYAndWidthHeight() { Right = (Right - Left); Bottom = (Bottom - Top); } /// /// Performs an implicit conversion from to . /// /// The value. /// The result of the conversion. public unsafe static implicit operator RawRectangle(Rectangle value) { return *(RawRectangle*)&value; } /// /// Performs an implicit conversion from to . /// /// The value. /// The result of the conversion. public unsafe static implicit operator Rectangle(RawRectangle value) { return *(Rectangle*)&value; } /// /// Performs an implicit conversion from to . /// /// The value. /// The result of the conversion. public unsafe static implicit operator RawBox(Rectangle value) { return new RawBox(value.X, value.Y, value.Width, value.Height); } /// /// Performs an implicit conversion from to . /// /// The value. /// The result of the conversion. public unsafe static implicit operator Rectangle(RawBox value) { return new Rectangle(value.X, value.Y, value.Width, value.Height); } } }