MutableRect
-
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 |
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 |
Moves edges inwards by the given delta. |
Cmn
|
Unit |
Moves edges outwards by the given delta. |
Cmn
|
Unit |
Modifies |
Cmn
|
Boolean |
overlaps(other: MutableRect) Whether |
Cmn
|
Boolean |
Whether |
Cmn
|
Unit |
Cmn
|
|
open String |
toString() |
Cmn
|
Unit |
Translates the rect by the provided |
Cmn
|
Unit |
Updates this rectangle with translateX added to the x components and translateY added to the y components. |
Cmn
|
Public properties |
||
---|---|---|
Float |
The offset of the bottom edge of this rectangle from the y axis. |
Cmn
|
Offset |
The offset to the center of the bottom edge of this rectangle. |
Cmn
|
Offset |
The offset to the intersection of the bottom and left edges of this rectangle. |
Cmn
|
Offset |
The offset to the intersection of the bottom and right edges of this rectangle. |
Cmn
|
Offset |
The offset to the point halfway between the left and right and the top and bottom edges of this rectangle. |
Cmn
|
Offset |
The offset to the center of the left edge of this rectangle. |
Cmn
|
Offset |
The offset to the center of the right edge of this rectangle. |
Cmn
|
Float |
The distance between the top and bottom edges of this rectangle. |
Cmn
|
Boolean |
Whether this rectangle encloses a non-zero area. |
Cmn
|
Boolean |
Whether all coordinates of this rectangle are finite. |
Cmn
|
Boolean |
Whether any of the coordinates of this rectangle are equal to positive infinity. |
Cmn
|
Float |
The offset of the left edge of this rectangle from the x axis. |
Cmn
|
Float |
The greater of the magnitudes of the |
Cmn
|
Float |
The lesser of the magnitudes of the |
Cmn
|
Float |
The offset of the right edge of this rectangle from the x axis. |
Cmn
|
Size |
The distance between the upper-left corner and the lower-right corner of this rectangle. |
Cmn
|
Float |
The offset of the top edge of this rectangle from the y axis. |
Cmn
|
Offset |
The offset to the center of the top edge of this rectangle. |
Cmn
|
Offset |
The offset to the intersection of the top and left edges of this rectangle. |
Cmn
|
Offset |
The offset to the intersection of the top and right edges of this rectangle. |
Cmn
|
Float |
The distance between the left and right edges of this rectangle. |
Cmn
|
Extension functions |
||
---|---|---|
Rect |
Cmn
|
Public constructors
MutableRect
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
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.
intersect
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
fun overlaps(other: MutableRect): Boolean
Whether other
has a nonzero area of overlap with this rectangle.
overlaps
fun overlaps(other: Rect): Boolean
Whether other
has a nonzero area of overlap with this rectangle.
Public properties
bottomCenter
val bottomCenter: Offset
The offset to the center of the bottom edge of this rectangle.
bottomLeft
val bottomLeft: Offset
The offset to the intersection of the bottom and left edges of this rectangle.
bottomRight
val bottomRight: Offset
The offset to the intersection of the bottom and right edges of this rectangle.
center
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
.
isEmpty
val isEmpty: Boolean
Whether this rectangle encloses a non-zero area. Negative areas are considered empty.
isInfinite
val isInfinite: Boolean
Whether any of the coordinates of this rectangle are equal to positive infinity.
maxDimension
val maxDimension: Float
The greater of the magnitudes of the width
and the height
of this rectangle.
minDimension
val minDimension: Float
The lesser of the magnitudes of the width
and the height
of this rectangle.
size
val size: Size
The distance between the upper-left corner and the lower-right corner of this rectangle.
topLeft
val topLeft: Offset
The offset to the intersection of the top and left edges of this rectangle.