Class Rectangle

Represents a Rectangle

Hierarchy

Rectangle

Implements

Shape<Rectangle>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Rectangle(_x?: number, _y?: number, _width?: number, _height?: number, _angle?: number): Rectangle

- Defined in lib/geometry.ts:510
Creates a new Rectangle

Parameters
- Default value _x: number = 0
  
  Abscissa of center
- Default value _y: number = 0
  
  Ordinate of center
- Default value _width: number = 0
  
  width of Rectangle
- Default value _height: number = 0
  
  height of Rectangle
- Default value _angle: number = 0
  
  rotation
Returns Rectangle

Properties

Private _angle

_angle: number

rotation

Private _height

_height: number

height of Rectangle

Private _width

_width: number

width of Rectangle

Private _x

_x: number

Abscissa of center

Private _y

_y: number

Ordinate of center

Protected halfHeight

halfHeight: number

Protected halfWidth

halfWidth: number

Accessors

angle

get angle(): number

- Defined in lib/geometry.ts:563
Returns number

height

get height(): number

- Defined in lib/geometry.ts:559
Height of rectangle

Returns number

width

get width(): number

- Defined in lib/geometry.ts:554
Width of the rectangle

Returns number

x

get x(): number

- Defined in lib/geometry.ts:544
Abscissa of the center of the rectangle

Returns number

y

get y(): number

- Defined in lib/geometry.ts:549
Ordinate of the center of the rectangle

Returns number

Methods

clone

clone(): Rectangle

Implementation of Shape.clone
- Defined in lib/geometry.ts:710
Clones current Rectangle

Returns Rectangle

A copy of current Rectangle

collides

collides(shape: Shape<any>): boolean

Implementation of Shape.collides
- Defined in lib/geometry.ts:752
Checks if Rectangle collides another shape

Parameters
- shape: Shape<any>
  
  Shape to check
Returns boolean

true only if provided shape collides current Rectangle

contains

contains(p: Point): boolean
contains(coordX: number, coordY: number): boolean

Implementation of Shape.contains
- Defined in lib/geometry.ts:720
Checks if a point is within the bounds (inclusive) of a Rectangle

Parameters
- p: Point
  
  Point to check
Returns boolean

true only if Point is inside current Rectangle
Implementation of Shape.contains
- Defined in lib/geometry.ts:721
Parameters
- coordX: number
- coordY: number
Returns boolean

getVertices

getVertices(): Array<Point>

- Defined in lib/geometry.ts:833
lists vertices of the rectangle

Returns Array<Point>

Vertices of the Rectangle, two adjacents vertices in the array form an edge of the Rectangle

move

move(coordX: number, coordY: number): Rectangle
move(vect: Vector): Rectangle

Implementation of Shape.move
- Defined in lib/geometry.ts:574
Translates current Rectangle to relative coordinates

Parameters
- coordX: number
- coordY: number
Returns Rectangle

Current Rectangle
Implementation of Shape.move
- Defined in lib/geometry.ts:581
Translates current Rectangle to relative coordinates

Parameters
- vect: Vector
  
  Vector to add
Returns Rectangle

Current Rectangle

moveTo

moveTo(coordX: number, coordY: number): Rectangle
moveTo(point: Point): Rectangle

Implementation of Shape.moveTo
- Defined in lib/geometry.ts:601
Translates current Rectangle to absolute coordinates

Parameters
- coordX: number
- coordY: number
Returns Rectangle

Current Rectangle
Implementation of Shape.moveTo
- Defined in lib/geometry.ts:608
Translates current Rectangle to absolute coordinates

Parameters
- point: Point
  
  New origin for Rectangle
Returns Rectangle

Current Rectangle

reset

reset(newX: number, newY: number, newWidth: number, newHeight: number, newAngle?: number): Rectangle

- Defined in lib/geometry.ts:692
Resets Rectangle dimensions

Parameters
- newX: number
  
  New abscissa
- newY: number
  
  New ordinate
- newWidth: number
  
  New width
- newHeight: number
  
  New height
- Default value newAngle: number = 0
  
  New rotation
Returns Rectangle

Current Rectangle

resize

resize(newWidth: number, newHeight: number): Rectangle

- Defined in lib/geometry.ts:628
Changes size of Rectangle

Parameters
- newWidth: number
  
  New width
- newHeight: number
  
  New height
Returns Rectangle

Current Rectangle

rotate

rotate(angle: number): Rectangle

Implementation of Shape.rotate
- Defined in lib/geometry.ts:665
Rotates Rectangle

Parameters
- angle: number
  
  New rotation in degrees
Returns Rectangle

Current Rectangle

rotateRad

rotateRad(angle: number): Rectangle

Implementation of Shape.rotateRad
- Defined in lib/geometry.ts:676
Rotates Rectangle

Parameters
- angle: number
  
  New rotation in radians
Returns Rectangle

Current Rectangle

scale

scale(ratio: number): Rectangle

Implementation of Shape.scale
- Defined in lib/geometry.ts:644
Scales rectangle

Parameters
- ratio: number
  
  Scale ratio
Returns Rectangle

Current Rectangle

Static asRect

asRect(x: number, y: number, width: number, height: any): Rectangle

- Defined in lib/geometry.ts:538
Helper method to create a rectangle from its upper-left corner

Parameters
- x: number
  
  Abscissa of upper-left corner
- y: number
  
  Ordinate of upper-left corner
- width: number
  
  width of Rectangle
- height: any
  
  height of Rectangle
Returns Rectangle

Corresponding Rectangle

Generated using TypeDoc