Module "rectangle"

Index

Interfaces

Rectangle

Constructor Functions

Other Functions

Points Functions

Transform Functions

Constructor Functions

from

from(x: number, y: number, width: number, height: number): Rectangle

- Defined in rectangle.ts:48
Creates a rectangle from x and y coordinates and a width and height.

Parameters
- x: number
- y: number
- width: number
- height: number
Returns Rectangle

fromBounds

fromBounds(x1: number, y1: number, x2: number, y2: number): Rectangle

- Defined in rectangle.ts:66
Creates a rectangle from its bounds.

Parameters
- x1: number
  
  The left coordinate
- y1: number
  
  The top coordinate
- x2: number
  
  The right coordinate
- y2: number
  
  The bottom coordinate
Returns Rectangle

fromPoints

fromPoints(p1: Point, p2: Point): Rectangle

- Defined in rectangle.ts:90
Creates a rectangle from two points.

If necessary the coordinates will be flipped to ensure that the resulting rectangle does not have negative dimensions.

Parameters
- p1: Point
- p2: Point
Returns Rectangle

Other Functions

area

area(rectangle: Rectangle): number

- Defined in rectangle.ts:134
Calculates the area of rectangle.

Parameters
- rectangle: Rectangle
Returns number

clone

clone(rectangle: Rectangle): Rectangle

- Defined in rectangle.ts:107
Creates a copy of rectangle that can be modified separately.

Parameters
- rectangle: Rectangle
Returns Rectangle

contains

contains(rectangle: Rectangle, point: Point): boolean

- Defined in rectangle.ts:213
Determines whether rectangle contains point.

Parameters
- rectangle: Rectangle
- point: Point
Returns boolean

equals

equals(r1: Rectangle, r2: Rectangle): boolean

- Defined in rectangle.ts:122
Determines whether r1 and r2 are equal.

Rectangles are considered equal if they have the same coordinates and dimensions.

Parameters
- r1: Rectangle
- r2: Rectangle
Returns boolean

intersects

intersects(r1: Rectangle, r2: Rectangle): boolean

- Defined in rectangle.ts:201
Determines whether r1 and r2 intersect.

Parameters
- r1: Rectangle
- r2: Rectangle
Returns boolean

is

is(value: any): value is Rectangle

- Defined in rectangle.ts:32
Determines whether value is a Rectangle.

Parameters
- value: any
Returns value is Rectangle

Points Functions

bottomLeft

bottomLeft(rectangle: Rectangle): Point

- Defined in rectangle.ts:179
Gets the bottom left point of rectangle.

Parameters
- rectangle: Rectangle
Returns Point

bottomRight

bottomRight(rectangle: Rectangle): Point

- Defined in rectangle.ts:191
Gets the bottom right point of rectangle.

Parameters
- rectangle: Rectangle
Returns Point

center

center(rectangle: Rectangle): Point

- Defined in rectangle.ts:143
Gets the center point of rectangle.

Parameters
- rectangle: Rectangle
Returns Point

topLeft

topLeft(rectangle: Rectangle): Point

- Defined in rectangle.ts:155
Gets the top left point of rectangle.

Parameters
- rectangle: Rectangle
Returns Point

topRight

topRight(rectangle: Rectangle): Point

- Defined in rectangle.ts:167
Gets the top right point of rectangle.

Parameters
- rectangle: Rectangle
Returns Point

Transform Functions

translate

translate(rectangle: Rectangle, vector: Vector): void

- Defined in rectangle.ts:230
Translate rectangle by a vector.

This modifies rectangle. Use translated if you want to create a new rectangle.

Parameters
- rectangle: Rectangle
- vector: Vector
Returns void

translated

translated(rectangle: Rectangle, vector: Vector): Rectangle

- Defined in rectangle.ts:242
Creates a new rectangle by translating rectangle by vector.

Use translate if you want to modify rectangle instead.

Parameters
- rectangle: Rectangle
- vector: Vector
Returns Rectangle

Generated using TypeDoc