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 on the XY plane this box encloses.
Vector2	max	The maximum point on the XY plane 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.

Properties

Center

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

Declaration

public Vector2 Center { get; set; }

Property Value

Type	Description
Vector2

HalfSize

Gets or sets a vector describing half the size of the box.

Declaration

public Vector2 HalfSize { get; set; }

Property Value

Type	Description
Vector2

Max

Gets or sets the maximum boundary of the structure.

Declaration

public Vector2 Max { readonly get; set; }

Property Value

Type	Description
Vector2

Min

Gets or sets the minimum boundary of the structure.

Declaration

public Vector2 Min { readonly get; set; }

Property Value

Type	Description
Vector2

Size

Gets or sets a vector describing the size of the Box2 structure.

Declaration

public Vector2 Size { get; set; }

Property Value

Type	Description
Vector2

Methods

Contains(Box2)

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

Declaration

[Pure]
public readonly bool Contains(Box2 other)

Parameters

Type	Name	Description
Box2	other	The box to query.

Returns

Type	Description
bool	Whether this box contains the other box.

Contains(Vector2, bool)

Returns whether the box contains the specified point.

Declaration

[Pure]
public bool Contains(Vector2 point, bool boundaryInclusive)

Parameters

Type	Name	Description
Vector2	point	The point to query.
bool	boundaryInclusive	Whether points on the box boundary should be recognised as contained as well.

Returns

Type	Description
bool	Whether this box contains the point.

Contains(Vector2)

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

Declaration

[Pure]
[Obsolete("This function used to exclude borders, but to follow changes from the other Box structs it's deprecated. Use ContainsInclusive and ContainsExclusive for the desired behaviour.")]
public readonly bool Contains(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to query.

Returns

Type	Description
bool	Whether this box contains the point.

ContainsExclusive(Vector2)

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

Declaration

[Pure]
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.

ContainsInclusive(Vector2)

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

Declaration

[Pure]
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.

DistanceToNearestEdge(Vector2)

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

Declaration

[Pure]
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.

Equals(Box2)

Declaration

public bool Equals(Box2 other)

Parameters

Type	Name	Description
Box2	other

Returns

Type	Description
bool

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

Extend(Vector2)

Extend this Box2 to encapsulate a given point.

Declaration

public void Extend(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Extended(Vector2)

Extend this Box2 to encapsulate a given point.

Declaration

[Pure]
public readonly Box2 Extended(Vector2 point)

Parameters

Type	Name	Description
Vector2	point	The point to contain.

Returns

Type	Description
Box2	The inflated box.

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

Inflate(Vector2)

Inflates this Box2 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize. Use the Extend(Vector2) method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.

Declaration

public void Inflate(Vector2 size)

Parameters

Type	Name	Description
Vector2	size	The size to inflate by.

Inflated(Vector2)

Inflates this Box2 by the given size in all directions. A negative size will shrink the box to a maximum of -HalfSize. Use the Extended(Vector2) method for the point-encapsulation functionality in OpenTK version 4.8.1 and earlier.

Declaration

[Pure]
public readonly Box2 Inflated(Vector2 size)

Parameters

Type	Name	Description
Vector2	size	The size to inflate by.

Returns

Type	Description
Box2	The inflated box.

Scale(Vector2, Vector2)

Scales this Box2 by the given amount.

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 Box2 scaled by a given amount from an anchor point.

Declaration

[Pure]
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.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

ToString(IFormatProvider)

Declaration

public string ToString(IFormatProvider formatProvider)

Parameters

Type	Name	Description
IFormatProvider	formatProvider

Returns

Type	Description
string

ToString(string, IFormatProvider)

Declaration

public string ToString(string format, IFormatProvider formatProvider)

Parameters

Type	Name	Description
string	format
IFormatProvider	formatProvider

Returns

Type	Description
string

ToString(string)

Declaration

public string ToString(string format)

Parameters

Type	Name	Description
string	format

Returns

Type	Description
string

Translate(Vector2)

Translates this Box2 by the given amount.

Declaration

public void Translate(Vector2 distance)

Parameters

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

Translated(Vector2)

Returns a Box2 translated by the given amount.

Declaration

[Pure]
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.

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 RectangleF(Box2)

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

Declaration

[Pure]
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