AABB

Convenience for Vector.Scalar.

The minimal coordinate of this box. Must be <= maximum.

The maximal coordinate of this box. Must be >= minimum.

The location of this Box corresponding to its minimal vector. Alias for minimum.

Initializes a NBox with the given minimum and maximum boundary vectors.

Returns self.

Returns true if the size of this box is zero.

Size is zero when minimum == maximum.

let box = AABB2D(left: 1.0, top: 2.0, right: 1.0, bottom: 2.0)

print(box.isSizeZero) // Prints "true"

Returns true iff minimum <= maximum.

Initializes a box containing the minimum area capable of containing the two supplied points.

let box = AABB2D(of:
    .init(x: -5, y: 4),
    .init(x: 3, y: -2)
)

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 4))"

Initializes a box containing the minimum area capable of containing the three supplied points.

let box = AABB2D(of:
    .init(x: -5, y: 4),
    .init(x: 3, y: 0),
    .init(x: 2, y: -2)
)

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 4))"

Initializes a box containing the minimum area capable of containing the four supplied points.

let box = AABB2D(of:
    .init(x: -2, y: 4),
    .init(x: 3, y: 0),
    .init(x: 2, y: -2),
    .init(x: -5, y: 3)
)

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 4))"

Expands this box to include the given point.

The resulting box is the minimal AABB capable of enclosing the original AABB and vector point.

var box = AABB2D(left: 1, top: 1, right: 3, bottom: 3)

box.expand(toInclude: .init(x: -5, y: 6))

print(box) // Prints "(minimum: (x: -5, y: 1), maximum: (x: 3, y: 6))"

Expands this box to fully include the given set of points.

Equivalent to calling expand(toInclude:) over each point. If the array is empty, nothing is done.

The resulting box is the minimal AABB capable of enclosing the original AABB and all vectors in points.

var box = AABB2D(left: 1, top: 1, right: 3, bottom: 3)

box.expand(toInclude: [
    .init(x: -5, y: 4),
    .init(x: 3, y: -2),
    .init(x: 1, y: 6)
])

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 6))"

Clamps a given vector’s coordinates to the confines of this AABB.

Points inside the AABB remain unchanged, while points outside are projected along the edges to the closest point to vector that is within this AABB.

let box = AABB2D(left: -1, top: -2, right: 3, bottom: 4)

print(box.clamp(.init(x: -3, y: 2))) // Prints "(x: -1, y: 2)"
print(box.clamp(.init(x: -3, y: -3))) // Prints "(x: -1, y: -2)"
print(box.clamp(.init(x: 5, y: 1))) // Prints "(x: 3, y: 1)"

Returns whether a given point is contained within this box.

The check is inclusive, so the edges of the box are considered to contain the point as well.

let box = AABB2D(left: -1, top: -2, right: 3, bottom: 4)

print(box.contains(.init(x: -3, y: 2))) // Prints "false"
print(box.contains(.init(x: 1, y: 4))) // Prints "true"

Returns whether a given box is completely contained inside the boundaries of this box.

Returns true for aabb.contains(aabb).

let box1 = AABB2D(left: -1, top: -2, right: 3, bottom: 4)
let box2 = AABB2D(left: 0, top: 1, right: 2, bottom: 3)
let box3 = AABB2D(left: 1, top: 1, right: 5, bottom: 5)

print(box1.contains(box: box1)) // Prints "true"
print(box1.contains(box: box2)) // Prints "true"
print(box1.contains(box: box3)) // Prints "false"

Returns whether this box intersects the given box instance.

This check is inclusive, so edges of the box are considered to intersect the other bounding box’s edges as well.

let box1 = AABB2D(left: -1, top: -2, right: 3, bottom: 4)
let box2 = AABB2D(left: 0, top: 1, right: 2, bottom: 3)
let box3 = AABB2D(left: 1, top: 1, right: 5, bottom: 5)
let box4 = AABB2D(left: -1, top: 5, right: 3, bottom: 7)

print(box1.intersects(box: box1)) // Prints "true"
print(box1.intersects(box: box2)) // Prints "true"
print(box1.intersects(box: box3)) // Prints "true"
print(box1.intersects(box: box4)) // Prints "false"

Creates a rectangle which is equal to the positive area shared between this rectangle and other.

If the AABBs do not intersect (i.e. produce a rectangle with < 0 bounds), nil is returned, instead.

Returns a box which is the minimum box capable of fitting self and the given box.

Returns aabb for aabb.union(aabb).

let box1 = AABB2D(left: -1, top: -2, right: 3, bottom: 4)
let box2 = AABB2D(left: 0, top: -3, right: 5, bottom: 3)

print(box1.union(box2)) // Prints (minimum: (x: -1, y: -3), maximum: (x: 5, y: 4))

Returns a box which is the minimum box capable of fitting left and right.

Returns aabb for AABB.union(aabb, aabb).

let box1 = AABB2D(left: -1, top: -2, right: 3, bottom: 4)
let box2 = AABB2D(left: 0, top: -3, right: 5, bottom: 3)

print(AABB.union(box1, box2)) // Prints (minimum: (x: -1, y: -3), maximum: (x: 5, y: 4))

Returns a box with minimum and maximum set to Vector.zero.

Gets the size of this box.

Returns true if this box is a AABB.zero instance.

Returns this Box represented as a Rectangle

Initializes an AABB with zero minimal and maximal vectors.

Initializes this AABB with the equivalent coordinates of a rectangle with a given location and size.

Initializes a box containing the minimum area capable of containing all supplied points.

If no points are supplied, a zero box is created, instead.

Convenience for init(points:).

let box = AABB2D(of:
    .init(x: -5, y: 4),
    .init(x: 3, y: -2),
    .init(x: 1, y: 3),
    .init(x: 2, y: 1),
    .init(x: 2, y: 6)
)

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 6))"

Initializes a box out of a set of points, expanding to the smallest area capable of fitting each point.

let box = AABB2D(points: [
    .init(x: -5, y: 4),
    .init(x: 3, y: -2),
    .init(x: 1, y: 3),
    .init(x: 2, y: 1),
    .init(x: 2, y: 6)
])

print(box) // Prints "(minimum: (x: -5, y: -2), maximum: (x: 3, y: 6))"

Initializes the smallest AABB capable of fully containing all of the provided AABB.

If aabbs is empty, initializes self as Self.zero.

Returns an AABB with minimum .zero and maximum .one.

Subdivides this AABB into 2 ^ D (where D is the dimensional size of Self.Vector) AABBs that occupy the same area as this AABB but subdivide it into equally-sized AABBs.

The ordering of the subdivisions is not defined.

Returns true if this AABB’s area intersects the given line type.

Performs an intersection test against the given line, returning up to two points representing the entrance and exit intersections against this AABB’s outer perimeter.