/
Android Studio Sign in

ImmutableBox
kotlin.Any
   ↳ androidx.ink.geometry.Box
     ↳ androidx.ink.geometry.ImmutableBox

An immutable axis-aligned rectangle. See MutableBox for a mutable version.

Note that unlike android.graphics.RectF, this does not express an opinion about axis direction (e.g. the positive Y axis being "down"), because it is intended to be used with any coordinate system rather than just Android screen / View space.

Summary

Nested types

Public companion functions
ImmutableBox
fromCenterAndDimensions(
    center: Vec,
    width: @FloatRange(from = 0.0) Float,
    height: @FloatRange(from = 0.0) Float
)

Constructs an ImmutableBox with a given center, width, and height.
android
ImmutableBox
fromTwoPoints(point1: Vec, point2: Vec)

Constructs the smallest ImmutableBox containing the two given points.
android

Public functions
open operator Boolean
equals(other: Any?)
android
open Int
android
open String
android

Public properties
open Float

The upper bound in the X direction.
android
open Float

The lower bound in the X direction.
android
open Float

The upper bound in the Y direction.
android
open Float

The lower bound in the Y direction.
android

Inherited functions
From androidx.ink.geometry.Box
ImmutableVec

Returns the center of the Box.
android
MutableVec

Populates outVec with the center of the Box, and returns outVec.
android
List<ImmutableVec>

Returns a list containing the 4 corners of the Box.
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

Inherited properties
From androidx.ink.geometry.Box
Float

The height of the rectangle.
android
Float

The width of the rectangle.
android

Public companion functions

fromCenterAndDimensions

android
Added in 1.0.0-rc01
fun fromCenterAndDimensions(
    center: Vec,
    width: @FloatRange(from = 0.0) Float,
    height: @FloatRange(from = 0.0) Float
): ImmutableBox

Constructs an ImmutableBox with a given center, width, and height.

fromTwoPoints

android
Added in 1.0.0-rc01
fun fromTwoPoints(point1: Vec, point2: Vec): ImmutableBox

Constructs the smallest ImmutableBox containing the two given points.

Public functions

equals

android 
open operator fun equals(other: Any?): Boolean

hashCode

android 
open fun hashCode(): Int

toString

android 
open fun toString(): String

Public properties

xMax

android 
open val xMax: Float

The upper bound in the X direction.

xMin

android 
open val xMin: Float

The lower bound in the X direction.

yMax

android 
open val yMax: Float

The upper bound in the Y direction.

yMin

android 
open val yMin: Float

The lower bound in the Y direction.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.