RoundRect

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

Common/All

• Cmn

  data class RoundRect

---

An immutable rounded rectangle with custom radii for all four corners.

Summary

Public companion properties
RoundRect	Zero A rounded rectangle with all the values set to zero.	Cmn

Public constructors
RoundRect(     left: Float,     top: Float,     right: Float,     bottom: Float,     topLeftCornerRadius: CornerRadius,     topRightCornerRadius: CornerRadius,     bottomRightCornerRadius: CornerRadius,     bottomLeftCornerRadius: CornerRadius )	Cmn

Public functions
operator Boolean	contains(point: Offset) Whether the point specified by the given offset (which is assumed to be relative to the origin) lies inside the rounded rectangle.	Cmn
open String	toString()	Cmn

Public properties
Float	bottom The offset of the bottom edge of this rectangle from the y axis	Cmn
CornerRadius	bottomLeftCornerRadius The bottom-left radius	Cmn
CornerRadius	bottomRightCornerRadius The bottom-right radius	Cmn
Float	height The distance between the top and bottom edges of this rectangle.	Cmn
Float	left The offset of the left edge of this rectangle from the x axis	Cmn
Float	right The offset of the right edge of this rectangle from the x axis	Cmn
Float	top The offset of the top edge of this rectangle from the y axis	Cmn
CornerRadius	topLeftCornerRadius The top-left radius	Cmn
CornerRadius	topRightCornerRadius The top-right radius	Cmn
Float	width The distance between the left and right edges of this rectangle.	Cmn

Extension functions
RoundRect	RoundRect.translate(offset: Offset) Returns a new RoundRect translated by the given offset.	Cmn

Extension properties
Rect	RoundRect.boundingRect The bounding box of this rounded rectangle (the rectangle with no rounded corners).	Cmn
Offset	RoundRect.center The offset to the point halfway between the left and right and the top and bottom edges of this rectangle.	Cmn
Boolean	RoundRect.isCircle Whether this rounded rectangle would draw as a circle.	Cmn
Boolean	RoundRect.isEllipse Whether this rounded rectangle has no side with a straight section.	Cmn
Boolean	RoundRect.isEmpty Whether this rounded rectangle encloses a non-zero area.	Cmn
Boolean	RoundRect.isFinite Whether all coordinates of this rounded rectangle are finite.	Cmn
Boolean	RoundRect.isRect Whether this rounded rectangle is a simple rectangle with zero corner radii.	Cmn
Boolean	RoundRect.isSimple Returns true if the rounded rectangle have the same radii in both the horizontal and vertical direction for all corners.	Cmn
Float	RoundRect.maxDimension	Cmn
Float	RoundRect.minDimension The lesser of the magnitudes of the RoundRect.width and the RoundRect.height of this rounded rectangle.	Cmn
Rect	RoundRect.safeInnerRect The non-rounded rectangle that is constrained by the smaller of the two diagonals, with each diagonal traveling through the middle of the curve corners.	Cmn

Public companion properties

Zero

Cmn

Added in 1.0.0

val Zero: RoundRect

A rounded rectangle with all the values set to zero.

Public constructors

RoundRect

Cmn

RoundRect(
    left: Float,
    top: Float,
    right: Float,
    bottom: Float,
    topLeftCornerRadius: CornerRadius = CornerRadius.Zero,
    topRightCornerRadius: CornerRadius = CornerRadius.Zero,
    bottomRightCornerRadius: CornerRadius = CornerRadius.Zero,
    bottomLeftCornerRadius: CornerRadius = CornerRadius.Zero
)

Public functions

contains

Cmn

operator fun contains(point: Offset): Boolean

Whether the point specified by the given offset (which is assumed to be relative to the origin) lies inside the rounded rectangle.

This method may allocate (and cache) a copy of the object with normalized radii the first time it is called on a particular RoundRect instance. When using this method, prefer to reuse existing RoundRects rather than recreating the object each time.

toString

Cmn

open fun toString(): String

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

bottomLeftCornerRadius

Cmn

Added in 1.0.0

val bottomLeftCornerRadius: CornerRadius

The bottom-left radius

bottomRightCornerRadius

Cmn

Added in 1.0.0

val bottomRightCornerRadius: CornerRadius

The bottom-right radius

height

Cmn

Added in 1.0.0

val height: Float

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

left

Cmn

Added in 1.0.0

val left: Float

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

right

Cmn

Added in 1.0.0

val right: Float

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

top

Cmn

Added in 1.0.0

val top: Float

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

topLeftCornerRadius

Cmn

Added in 1.0.0

val topLeftCornerRadius: CornerRadius

The top-left radius

topRightCornerRadius

Cmn

Added in 1.0.0

val topRightCornerRadius: CornerRadius

The top-right radius

width

Cmn

Added in 1.0.0

val width: Float

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

Extension functions

translate

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

fun RoundRect.translate(offset: Offset): RoundRect

Returns a new RoundRect translated by the given offset.

Extension properties

boundingRect

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.boundingRect: Rect

The bounding box of this rounded rectangle (the rectangle with no rounded corners).

center

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.center: Offset

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

isCircle

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isCircle: Boolean

Whether this rounded rectangle would draw as a circle.

isEllipse

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isEllipse: Boolean

Whether this rounded rectangle has no side with a straight section.

isEmpty

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isEmpty: Boolean

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

isFinite

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isFinite: Boolean

Whether all coordinates of this rounded rectangle are finite.

isRect

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isRect: Boolean

Whether this rounded rectangle is a simple rectangle with zero corner radii.

isSimple

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.isSimple: Boolean

Returns true if the rounded rectangle have the same radii in both the horizontal and vertical direction for all corners.

maxDimension

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.maxDimension: Float

minDimension

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.minDimension: Float

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

safeInnerRect

Cmn

Artifact: androidx.compose.ui:ui-geometry

View Source

Added in 1.0.0

val RoundRect.safeInnerRect: Rect

The non-rounded rectangle that is constrained by the smaller of the two diagonals, with each diagonal traveling through the middle of the curve corners. The middle of a corner is the intersection of the curve with its respective quadrant bisector.