• android
    abstract class Box
Known direct subclasses
ImmutableBox

An immutable axis-aligned rectangle.
MutableBox

A mutable axis-aligned rectangle.

Represents an axis-aligned rectangle. See ImmutableBox and MutableBox for concrete classes implementing Box.

The Box interface is the read-only view of the underlying data which may or may not be mutable.

Summary

Public functions
MutableVec

Populates outVec with the center of the Box, and returns outVec.
android
Unit
computeCorners(
    outVecXMinYMin: MutableVec,
    outVecXMaxYMin: MutableVec,
    outVecXMaxYMax: MutableVec,
    outVecXMinYMax: MutableVec
)

Populates the 4 output points with the corners of the Box.
android
operator Boolean
contains(otherBox: Box)

Returns whether the other Box is contained within this Box.
android
operator Boolean
contains(point: Vec)

Returns whether the given point is contained within the Box.
android
Boolean
isAlmostEqual(other: Box, tolerance: @FloatRange(from = 0.0) Float)

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

Public properties
Float

The height of the rectangle.
android
Float

The width of the rectangle.
android
abstract Float

The upper bound in the X direction.
android
abstract Float

The lower bound in the X direction.
android
abstract Float

The upper bound in the Y direction.
android
abstract Float

The lower bound in the Y direction.
android

Extension functions
RectF

Writes the values from this Box to out.
android
RectF

Constructs a Rect with the same coordinates as the Box
android
MutableRect

Writes the values from this Box to out.
android
Rect

Constructs a Rect with the values from this Box.
android

Public functions

computeCenter

android
Added in 1.0.0-alpha05
fun computeCenter(outVec: MutableVec): MutableVec

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

computeCorners

android
Added in 1.0.0-alpha05
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)

contains

android
Added in 1.0.0-alpha05
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.

contains

android
Added in 1.0.0-alpha05
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.

isAlmostEqual

android
Added in 1.0.0-alpha05
fun isAlmostEqual(other: Box, tolerance: @FloatRange(from = 0.0) Float): Boolean

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

Public properties

height

android
Added in 1.0.0-alpha05
val height: Float

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

width

android
Added in 1.0.0-alpha05
val width: Float

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

xMax

android
Added in 1.0.0-alpha05
abstract val xMax: Float

The upper bound in the X direction.

xMin

android
Added in 1.0.0-alpha05
abstract val xMin: Float

The lower bound in the X direction.

yMax

android
Added in 1.0.0-alpha05
abstract val yMax: Float

The upper bound in the Y direction.

yMin

android
Added in 1.0.0-alpha05
abstract val yMin: Float

The lower bound in the Y direction.

Extension functions

populateRectF

android 
fun Box.populateRectF(out: RectF): RectF

Writes the values from this Box to out.

Returns the modified RectF instance to allow chaining calls.

Returns
RectF

out

toRectF

android 
fun Box.toRectF(): RectF

Constructs a Rect with the same coordinates as the Box

populateMutableRect

android 
fun Box.populateMutableRect(out: MutableRect): MutableRect

Writes the values from this Box to out.

Returns the modified MutableRect instance to allow chaining calls.

Returns
MutableRect

out

toRect

android 
fun Box.toRect(): Rect

Constructs a Rect with the values from this Box.