Class Rect2

A 2D axis-aligned bounding box (AABB). Includes extra methods for math and utility.

Hierarchy

Rect2

Implements

Rectangle

Index

Constructors

Properties

Accessors

area bounds copy perimeter screen world

Methods

comparisonData expand expandAssign inside overlap scale scaleAssign set translate translateAssign xywh

Constructors

constructor

new Rect2(pos: Vector2, size: Vector2): Rect2
Parameters
- pos: Vector2
- size: Vector2
Returns Rect2
- Defined in lib/math/Rect2.ts:66

Properties

pos

The position of the rectangle. (Top-left corner if x and y of size are both >= 0)

size

The size of the rectangle.

Accessors

area

get area(): number
Returns the area of the Rect2.

Returns number
- Defined in lib/math/Rect2.ts:125

bounds

get bounds(): RectBounds
Returns the RectBounds of the Rect2.

Returns RectBounds
- Defined in lib/math/Rect2.ts:135

copy

get copy(): Rect2
Returns a copy of the Rect2. Also clones properties.

Returns Rect2
- Defined in lib/math/Rect2.ts:77

perimeter

get perimeter(): number
Returns the perimeter of the Rect2.

Returns number
- Defined in lib/math/Rect2.ts:130

screen

get screen(): Rect2
Converts the Rect2 from world coordinates to screen coordinates using the currentCamera.

Returns Rect2
- Defined in lib/math/Rect2.ts:199

world

get world(): Rect2
Converts the Rect2 from screen coordinates to world coordinates using the currentCamera.

Returns Rect2
- Defined in lib/math/Rect2.ts:204

Methods

comparisonData

comparisonData(rect: Rect2): RectComparisonData
Returns the RectComparisonData of the Rect2 and another Rect2.
Parameters
- rect: Rect2
Returns RectComparisonData
- Defined in lib/math/Rect2.ts:159

expand

expand(px: number): Rect2
Expands the size of the Rect2 by a number equally on all sides. Creates a new Rect2 and does not modify the original Rect2.
Parameters
- px: number
Returns Rect2
- Defined in lib/math/Rect2.ts:111

expandAssign

expandAssign(px: number): Rect2
Expands the size of the Rect2 by a number equally on all sides. Modifies the original Rect2.
Parameters
- px: number
Returns Rect2
- Defined in lib/math/Rect2.ts:116

inside

inside(p: Point): boolean
Returns if a point is inside the Rect2.
Parameters
- p: Point
Returns boolean
- Defined in lib/math/Rect2.ts:153

overlap

overlap(rect: Rect2): boolean
Returns if the Rect2 overlaps another Rect2.
Parameters
- rect: Rect2
Returns boolean
- Defined in lib/math/Rect2.ts:145

scale

scale(f: number): Rect2
Scales the Rect2 by a scale factor. Creates a new Rect2 and does not modify the original Rect2.
Parameters
- f: number
Returns Rect2
- Defined in lib/math/Rect2.ts:100

scaleAssign

scaleAssign(f: number): Rect2
Scales the Rect2 by a scale factor. Modifies the original Rect2.
Parameters
- f: number
Returns Rect2
- Defined in lib/math/Rect2.ts:105

set

set(r: Rect2): Rect2
Sets the position and size of the Rect2 to another Rect2.
Parameters
- r: Rect2
Returns Rect2
- Defined in lib/math/Rect2.ts:82

translate

translate(v: Point): Rect2
Translates the Rect2 by a point. Creates a new Rect2 and does not modify the original Rect2.
Parameters
- v: Point
Returns Rect2
- Defined in lib/math/Rect2.ts:89

translateAssign

translateAssign(v: Point): Rect2
Translates the Rect2 by a point. Modifies the original Rect2.
Parameters
- v: Point
Returns Rect2
- Defined in lib/math/Rect2.ts:94

`Static` xywh

xywh(x: number, y: number, width: number, height: number): Rect2
Creates a Rect2 from x, y, width, and height numbers instead of pos and size
Parameters
- x: number
- y: number
- width: number
- height: number
Returns Rect2
- Defined in lib/math/Rect2.ts:72

Generated using TypeDoc