Class Rect

Axis-aligned 2D rectangle (x, y, w, h).

Index

Constructors

Accessors

Methods

clone collide collideFull collidePoint collideSide equals inflate pos round set size toString fromBoundingClientRect fromPolygon

Constructors

constructor

new Rect(x?: number, y?: number, w?: number, h?: number): Rect
Parameters
- x: number = 0
- y: number = 0
- w: number = 0
- h: number = 0
Returns Rect
- Defined in math/Rect.ts:131

Accessors

h

get h(): number
Height.

Returns number
- Defined in math/Rect.ts:102
set h(value: number): void
Height.
Parameters
- value: number
Returns void
- Defined in math/Rect.ts:107

sides

get sides(): Readonly<Sides>
Derived sides/center/halfSize. Lazily recomputed after any x/y/w/h change.

Returns Readonly<Sides>
- Defined in math/Rect.ts:113

w

get w(): number
Width.

Returns number
- Defined in math/Rect.ts:91
set w(value: number): void
Width.
Parameters
- value: number
Returns void
- Defined in math/Rect.ts:96

x

get x(): number
Top-left x.

Returns number
- Defined in math/Rect.ts:69
set x(value: number): void
Top-left x.
Parameters
- value: number
Returns void
- Defined in math/Rect.ts:74

y

get y(): number
Top-left y.

Returns number
- Defined in math/Rect.ts:80
set y(value: number): void
Top-left y.
Parameters
- value: number
Returns void
- Defined in math/Rect.ts:85

Methods

clone

clone(): Rect
New Rect with the same values.

Returns Rect
- Defined in math/Rect.ts:261

collide

collide(rect: Rect): boolean
AABB-vs-AABB overlap test (inclusive of touching edges).
Parameters
- rect: Rect
Returns boolean
- Defined in math/Rect.ts:193

collideFull

collideFull(rect: Rect): boolean
true when rect is fully inside this.
Parameters
- rect: Rect
Returns boolean
- Defined in math/Rect.ts:203

collidePoint

collidePoint(vec: Vector2): boolean
true when vec lies inside this (inclusive of edges).
Parameters
- vec: Vector2
Returns boolean
- Defined in math/Rect.ts:213

collideSide

collideSide(rect: Rect): "bottom" | "right" | "none" | "top" | "left"
Side of this that rect overlaps from, or "none" if disjoint. Useful for picking a bounce axis.
Parameters
- rect: Rect
Returns "bottom" | "right" | "none" | "top" | "left"
- Defined in math/Rect.ts:223

equals

equals(other: Rect, withSize?: boolean): boolean
Approximate equality. Pass withSize: false to compare position only.
Parameters
- other: Rect
- withSize: boolean = true
Returns boolean
- Defined in math/Rect.ts:266

inflate

inflate(delta: number): Rect
Grow on every side by delta (x/y shift in, w/h grow by 2*delta). Pass a negative value to shrink. Mutates and returns this.
Parameters
- delta: number
Returns Rect
- Defined in math/Rect.ts:136

pos

pos(): Vec2
Top-left corner as a new Vec2.

Returns Vec2
- Defined in math/Rect.ts:246

round

round(): Rect
Round x and y to the nearest integer. w/h are unchanged. Mutates and returns this.

Returns Rect
- Defined in math/Rect.ts:149

set

set(x?: number | Vector2 | Vector4, y?: number, w?: number, h?: number): Rect
Replace fields. The first arg may be a Vector4 (sets all four), a Vector2 (sets x/y only, unless explicit w/h follow), or x as a number with separate y/w/h. Mutates and returns this.
Parameters
- x: number | Vector2 | Vector4 = 0
- y: number = 0
- Optionalw: number
- Optionalh: number
Returns Rect
- Defined in math/Rect.ts:161

size

size(): Vec2
Width and height as a new Vec2.

Returns Vec2
- Defined in math/Rect.ts:251

toString

toString(): string
Debug string like "Rect [x: 0, y: 0, w: 10, h: 20]".

Returns string
- Defined in math/Rect.ts:256

`Static`fromBoundingClientRect

fromBoundingClientRect(rect: HTMLElement | DOMRect): Rect
Build from an HTMLElement (via getBoundingClientRect) or a DOMRect.
Parameters
- rect: HTMLElement | DOMRect
Returns Rect
- Defined in math/Rect.ts:21

`Static`fromPolygon

fromPolygon(polygon: Polygon): Rect
Axis-aligned bounding box of a polygon's points. Throws if the polygon has no points.
Parameters
- polygon: Polygon
Returns Rect
- Defined in math/Rect.ts:30