Class RectBeta

constructor

• new Rect(
      x: number,
      y: number,
      width: number,
      height: number,
      angle?: number,
  ): Rect
  Beta

  The constructor of the Rect class

  Parameters

  • x: number

    the x position of the Rect
  • y: number

    the y position of the Rect
  • width: number

    the width of the Rect
  • height: number

    the height of the Rect
  • angle: number = 0

    the angle of rotation of the Rect in radians (default: 0)

  Returns Rect

Beta_height

Beta_width

Betaangle

Betax

Betay

area

• get area(): number
  Beta

  Calculates the area of the Rect

  Returns number

  the area of the Rect

bottom

• get bottom(): number
  Beta

  The y position of the bottom side of the Rect

  Returns number
• set bottom(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

center

• get center(): Point
  Beta

  Get the center of the Rect as a Point.

  (use Rect.center.Point.array to get the center as a PointArray).

  Returns Point

  the center of the Rect
• set center(value: PointArray | Point): void
  Beta

  Parameters

  • value: PointArray | Point

  Returns void

height

• get height(): number
  Beta

  The height of the Rect

  Returns number
• set height(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

left

• get left(): number
  Beta

  The x position of the left side of the Rect

  Returns number
• set left(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

perimeter

• get perimeter(): number
  Beta

  Calculates the perimeter of the Rect

  Returns number

  the perimeter of the Rect

points

• get points(): [Point, Point, Point, Point]
  Beta

  The points of the Rect as an array of Points

  Returns [Point, Point, Point, Point]

right

• get right(): number
  Beta

  The x position of the right side of the Rect

  Returns number
• set right(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

top

• get top(): number
  Beta

  The y position of the top side of the Rect

  Returns number
• set top(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

width

• get width(): number
  Beta

  The width of the Rect

  Returns number
• set width(value: number): void
  Beta

  Parameters

  • value: number

  Returns void

clone

• clone(): Rect
  Beta

  Creates a deep copy of the Rect

  Returns Rect

  a new Rect with the same properties as the original

collidePoint

• collidePoint(point: PointArray | Point): boolean
  Beta

  Checks if a Point touches the Rect

  Parameters

  • point: PointArray | Point

    the Point to check

  Returns boolean

  true if the point is inside the Rect, false otherwise

collideRect

• collideRect(other: Rect): boolean
  Beta

  Checks if two Rects collide

  Parameters

  • other: Rect

    another Rect

  Returns boolean

  true or false

equals

• equals(other: Rect): boolean
  Beta

  Parameters

  • other: Rect

    the other Rect

  Returns boolean

  if the Rect is equal to another Rect

from

• from(other: Rect): void
  Beta

  Updates the Rect to equal the given Rect

  Parameters

  • other: Rect

    the Rect to copy

  Returns void

intersects

• intersects(other: PointArray | Point | Rect | Circle): boolean
  Beta

  Checks for intersection with another shape

  Parameters

  • other: PointArray | Point | Rect | Circle

    the other shape to check for intersection

  Returns boolean

  true if the shapes intersect, false otherwise

overlapRect

• overlapRect(other: Readonly<Rect>): number
  Beta

  Checks if two Rects overlap

  Parameters

  • other: Readonly<Rect>

    another Rect

  Returns number

  the magnitude of the overlap

resizeAndRecenter

• resizeAndRecenter(size: PointArray | Point): void
  Beta

  Resizes the Rect leaving its center in the same place

  Parameters

  • size: PointArray | Point

    the new size for the Rect

  Returns void

rotate

• rotate(theta: number, origin?: PointArray | Point): void
  Alpha

  Rotates the Rect by theta around a given origin

  Parameters

  • theta: number

    the amount in radians to rotate
  • origin: PointArray | Point = ...

    the origin Point to rotate around (default: Rect.center))

  Returns void

teleportTo

• teleportTo(position: PointArray | Point): void
  Beta

  Move the Rect to a new position

  Parameters

  • position: PointArray | Point

    the new position

  Returns void

toString

• toString(): string
  Beta

  Returns string

  string representation of the Rect

Staticfrom

• from(other: Rect): Rect
  Beta

  Constructs a new Rect from a given Rect

  Parameters

  • other: Rect

    Rect to copy

  Returns Rect

  the new Rect