#region --- License --- /* Copyright (c) 2006, 2007 Stefanos Apostolopoulos * See license.txt for license info */ #endregion using System; using System.Runtime.InteropServices; namespace OpenTK { /// /// Defines a 2d box (rectangle). /// [StructLayout(LayoutKind.Sequential)] public struct Box2 { /// /// The left boundary of the structure. /// public float Left; /// /// The right boundary of the structure. /// public float Right; /// /// The top boundary of the structure. /// public float Top; /// /// The bottom boundary of the structure. /// public float Bottom; /// /// Constructs a new Box2 with the specified dimensions. /// /// An OpenTK.Vector2 describing the top-left corner of the Box2. /// An OpenTK.Vector2 describing the bottom-right corner of the Box2. public Box2(Vector2 topLeft, Vector2 bottomRight) { Left = topLeft.X; Top = topLeft.Y; Right = bottomRight.X; Bottom = bottomRight.Y; } /// /// Constructs a new Box2 with the specified dimensions. /// /// The position of the left boundary. /// The position of the top boundary. /// The position of the right boundary. /// The position of the bottom boundary. public Box2(float left, float top, float right, float bottom) { Left = left; Top = top; Right = right; Bottom = bottom; } /// /// Creates a new Box2 with the specified dimensions. /// /// The position of the top boundary. /// The position of the left boundary. /// The position of the right boundary. /// The position of the bottom boundary. /// A new OpenTK.Box2 with the specfied dimensions. public static Box2 FromTLRB(float top, float left, float right, float bottom) { return new Box2(left, top, right, bottom); } /// /// Creates a new Box2 with the specified dimensions. /// /// The position of the top boundary. /// The position of the left boundary. /// The width of the box. /// The height of the box. /// A new OpenTK.Box2 with the specfied dimensions. public static Box2 FromDimensions(float left, float top, float width, float height) { return new Box2(left, top, left + width, top + height); } /// /// Creates a new Box2 with the specified dimensions. /// /// The position of the top left corner. /// The size of the box. /// A new OpenTK.Box2 with the specfied dimensions. public static Box2 FromDimensions(Vector2 position, Vector2 size) { return FromDimensions(position.X, position.Y, size.X, size.Y); } /// /// Gets a float describing the width of the Box2 structure. /// public float Width { get { return (float)System.Math.Abs(Right - Left); } } /// /// Gets a float describing the height of the Box2 structure. /// public float Height { get { return (float)System.Math.Abs(Bottom - Top); } } /// /// Returns whether the box contains the specified point on the closed region described by this Box2. /// /// The point to query. /// Whether this box contains the point. public bool Contains(Vector2 point) { return Contains(point, true); } /// /// Returns whether the box contains the specified point. /// /// The point to query. /// Whether to include the box boundary in the test region. /// Whether this box contains the point. public bool Contains(Vector2 point, bool closedRegion) { bool xOK = (closedRegion == Left <= Right) ? (point.X >= Left != point.X > Right) : (point.X > Left != point.X >= Right); bool yOK = (closedRegion == Top <= Bottom) ? (point.Y >= Top != point.Y > Bottom) : (point.Y > Top != point.Y >= Bottom); return xOK && yOK; } /// /// Returns a Box2 translated by the given amount. /// public Box2 Translated(Vector2 point) { return new Box2(Left + point.X, Top + point.Y, Right + point.X, Bottom + point.Y); } /// /// Translates this Box2 by the given amount. /// public void Translate(Vector2 point) { Left += point.X; Right += point.X; Top += point.Y; Bottom += point.Y; } /// /// Equality comparator. /// public static bool operator ==(Box2 left, Box2 right) { return left.Bottom == right.Bottom && left.Top == right.Top && left.Left == right.Left && left.Right == right.Right; } /// /// Inequality comparator. /// public static bool operator !=(Box2 left, Box2 right) { return !(left == right); } /// /// Functional equality comparator. /// public bool Equals(Box2 other) { return this == other; } /// /// Implements Object.Equals. /// public override bool Equals(object obj) { return obj is Box2 && Equals((Box2) obj); } /// /// Gets the hash code for this Box2. /// /// public override int GetHashCode() { return Left.GetHashCode() ^ Right.GetHashCode() ^ Top.GetHashCode() ^ Bottom.GetHashCode(); } private static string listSeparator = System.Globalization.CultureInfo.CurrentCulture.TextInfo.ListSeparator; /// /// Returns a describing the current instance. /// /// public override string ToString() { return String.Format("({0}{4} {1}) - ({2}{4} {3})", Left, Top, Right, Bottom, listSeparator); } } }