Rect

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

Common/All

• Cmn

  data class Rect

---

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

Summary

Nested types
object Rect.Companion

Public companion properties
Rect	Zero A rectangle with left, top, right, and bottom edges all at zero.	Cmn

Public constructors
Rect(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
Rect	deflate(delta: Float) Returns a new rectangle with edges moved inwards by the given delta.	Cmn
Rect	inflate(delta: Float) Returns a new rectangle with edges moved outwards by the given delta.	Cmn
Rect	intersect(other: Rect) Returns a new rectangle that is the intersection of the given rectangle and this rectangle.	Cmn
Rect	intersect(     otherLeft: Float,     otherTop: Float,     otherRight: Float,     otherBottom: Float ) Returns a new rectangle that is the intersection of the given rectangle and this rectangle.	Cmn
Boolean	overlaps(other: Rect) Whether other has a nonzero area of overlap with this rectangle.	Cmn
open String	toString()	Cmn
Rect	translate(offset: Offset) Returns a new rectangle translated by the given offset.	Cmn
Rect	translate(translateX: Float, translateY: Float) Returns a new 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
IntRect	Rect.roundToIntRect() Rounds a Rect to an IntRect	Cmn
Rect	Rect.toAndroidRect() This function is deprecated. Converting Rect to android.graphics.Rect is lossy, and requires rounding.	android
RectF	Rect.toAndroidRectF() Creates a new instance of android.graphics.RectF with the same bounds specified in the given Rect	android

Public companion properties

Zero

Cmn

Added in 1.0.0

val Zero: Rect

A rectangle with left, top, right, and bottom edges all at zero.

Public constructors

Rect

Cmn

Added in 1.0.0

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

Public functions

contains

Cmn

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.0.0

fun deflate(delta: Float): Rect

Returns a new rectangle with edges moved inwards by the given delta.

inflate

Cmn

Added in 1.0.0

fun inflate(delta: Float): Rect

Returns a new rectangle with edges moved outwards by the given delta.

intersect

Cmn

Added in 1.0.0

fun intersect(other: Rect): Rect

Returns a new rectangle that is the intersection of the given rectangle and this rectangle. The two rectangles must overlap for this to be meaningful. If the two rectangles do not overlap, then the resulting Rect will have a negative width or height.

intersect

Cmn

Added in 1.6.0

fun intersect(
    otherLeft: Float,
    otherTop: Float,
    otherRight: Float,
    otherBottom: Float
): Rect

Returns a new rectangle that is the intersection of the given rectangle and this rectangle. The two rectangles must overlap for this to be meaningful. If the two rectangles do not overlap, then the resulting Rect will have a negative width or height.

overlaps

Cmn

Added in 1.0.0

fun overlaps(other: Rect): Boolean

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

toString

Cmn

open fun toString(): String

translate

Cmn

fun translate(offset: Offset): Rect

Returns a new rectangle translated by the given offset.

To translate a rectangle by separate x and y components rather than by an Offset, consider translate.

translate

Cmn

Added in 1.0.0

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

Returns a new rectangle with translateX added to the x components and translateY added to the y components.

Public properties

bottom

Cmn

Added in 1.0.0

val bottom: Float

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

bottomCenter

Cmn

Added in 1.0.0

val bottomCenter: Offset

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

bottomLeft

Cmn

Added in 1.0.0

val bottomLeft: Offset

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

bottomRight

Cmn

Added in 1.0.0

val bottomRight: Offset

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

center

Cmn

Added in 1.0.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.0.0

val centerLeft: Offset

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

centerRight

Cmn

Added in 1.0.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.0.0

val isFinite: Boolean

Whether all coordinates of this rectangle are finite.

isInfinite

Cmn

Added in 1.0.0

val isInfinite: Boolean

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

left

Cmn

Added in 1.0.0

val left: Float

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

maxDimension

Cmn

Added in 1.0.0

val maxDimension: Float

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

minDimension

Cmn

Added in 1.0.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

val 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

val top: Float

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

topCenter

Cmn

Added in 1.0.0

val topCenter: Offset

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

topLeft

Cmn

Added in 1.0.0

val topLeft: Offset

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

topRight

Cmn

Added in 1.0.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

roundToIntRect

Cmn

Artifact: androidx.compose.ui:ui-unit

View Source

fun Rect.roundToIntRect(): IntRect

Rounds a Rect to an IntRect

toAndroidRect

android

Artifact: androidx.compose.ui:ui-graphics

View Source

fun Rect.toAndroidRect(): Rect

This function is deprecated.
Converting Rect to android.graphics.Rect is lossy, and requires rounding. The behavior of toAndroidRect() truncates to an integral Rect, but you should choose the method of rounding most suitable for your use case.

Creates a new instance of android.graphics.Rect with the same bounds specified in the given Rect

toAndroidRectF

android

Artifact: androidx.compose.ui:ui-graphics

View Source

fun Rect.toAndroidRectF(): RectF

Creates a new instance of android.graphics.RectF with the same bounds specified in the given Rect