Box

fun computeCenter(): ImmutableVec

Returns the center of the Box.

Performance-sensitive code should use the computeCenter overload that takes a pre-allocated MutableVec, so that instance can be reused across multiple calls.

fun computeCenter(outVec: MutableVec): MutableVec

Populates outVec with the center of the Box, and returns outVec.

fun computeCorners(): List<ImmutableVec>

Returns a list containing the 4 corners of the Box. The order of the corners is: (x_min, y_min), (x_max, y_min), (x_max, y_max), (x_min, y_max).

fun computeCorners(
    outVecXMinYMin: MutableVec,
    outVecXMaxYMin: MutableVec,
    outVecXMaxYMax: MutableVec,
    outVecXMinYMax: MutableVec
): Unit

Populates the 4 output points with the corners of the Box. The order of the corners is: (x_min, y_min), (x_max, y_min), (x_max, y_max), (x_min, y_max)

operator fun contains(otherBox: Box): Boolean

Returns whether the other Box is contained within this Box. Edges of the other Box that overlap with this one's boundary are considered to be contained.

operator fun contains(point: Vec): Boolean

Returns whether the given point is contained within the Box. Points that lie exactly on the Box's boundary are considered to be contained.

fun isAlmostEqual(other: Box, tolerance: @FloatRange(from = 0.0) Float): Boolean

Compares this Box with other, and returns true if the difference between xMin from this and xMin from other is less than tolerance, and likewise for xMax, yMin, and yMax.

abstract fun toImmutable(): ImmutableBox

Returns an immutable copy of this object. This will return itself if called on an immutable instance.

val height: Float

The height of the rectangle. This can never be negative.

val width: Float

The width of the rectangle. This can never be negative.

abstract val xMax: Float

The upper bound in the X direction.

abstract val xMin: Float

The lower bound in the X direction.

abstract val yMax: Float

The upper bound in the Y direction.

abstract val yMin: Float

The lower bound in the Y direction.

fun Box.populateRectF(out: RectF): RectF

Writes the values from this Box to out.

Returns the modified RectF instance to allow chaining calls.

fun Box.toRectF(): RectF

Constructs a RectF with the same coordinates as the Box

fun Box.populateMutableRect(out: MutableRect): MutableRect

Writes the values from this Box to out.

Returns the modified MutableRect instance to allow chaining calls.

fun Box.toRect(): Rect

Constructs a Rect with the values from this Box.