BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.transforms/Rect

Rect

open class Rect

A Rect is a set of two generic Vector2d instances that define a united upright rectangle.

Author

Lucas Bubner, 2024

Since

5.1.0

Constructors

Rect

constructor(@NonNull p1: Vector2d, @NonNull p2: Vector2d, @NonNull unit: Distance)

Create a new Rect based on two points.

Properties

point1

@NonNull

open var point1: Vector2d

The first point making up this Rect.

point2

@NonNull

open var point2: Vector2d

The second point making up this Rect.

unit

val unit: Distance

The distance unit these Rect dimensions were constructed with.

Functions

area

@NonNull

open fun area(): Measure<Distance>

Calculates the area of this Rect.

centeredAt

@NonNull

open fun centeredAt(@NonNull center: Vector2d): Rect

Return a new Rect such that the center of the new Rect is at the supplied point.

contains

open fun contains(@NonNull other: Rect): Boolean

Check whether this Rect fully contains another Rect.

open fun contains(@NonNull point: Vector2d, @NonNull unit: Distance): Boolean

Check whether this Rect contains this Vector2d.

copy

@NonNull

open fun copy(): Rect

draw

open fun draw(@NonNull canvas: Canvas)

Draw this Rect on an FtcDashboard canvas.

equals

open fun equals(other: Any): Boolean

hashCode

open fun hashCode(): Int

normalise

@NonNull

open fun normalise(@NonNull rect: Rect): Rect

Normalise a Rect such that the first point is the bottom left and the second point is the top right.

overlaps

open fun overlaps(@NonNull other: Rect): Boolean

Check whether this Rect overlaps another Rect in some way.

toString

@NonNull

open fun toString(): String