Struct Box2

Defines an axis-aligned 2d box (rectangle).

Implements

IEquatable<Box2>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: OpenTK.Mathematics

Assembly: OpenTK.Mathematics.dll

Syntax

[Serializable]
public struct Box2 : IEquatable<Box2>, IFormattable

Constructors

Box2(Vector2, Vector2)

Initializes a new instance of the Box2 struct.

Declaration

public Box2(Vector2 min, Vector2 max)

Parameters

Type	Name	Description
Vector2	min	The minimum point this box encloses.
Vector2	max	The maximum point this box encloses.

Box2(float, float, float, float)

Initializes a new instance of the Box2 struct.

Declaration

public Box2(float minX, float minY, float maxX, float maxY)

Parameters

Type	Name	Description
float	minX	The minimum X value to be enclosed.
float	minY	The minimum Y value to be enclosed.
float	maxX	The maximum X value to be enclosed.
float	maxY	The maximum Y value to be enclosed.

Fields

Empty

An empty box with Min = Vector2.PositiveInfinity and Max = Vector2.NegativeInfinity. This box can be used with Extend(Vector2) to create a bounding box without a special case for the first point.

Declaration

public static readonly Box2 Empty

Field Value

Type	Description
Box2

Examples

For example:

Vector2[] points = GetPoints();
Box2 aabb = Box2.Empty;
for (int i = 0; i < points.Length; i++)
{
    aabb.Extend(points[i]):
}

Will calculate the bounding box of all the points in the array without needing a special case for the first point.

Max

The maximum boundary of the box. This field is not guaranteed to be greater than Max.

Declaration

public Vector2 Max

Field Value

Type	Description
Vector2

Remarks

A box with a minimum point greater than the maximum is not considered valid except for a single configuration where Min = Vector2.PositiveInfinity and Max = Vector2.NegativeInfinity as is the case with Empty.

Min

The minimum boundary of the box. This field is not guaranteed to be less than Max.

Declaration

public Vector2 Min

Field Value

Type	Description
Vector2

Remarks

A box with a minimum point greater than the maximum is not considered valid except for a single configuration where Min = Vector2.PositiveInfinity and Max = Vector2.NegativeInfinity as is the case with Empty.

See Also

Empty

IsEmpty

UnitSquare

A box with a Min = (0, 0) and Max = (1, 1).

Declaration

public static readonly Box2 UnitSquare

Field Value

Type	Description
Box2

Zero

A box with Min = Vector2.Zero and Min = Vector2.Zero.

Declaration

public static readonly Box2 Zero

Field Value

Type	Description
Box2

Remarks

If you want an empty box, consider using Empty.

Properties

Area

The area of the box.

Declaration

public readonly float Area { get; }

Property Value

Type	Description
float

Center

Gets or sets a vector describing the center of the box.

Declaration

public Vector2 Center { readonly get; set; }

Property Value

Type	Description
Vector2

HalfSize

Gets half the size of the box. The distance from the center of the box to the edge of the box in X and Y.

Declaration

public readonly Vector2 HalfSize { get; }

Property Value

Type	Description
Vector2

Remarks

This function never returns negative values, so Empty will have a size of (0, 0).

HasZeroArea

If this box has zero area.

Declaration

public readonly bool HasZeroArea { get; }

Property Value

Type	Description
bool

Height

The height of the box.

Declaration

public readonly float Height { get; }

Property Value

Type	Description
float

IsEmpty

If this box is equal to Empty.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
bool

IsPoint

If this box is a point, i.e. its minimum point is equal to its maximum point.

Declaration

public readonly bool IsPoint { get; }

Property Value

Type	Description
bool

Location

Gets the location of the box from a Location + Size perspective. Basically an alias for Min.

Declaration

public readonly Vector2 Location { get; }

Property Value

Type	Description
Vector2

Size

Gets the size of the box.

Declaration

public readonly Vector2 Size { get; }

Property Value

Type	Description
Vector2

Remarks

This function never returns negative values, so Empty will have a size of (0, 0).

Width

The width of the box.

Declaration

public readonly float Width { get; }

Property Value

Type	Description
float

Methods

Ceiling(Box2)

Returns a box that contains rounded up integers.

Declaration

public static Box2 Ceiling(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to round.

Returns

Type	Description
Box2	The box that contains rounded up integers.

Contains(Box2)

Returns whether the box other is entirely contained within this box. A box is considered to be able to contain itself.

Declaration

public readonly bool Contains(Box2 other)

Parameters

Type	Name	Description
Box2	other	The box to check.

Returns

Type	Description
bool	true if the box other is entirely contained within the this box; otherwise, false.

ContainsExclusive(Vector2)

Returns whether the box contains the specified point (borders exclusive).

Declaration

public readonly bool ContainsExclusive(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to query.

Returns

Type	Description
bool	Whether this box contains the point.

See Also

ContainsInclusive(Vector2)

ContainsInclusive(Vector2)

Returns whether the box contains the specified point (borders inclusive).

Declaration

public readonly bool ContainsInclusive(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to query.

Returns

Type	Description
bool	Whether this box contains the point.

See Also

ContainsExclusive(Vector2)

DistanceToNearestEdge(Vector2)

Returns the distance between the nearest edge and the specified point.

Declaration

public readonly float DistanceToNearestEdge(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to find distance for.

Returns

Type	Description
float	The distance between the specified point and the nearest edge.

DistanceToNearestPointInBox(Vector2)

Returns the distance between the nearest point inside the box and the specified point.

Declaration

public readonly float DistanceToNearestPointInBox(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to find distance for.

Returns

Type	Description
float	The distance between the specified point and the nearest edge.

Remarks

The distance to points inside the box is zero.

Equals(Box2)

Indicates whether the current object is equal to another object of the same type.

Declaration

public readonly bool Equals(Box2 other)

Parameters

Type	Name	Description
Box2	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

Extend(Vector2)

Extends this box to encapsulate a given point.

Declaration

public void Extend(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Remarks

This can be used in combination with Empty to make an efficient bounding box calculation.

Examples

For example:

Vector2[] points = GetPoints();
Box2 aabb = Box2.Empty;
for (int i = 0; i < points.Length; i++)
{
    aabb.Extend(points[i]):
}

Will calculate the bounding box of all the points in the array without needing a special case for the first point.

ExtendNative(Vector2)

Extends this box to encapsulate a given point. With NaN propagation and -0 behaviour being platform dependent.

Declaration

public void ExtendNative(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Remarks

This can be used in combination with Empty to make an efficient bounding box calculation.

Examples

For example:

Vector2[] points = GetPoints();
Box2 aabb = Box2.Empty;
for (int i = 0; i < points.Length; i++)
{
    aabb.Extend(points[i]):
}

Will calculate the bounding box of all the points in the array without needing a special case for the first point.

Extended(Vector2)

Returns a box that is extended to encapsulate a given point.

Declaration

public readonly Box2 Extended(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Returns

Type	Description
Box2	The extended box.

Remarks

This can be used in combination with Empty to make an efficient bounding box calculation.

Examples

For example:

Vector2[] points = GetPoints();
Box2 aabb = Box2.Empty;
for (int i = 0; i < points.Length; i++)
{
    aabb = aabb.Extended(points[i]):
}

Will calculate the bounding box of all the points in the array without needing a special case for the first point.

ExtendedNative(Vector2)

Returns a box that is extended to encapsulate a given point. With NaN propagation and -0 behaviour being platform dependent.

Declaration

public readonly Box2 ExtendedNative(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Returns

Type	Description
Box2	The extended box.

Remarks

This can be used in combination with Empty to make an efficient bounding box calculation.

Examples

For example:

Vector2[] points = GetPoints();
Box2 aabb = Box2.Empty;
for (int i = 0; i < points.Length; i++)
{
    aabb = aabb.Extended(points[i]):
}

Will calculate the bounding box of all the points in the array without needing a special case for the first point.

Floor(Box2)

Returns a box that contains rounded down integers.

Declaration

public static Box2 Floor(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to round.

Returns

Type	Description
Box2	The box that contains rounded down integers.

FloorCeiling(Box2)

Returns a box where Min has been rounded down and Max has been rounded up.

Declaration

public static Box2 FloorCeiling(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to round.

Returns

Type	Description
Box2	The box that contains rounded down integers.

FromCenterAndHalfSize(Vector2, Vector2)

Creates a box from a center point and a half size.

Declaration

public static Box2 FromCenterAndHalfSize(Vector2 center, Vector2 halfSize)

Parameters

Type	Name	Description
Vector2	center	The center of the box.
Vector2	halfSize	The half size of the box.

Returns

Type	Description
Box2	The created box.

FromMinMax(Vector2, Vector2)

Creates a box from a minimum and maximum point.

Declaration

public static Box2 FromMinMax(Vector2 min, Vector2 max)

Parameters

Type	Name	Description
Vector2	min	The minimum point on the XY plane this box encloses.
Vector2	max	The maximum point on the XY plane this box encloses.

Returns

Type	Description
Box2	The created box.

FromSize(Vector2, Vector2)

Creates a box from a point and size.

Declaration

public static Box2 FromSize(Vector2 point, Vector2 size)

Parameters

Type	Name	Description
Vector2	point	The minimum point of the box.
Vector2	size	The size of the box.

Returns

Type	Description
Box2	The created box.

FromTwoPoints(Vector2, Vector2)

Create a box from two unordered points, i.e. creates a box that contains two points.

Declaration

public static Box2 FromTwoPoints(Vector2 p1, Vector2 p2)

Parameters

Type	Name	Description
Vector2	p1	The first point to contain.
Vector2	p2	The second point to contain.

Returns

Type	Description
Box2	The created box.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Inflate(Vector2)

Inflates this box by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.

Declaration

public void Inflate(Vector2 size)

Parameters

Type	Name	Description
Vector2	size	The size to inflate by.

Inflated(Vector2)

Returns a box inflated by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize.

Declaration

public readonly Box2 Inflated(Vector2 size)

Parameters

Type	Name	Description
Vector2	size	The size to inflate by.

Returns

Type	Description
Box2	The inflated box.

Intersect(Box2)

Replaces this box with the intersection of itself and the specified box.

Declaration

public void Intersect(Box2 other)

Parameters

Type	Name	Description
Box2	other	The Box with which to intersect.

Intersect(Box2, Box2)

Returns the intersection of two boxes, or Empty if there is no intersection.

Declaration

public static Box2 Intersect(Box2 a, Box2 b)

Parameters

Type	Name	Description
Box2	a	The first box.
Box2	b	The second box.

Returns

Type	Description
Box2	The intersection of the two boxes.

IntersectNative(in Box2, in Box2)

Returns the intersection of two boxes, or Empty if there is no intersection. With NaN propagation and -0 behaviour being platform depedent.

Declaration

public static Box2 IntersectNative(in Box2 a, in Box2 b)

Parameters

Type	Name	Description
Box2	a	The first box.
Box2	b	The second box.

Returns

Type	Description
Box2	The intersection of the two boxes.

Intersected(Box2)

Returns the intersection of itself and the specified box.

Declaration

public readonly Box2 Intersected(Box2 other)

Parameters

Type	Name	Description
Box2	other	The Box with which to intersect.

Returns

Type	Description
Box2	The intersection of itself and the specified box.

IntersectsWith(Box2)

Determines if this box intersects with another box.

Declaration

public readonly bool IntersectsWith(Box2 other)

Parameters

Type	Name	Description
Box2	other	The box to test.

Returns

Type	Description
bool	This method returns true if there is any intersection, otherwise false.

Remarks

Two boxes next to each other do not intersect, for detecting that case use Touches(Box2).

NearestPointInBox(Vector2)

Returns the nearest point in or on the edge of the box to the given point, point.

Declaration

public readonly Vector2 NearestPointInBox(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point for which the nearest point in the box should be found.

Returns

Type	Description
Vector2	The nearest point on or on the edge of the box to the point, point.

NearestPointOnEdge(Vector2)

Returns the nearest point that is on the edge of the box.

Declaration

public readonly Vector2 NearestPointOnEdge(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point for which the nearest point on the edge of the box should be found.

Returns

Type	Description
Vector2	The nearest point on the edge of the box to the point, point.

Round(Box2)

Returns a box that contains rounded integers.

Declaration

public static Box2 Round(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to round.

Returns

Type	Description
Box2	The box that contains rounded integers.

Scale(Vector2, Vector2)

Scales this box by the given scale, scale, and from the given anchor point, anchor.

Declaration

public void Scale(Vector2 scale, Vector2 anchor)

Parameters

Type	Name	Description
Vector2	scale	The scale to scale the box.
Vector2	anchor	The anchor to scale the box from.

Scaled(Vector2, Vector2)

Returns a box scaled by the given scale, scale, and from the given anchor point, anchor.

Declaration

public readonly Box2 Scaled(Vector2 scale, Vector2 anchor)

Parameters

Type	Name	Description
Vector2	scale	The scale to scale the box.
Vector2	anchor	The anchor to scale the box from.

Returns

Type	Description
Box2	The scaled box.

SignedDistanceToNearestEdge(Vector2)

Returns the signed distance between the nearest edge and the specified point.

Declaration

public readonly float SignedDistanceToNearestEdge(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to find distance for.

Returns

Type	Description
float	The distance between the specified point and the nearest edge.

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

ToString(IFormatProvider)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(IFormatProvider formatProvider)

Parameters

Type	Name	Description
IFormatProvider	formatProvider	The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

Type	Description
string	The value of the current instance in the specified format.

ToString(string)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(string format)

Parameters

Type	Name	Description
string	format	The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

Returns

Type	Description
string	The value of the current instance in the specified format.

ToString(string, IFormatProvider)

Formats the value of the current instance using the specified format.

Declaration

public readonly string ToString(string format, IFormatProvider formatProvider)

Parameters

Type	Name	Description
string	format	The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.
IFormatProvider	formatProvider	The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

Type	Description
string	The value of the current instance in the specified format.

Touches(Box2)

Determines if this box intersects or touches with another box.

Declaration

public readonly bool Touches(Box2 other)

Parameters

Type	Name	Description
Box2	other	The box to test.

Returns

Type	Description
bool	This method returns true if there is any intersection or touches, otherwise false.

Translate(Vector2)

Translates this box by the given distance.

Declaration

public void Translate(Vector2 distance)

Parameters

Type	Name	Description
Vector2	distance	The distance to translate the box.

Translated(Vector2)

Returns a box translated by the given distance.

Declaration

public readonly Box2 Translated(Vector2 distance)

Parameters

Type	Name	Description
Vector2	distance	The distance to translate the box.

Returns

Type	Description
Box2	The translated box.

Operators

operator ==(Box2, Box2)

Equality comparator. Two boxes are considered equal if both the Min and Max fields are equal.

Declaration

public static bool operator ==(Box2 left, Box2 right)

Parameters

Type	Name	Description
Box2	left	The left operand.
Box2	right	The right operand.

Returns

Type	Description
bool

explicit operator Box2d(Box2)

Converts this Box2 to a Box2d.

Declaration

public static explicit operator Box2d(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to cast.

Returns

Type	Description
Box2d

explicit operator Box2i(Box2)

Converts this Box2 to a Box2i using truncation.

Declaration

public static explicit operator Box2i(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to cast.

Returns

Type	Description
Box2i

explicit operator RectangleF(Box2)

Converts this Box2 to a Rectangle using Min as the position and Size as the size.

Declaration

public static explicit operator RectangleF(Box2 box)

Parameters

Type	Name	Description
Box2	box	The box to cast.

Returns

Type	Description
RectangleF

operator !=(Box2, Box2)

Inequality comparator.

Declaration

public static bool operator !=(Box2 left, Box2 right)

Parameters

Type	Name	Description
Box2	left	The left operand.
Box2	right	The right operand.

Returns

Type	Description
bool

Implements

IEquatable<T>

IFormattable