Capítulo 336 de 859
Represents an axis-aligned bounding box (AABB) in 2D space.
Constructor
| Signature |
|---|
new Box2( min : Vector2, max : Vector2 ) |
Properties
| Property | Description |
|---|---|
.isBox2 : boolean (readonly) | This flag can be used for type testing. |
.max : Vector2 | The upper boundary of the box. |
.min : Vector2 | The lower boundary of the box. |
Methods
| Method | Description |
|---|---|
.clampPoint( point : Vector2, target : Vector2 ) : Vector2 | Clamps the given point within the bounds of this box. |
.clone() : Box2 | Returns a new box with copied values from this instance. |
.containsBox( box : Box2 ) : boolean | Returns true if this bounding box includes the entirety of the given bounding box. If this box and the given one are identical, this function also returns true. |
.containsPoint( point : Vector2 ) : boolean | Returns true if the given point lies within or on the boundaries of this box. |
.copy( box : Box2 ) : Box2 | Copies the values of the given box to this instance. |
.distanceToPoint( point : Vector2 ) : number | Returns the euclidean distance from any edge of this box to the specified point. If the given point lies inside of this box, the distance will be 0. |
.equals( box : Box2 ) : boolean | Returns true if this bounding box is equal with the given one. |
.expandByPoint( point : Vector2 ) : Box2 | Expands the boundaries of this box to include the given point. |
.expandByScalar( scalar : number ) : Box2 | Expands each dimension of the box by the given scalar. If negative, the dimensions of the box will be contracted. |
.expandByVector( vector : Vector2 ) : Box2 | Expands this box equilaterally by the given vector. The width of this box will be expanded by the x component of the vector in both directions. The height of this box will be expanded by the y compon… |
.getCenter( target : Vector2 ) : Vector2 | Returns the center point of this box. |
.getParameter( point : Vector2, target : Vector2 ) : Vector2 | Returns a point as a proportion of this box's width and height. |
.getSize( target : Vector2 ) : Vector2 | Returns the dimensions of this box. |
.intersect( box : Box2 ) : Box2 | Computes the intersection of this bounding box and the given one, 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 th… |
.intersectsBox( box : Box2 ) : boolean | Returns true if the given bounding box intersects with this bounding box. |
.isEmpty() : boolean | 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. |
.makeEmpty() : Box2 | Makes this box empty which means in encloses a zero space in 2D. |
.set( min : Vector2, max : Vector2 ) : Box2 | Sets the lower and upper boundaries of this box. Please note that this method only copies the values from the given objects. |
.setFromCenterAndSize( center : Vector2, size : Vector2 ) : Box2 | Centers this box on the given center vector and sets this box's width, height and depth to the given size values. |
.setFromPoints( points : Array.<Vector2> ) : Box2 | Sets the upper and lower bounds of this box so it encloses the position data in the given array. |
.translate( offset : Vector2 ) : Box2 | Adds the given offset to both the upper and lower bounds of this bounding box, effectively moving it in 2D space. |
.union( box : Box2 ) : Box2 | Computes the union of this box and another and the given one, 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 tw… |