Struct Box2i

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

Implements

IEquatable<Box2i>

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: OpenTK.Mathematics

Assembly: OpenTK.Mathematics.dll

Syntax

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

Constructors

Box2i(Vector2i, Vector2i)

Initializes a new instance of the Box2i struct.

Declaration

public Box2i(Vector2i min, Vector2i max)

Parameters

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

Box2i(int, int, int, int)

Initializes a new instance of the Box2i struct.

Declaration

public Box2i(int minX, int minY, int maxX, int maxY)

Parameters

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

Fields

Empty

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

Declaration

public static readonly Box2i Empty

Field Value

Type	Description
Box2i

Examples

For example:

Vector2i[] points = GetPoints();
Box2i aabb = Box2i.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 Vector2i Max

Field Value

Type	Description
Vector2i

Remarks

A box with a minimum point greater than the maximum is not considered valid except for a single configuration where Min = Vector2i.PositiveInfinity and Max = Vector2i.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 Vector2i Min

Field Value

Type	Description
Vector2i

Remarks

A box with a minimum point greater than the maximum is not considered valid except for a single configuration where Min = Vector2i.PositiveInfinity and Max = Vector2i.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 Box2i UnitSquare

Field Value

Type	Description
Box2i

Zero

An empty box with Min = Vector2i.Zero and Max = Vector2i.Zero.

Declaration

public static readonly Box2i Zero

Field Value

Type	Description
Box2i

Remarks

If you want an empty box, consider using Empty.

Properties

Area

The area of the box.

Declaration

public readonly int Area { get; }

Property Value

Type	Description
int

Center

Gets a vector describing the center of the box.

Declaration

public readonly Vector2 Center { get; }

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 int Height { get; }

Property Value

Type	Description
int

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 Vector2i Location { get; }

Property Value

Type	Description
Vector2i

Size

Gets the size of the box.

Declaration

public readonly Vector2i Size { get; }

Property Value

Type	Description
Vector2i

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 int Width { get; }

Property Value

Type	Description
int

Methods

Contains(Box2i)

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(Box2i other)

Parameters

Type	Name	Description
Box2i	other	The box to check.

Returns

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

ContainsExclusive(Vector2i)

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

Declaration

public readonly bool ContainsExclusive(Vector2i point)

Parameters

Type	Name	Description
Vector2i	point	The point to query.

Returns

Type	Description
bool	Whether this box contains the point.

ContainsInclusive(Vector2i)

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

Declaration

public readonly bool ContainsInclusive(Vector2i point)

Parameters

Type	Name	Description
Vector2i	point	The point to query.

Returns

Type	Description
bool	Whether this box contains the point.

Equals(Box2i)

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

Declaration

public readonly bool Equals(Box2i other)

Parameters

Type	Name	Description
Box2i	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)

EuclidianDistanceToNearestEdge(Vector2i)

Returns the euclidian distance between the nearest point on an edge and the specified point.

Declaration

public readonly float EuclidianDistanceToNearestEdge(Vector2i point)

Parameters

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

Returns

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

EuclidianDistanceToNearestPointInBox(Vector2i)

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

Declaration

public readonly float EuclidianDistanceToNearestPointInBox(Vector2i point)

Parameters

Type	Name	Description
Vector2i	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.

Extend(Vector2i)

Extends this box to encapsulate a given point.

Declaration

public void Extend(Vector2i point)

Parameters

Type	Name	Description
Vector2i	point	The point to contain.

Remarks

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

Examples

For example:

Vector2i[] points = GetPoints();
Box2i aabb = Box2i.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(Vector2i)

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

Declaration

public readonly Box2i Extended(Vector2i point)

Parameters

Type	Name	Description
Vector2i	point	The point to contain.

Returns

Type	Description
Box2i	The extended box.

Remarks

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

Examples

For example:

Vector2i[] points = GetPoints();
Box2i aabb = Box2i.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.

FromCenterAndHalfSize(Vector2i, Vector2i)

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

Declaration

public static Box2i FromCenterAndHalfSize(Vector2i center, Vector2i halfSize)

Parameters

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

Returns

Type	Description
Box2i	The created box.

FromMinMax(Vector2i, Vector2i)

Creates a box from a minimum and maximum point.

Declaration

public static Box2i FromMinMax(Vector2i min, Vector2i max)

Parameters

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

Returns

Type	Description
Box2i	The created box.

FromSize(Vector2i, Vector2i)

Creates a box from a point and size.

Declaration

public static Box2i FromSize(Vector2i point, Vector2i size)

Parameters

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

Returns

Type	Description
Box2i	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(Vector2i)

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(Vector2i size)

Parameters

Type	Name	Description
Vector2i	size	The size to inflate by.

Inflated(Vector2i)

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 Box2i Inflated(Vector2i size)

Parameters

Type	Name	Description
Vector2i	size	The size to inflate by.

Returns

Type	Description
Box2i	The inflated box.

Intersect(Box2i)

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

Declaration

public void Intersect(Box2i other)

Parameters

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

Intersect(Box2i, Box2i)

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

Declaration

public static Box2i Intersect(Box2i a, Box2i b)

Parameters

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

Returns

Type	Description
Box2i	The intersection of the two boxes.

Intersected(Box2i)

Returns the intersection of itself and the specified box.

Declaration

public readonly Box2i Intersected(Box2i other)

Parameters

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

Returns

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

IntersectsWith(Box2i)

Determines if this box intersects with another box.

Declaration

public readonly bool IntersectsWith(Box2i other)

Parameters

Type	Name	Description
Box2i	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(Box2i).

ManhattanDistanceToNearestEdge(Vector2)

Returns the manhattan distance between the nearest point on an edge and the specified point.

Declaration

public readonly float ManhattanDistanceToNearestEdge(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.

ManhattanDistanceToNearestEdge(Vector2i)

Returns the manhattan distance between the nearest point on an edge and the specified point.

Declaration

public readonly int ManhattanDistanceToNearestEdge(Vector2i point)

Parameters

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

Returns

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

Remarks

The distance to points inside the box is zero.

NearestPointInBox(Vector2i)

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

Declaration

public readonly Vector2i NearestPointInBox(Vector2i point)

Parameters

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

Returns

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

NearestPointOnEdge(Vector2i)

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

Declaration

public readonly Vector2i NearestPointOnEdge(Vector2i point)

Parameters

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

Returns

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

Scale(Vector2i, Vector2i)

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

Declaration

public void Scale(Vector2i scale, Vector2i anchor)

Parameters

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

Scaled(Vector2i, Vector2i)

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

Declaration

public readonly Box2i Scaled(Vector2i scale, Vector2i anchor)

Parameters

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

Returns

Type	Description
Box2i	The scaled box.

SignedEuclidianDistanceToNearestEdge(Vector2)

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

Declaration

public readonly float SignedEuclidianDistanceToNearestEdge(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.

SignedManhattanDistanceToNearestEdge(Vector2)

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

Declaration

public readonly float SignedManhattanDistanceToNearestEdge(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.

SignedManhattanDistanceToNearestEdge(Vector2i)

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

Declaration

public readonly int SignedManhattanDistanceToNearestEdge(Vector2i point)

Parameters

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

Returns

Type	Description
int	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(Box2i)

Determines if this box intersects or touches with another box.

Declaration

public readonly bool Touches(Box2i other)

Parameters

Type	Name	Description
Box2i	other	The box to test.

Returns

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

Translate(Vector2i)

Translates this box by the given distance.

Declaration

public void Translate(Vector2i distance)

Parameters

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

Translated(Vector2i)

Returns a box translated by the given distance.

Declaration

public readonly Box2i Translated(Vector2i distance)

Parameters

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

Returns

Type	Description
Box2i	The translated box.

Operators

operator ==(Box2i, Box2i)

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

Declaration

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

Parameters

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

Returns

Type	Description
bool

explicit operator Box2(Box2i)

Converts this Box2i to a Box2.

Declaration

public static explicit operator Box2(Box2i box)

Parameters

Type	Name	Description
Box2i	box	The box to cast.

Returns

Type	Description
Box2

explicit operator Box2d(Box2i)

Converts this Box2i to a Box2d.

Declaration

public static explicit operator Box2d(Box2i box)

Parameters

Type	Name	Description
Box2i	box	The box to cast.

Returns

Type	Description
Box2d

explicit operator RectangleF(Box2i)

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

Declaration

public static explicit operator RectangleF(Box2i box)

Parameters

Type	Name	Description
Box2i	box	The box to cast.

Returns

Type	Description
RectangleF

operator !=(Box2i, Box2i)

Inequality comparator.

Declaration

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

Parameters

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

Returns

Type	Description
bool

Implements

IEquatable<T>

IFormattable