# [name]

Represents an axis-aligned bounding box (AABB) in 2D space.

## Constructor

### [name]( [param:Vector2 min], [param:Vector2 max] )

[page:Vector2 min] - (optional) [page:Vector2] representing the lower (x, y) boundary of the box. Default is ( + Infinity, + Infinity ).
[page:Vector2 max] - (optional) [page:Vector2] representing the upper (x, y) boundary of the box. Default is ( - Infinity, - Infinity ).

Creates a [name] bounded by min and max.

## Properties

### [property:Vector2 min]

[page:Vector2] representing the lower (x, y) boundary of the box.
Default is ( + Infinity, + Infinity ).

### [property:Vector2 max]

[page:Vector2] representing the lower upper (x, y) boundary of the box.
Default is ( - Infinity, - Infinity ).

## Methods

### [method:Vector2 clampPoint]( [param:Vector2 point], [param:Vector2 target] )

[page:Vector2 point] - [page:Vector2] to clamp.
[page:Vector2 target] — the result will be copied into this Vector2.

[link:https://en.wikipedia.org/wiki/Clamping_(graphics) Clamps] the [page:Vector2 point] within the bounds of this box.

### [method:Box2 clone]()

Returns a new [page:Box2] with the same [page:.min min] and [page:.max max] as this one.

### [method:Boolean containsBox]( [param:Box2 box] )

[page:Box2 box] - [page:Box2 Box2] to test for inclusion.

Returns true if this box includes the entirety of [page:Box2 box]. If this and [page:Box2 box] are identical,
this function also returns true.

### [method:Boolean containsPoint]( [param:Vector2 point] )

[page:Vector2 point] - [page:Vector2] to check for inclusion.

Returns true if the specified [page:Vector2 point] lies within or on the boundaries of this box.

### [method:this copy]( [param:Box2 box] )

Copies the [page:.min min] and [page:.max max] from [page:Box2 box] to this box.

### [method:Float distanceToPoint]( [param:Vector2 point] )

[page:Vector2 point] - [page:Vector2] to measure distance to.

Returns the distance from any edge of this box to the specified point. If the [page:Vector2 point] lies inside of this box, the distance will be 0.

### [method:Boolean equals]( [param:Box2 box] )

[page:Box2 box] - Box to compare with this one.

Returns true if this box and [page:Box2 box] share the same lower and upper bounds.

### [method:this expandByPoint]( [param:Vector2 point] )

[page:Vector2 point] - [page:Vector2] that should be included in the box.

Expands the boundaries of this box to include [page:Vector2 point].

### [method:this expandByScalar]( [param:Float scalar] )

[page:Float scalar] - Distance to expand the box by.

Expands each dimension of the box by [page:Float scalar]. If negative, the dimensions of the box will be contracted.

### [method:this expandByVector]( [param:Vector2 vector] )

[page:Vector2 vector] - [page:Vector2] to expand the box by.

Expands this box equilaterally by [page:Vector2 vector]. The width of this box will be expanded by the x component of [page:Vector2 vector] in both directions. The height of this box will be expanded by the y component of [page:Vector2 vector] in both directions.

### [method:Vector2 getCenter]( [param:Vector2 target] )

[page:Vector2 target] — the result will be copied into this Vector2.

Returns the center point of the box as a [page:Vector2].

### [method:Vector2 getParameter]( [param:Vector2 point], [param:Vector2 target] )

[page:Vector2 point] - [page:Vector2].
[page:Vector2 target] — the result will be copied into this Vector2.

Returns a point as a proportion of this box's width and height.

### [method:Vector2 getSize]( [param:Vector2 target] )

[page:Vector2 target] — the result will be copied into this Vector2.

Returns the width and height of this box.

### [method:this intersect]( [param:Box2 box] )

[page:Box2 box] - Box to intersect with.

Returns the intersection of this and [page:Box2 box], setting the upper bound of this box to the lesser of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes' lower bounds.

### [method:Boolean intersectsBox]( [param:Box2 box] )

[page:Box2 box] - Box to check for intersection against.

Determines whether or not this box intersects [page:Box2 box].

### [method:Boolean isEmpty]()

Returns true if this box includes zero points within its bounds.
Note that a box with equal lower and upper bounds still includes one point, the one both bounds share.

### [method:this makeEmpty]()

Makes this box empty.

### [method:this set]( [param:Vector2 min], [param:Vector2 max] )

[page:Vector2 min] - (required ) [page:Vector2] representing the lower (x, y) boundary of the box.
[page:Vector2 max] - (required) [page:Vector2] representing the upper (x, y) boundary of the box.

Sets the lower and upper (x, y) boundaries of this box.
Please note that this method only copies the values from the given objects.

### [method:this setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 size] )

[page:Vector2 center] - Desired center position of the box ([page:Vector2]).
[page:Vector2 size] - Desired x and y dimensions of the box ([page:Vector2]).

Centers this box on [page:Vector2 center] and sets this box's width and height to the values specified in [page:Vector2 size].

### [method:this setFromPoints]( [param:Array points] )

[page:Array points] - Array of [page:Vector2 Vector2s] that the resulting box will contain.

Sets the upper and lower bounds of this box to include all of the points in [page:Array points].

### [method:this translate]( [param:Vector2 offset] )

[page:Vector2 offset] - Direction and distance of offset.

Adds [page:Vector2 offset] to both the upper and lower bounds of this box, effectively moving this box [page:Vector2 offset] units in 2D space.

### [method:this union]( [param:Box2 box] )

[page:Box2 box] - Box that will be unioned with this box.

Unions this box with [page:Box2 box], setting the upper bound of this box to the greater of the two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes' lower bounds.