MutableRect

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

Common/All

• Cmn

  class MutableRect

---

An mutable, 2D, axis-aligned, floating-point rectangle whose coordinates are relative to a given origin.

Summary

Public constructors
MutableRect(left: Float, top: Float, right: Float, bottom: Float)	Cmn

Public functions
operator Boolean	contains(offset: Offset) Whether the point specified by the given offset (which is assumed to be relative to the origin) lies between the left and right and the top and bottom edges of this rectangle.	Cmn
Unit	deflate(delta: Float) Moves edges inwards by the given delta.	Cmn
Unit	inflate(delta: Float) Moves edges outwards by the given delta.	Cmn
Unit	intersect(left: Float, top: Float, right: Float, bottom: Float) Modifies this to be the intersection of this and the rect formed by left, top, right, and bottom.	Cmn
Boolean	overlaps(other: MutableRect) Whether other has a nonzero area of overlap with this rectangle.	Cmn
Boolean	overlaps(other: Rect) Whether other has a nonzero area of overlap with this rectangle.	Cmn
Unit	set(left: Float, top: Float, right: Float, bottom: Float) Sets new bounds to (left, top, right, bottom)	Cmn
open String	toString()	Cmn
Unit	translate(offset: Offset) Translates the rect by the provided Offset.	Cmn
Unit	translate(translateX: Float, translateY: Float) Updates this rectangle with translateX added to the x components and translateY added to the y components.	Cmn

Public properties
Float	bottom The offset of the bottom edge of this rectangle from the y axis.	Cmn
Offset	bottomCenter The offset to the center of the bottom edge of this rectangle.	Cmn
Offset	bottomLeft The offset to the intersection of the bottom and left edges of this rectangle.	Cmn
Offset	bottomRight The offset to the intersection of the bottom and right edges of this rectangle.	Cmn
Offset	center The offset to the point halfway between the left and right and the top and bottom edges of this rectangle.	Cmn
Offset	centerLeft The offset to the center of the left edge of this rectangle.	Cmn
Offset	centerRight The offset to the center of the right edge of this rectangle.	Cmn
Float	height The distance between the top and bottom edges of this rectangle.	Cmn
Boolean	isEmpty Whether this rectangle encloses a non-zero area.	Cmn
Boolean	isFinite Whether all coordinates of this rectangle are finite.	Cmn
Boolean	isInfinite Whether any of the coordinates of this rectangle are equal to positive infinity.	Cmn
Float	left The offset of the left edge of this rectangle from the x axis.	Cmn
Float	maxDimension The greater of the magnitudes of the width and the height of this rectangle.	Cmn
Float	minDimension The lesser of the magnitudes of the width and the height of this rectangle.	Cmn
Float	right The offset of the right edge of this rectangle from the x axis.	Cmn
Size	size The distance between the upper-left corner and the lower-right corner of this rectangle.	Cmn
Float	top The offset of the top edge of this rectangle from the y axis.	Cmn
Offset	topCenter The offset to the center of the top edge of this rectangle.	Cmn
Offset	topLeft The offset to the intersection of the top and left edges of this rectangle.	Cmn
Offset	topRight The offset to the intersection of the top and right edges of this rectangle.	Cmn
Float	width The distance between the left and right edges of this rectangle.	Cmn

Extension functions
Rect	MutableRect.toRect()	Cmn

Public constructors

MutableRect

Cmn

Added in 1.0.0

MutableRect(left: Float, top: Float, right: Float, bottom: Float)

Parameters
left: Float	The offset of the left edge of this rectangle from the x axis.
top: Float	The offset of the top edge of this rectangle from the y axis.
right: Float	The offset of the right edge of this rectangle from the x axis.
bottom: Float	The offset of the bottom edge of this rectangle from the y axis.

Public functions

contains

Cmn

Added in 1.10.0

operator fun contains(offset: Offset): Boolean

Whether the point specified by the given offset (which is assumed to be relative to the origin) lies between the left and right and the top and bottom edges of this rectangle.

Rectangles include their top and left edges but exclude their bottom and right edges.

deflate

Cmn

Added in 1.8.0

fun deflate(delta: Float): Unit

Moves edges inwards by the given delta.

inflate

Cmn

Added in 1.8.0

fun inflate(delta: Float): Unit

Moves edges outwards by the given delta.

intersect

Cmn

Added in 1.0.0

fun intersect(left: Float, top: Float, right: Float, bottom: Float): Unit

Modifies this to be the intersection of this and the rect formed by left, top, right, and bottom.

overlaps

Cmn

Added in 1.8.0

fun overlaps(other: MutableRect): Boolean

Whether other has a nonzero area of overlap with this rectangle.

overlaps

Cmn

Added in 1.8.0

fun overlaps(other: Rect): Boolean

Whether other has a nonzero area of overlap with this rectangle.

set

Cmn

Added in 1.0.0

fun set(left: Float, top: Float, right: Float, bottom: Float): Unit

Sets new bounds to (left, top, right, bottom)

toString

Cmn

open fun toString(): String

translate

Cmn

Added in 1.10.0

fun translate(offset: Offset): Unit

Translates the rect by the provided Offset.

translate

Cmn

Added in 1.8.0

fun translate(translateX: Float, translateY: Float): Unit

Updates this rectangle with translateX added to the x components and translateY added to the y components.

Public properties

bottom

Cmn

Added in 1.0.0

var bottom: Float

The offset of the bottom edge of this rectangle from the y axis.

bottomCenter

Cmn

Added in 1.8.0

val bottomCenter: Offset

The offset to the center of the bottom edge of this rectangle.

bottomLeft

Cmn

Added in 1.8.0

val bottomLeft: Offset

The offset to the intersection of the bottom and left edges of this rectangle.

bottomRight

Cmn

Added in 1.8.0

val bottomRight: Offset

The offset to the intersection of the bottom and right edges of this rectangle.

center

Cmn

Added in 1.8.0

val center: Offset

The offset to the point halfway between the left and right and the top and bottom edges of this rectangle.

See also Size.center.

centerLeft

Cmn

Added in 1.8.0

val centerLeft: Offset

The offset to the center of the left edge of this rectangle.

centerRight

Cmn

Added in 1.8.0

val centerRight: Offset

The offset to the center of the right edge of this rectangle.

height

Cmn

Added in 1.0.0

val height: Float

The distance between the top and bottom edges of this rectangle.

isEmpty

Cmn

Added in 1.0.0

val isEmpty: Boolean

Whether this rectangle encloses a non-zero area. Negative areas are considered empty.

isFinite

Cmn

Added in 1.8.0

val isFinite: Boolean

Whether all coordinates of this rectangle are finite.

isInfinite

Cmn

Added in 1.8.0

val isInfinite: Boolean

Whether any of the coordinates of this rectangle are equal to positive infinity.

left

Cmn

Added in 1.0.0

var left: Float

The offset of the left edge of this rectangle from the x axis.

maxDimension

Cmn

Added in 1.8.0

val maxDimension: Float

The greater of the magnitudes of the width and the height of this rectangle.

minDimension

Cmn

Added in 1.8.0

val minDimension: Float

The lesser of the magnitudes of the width and the height of this rectangle.

right

Cmn

Added in 1.0.0

var right: Float

The offset of the right edge of this rectangle from the x axis.

size

Cmn

Added in 1.0.0

val size: Size

The distance between the upper-left corner and the lower-right corner of this rectangle.

top

Cmn

Added in 1.0.0

var top: Float

The offset of the top edge of this rectangle from the y axis.

topCenter

Cmn

Added in 1.8.0

val topCenter: Offset

The offset to the center of the top edge of this rectangle.

topLeft

Cmn

Added in 1.8.0

val topLeft: Offset

The offset to the intersection of the top and left edges of this rectangle.

topRight

Cmn

Added in 1.8.0

val topRight: Offset

The offset to the intersection of the top and right edges of this rectangle.

width

Cmn

Added in 1.0.0

val width: Float

The distance between the left and right edges of this rectangle.

Extension functions

MutableRect.toRect

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

fun MutableRect.toRect(): Rect