Class Rect

constructor

• new Rect(): Rect

  Create an empty rectangle at the origin.

  Returns Rect

• new Rect(other: Rect): Rect

  Create a copy of another Rect.

  Parameters

  • other: Rect

  Returns Rect

• new Rect(
      other: { height: number; left: number; top: number; width: number },
  ): Rect

  Create a rectangle from a rect-like object.

  Accepts { left, top, width, height }.

  Parameters

  • other: { height: number; left: number; top: number; width: number }

  Returns Rect

• new Rect(width: number, height: number): Rect

  Create a rectangle with size only. The rectangle is positioned at the origin.

  Parameters

  • width: number
  • height: number

  Returns Rect

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

  Create a rectangle from position and size.

  Parameters

  • x: number

    Left coordinate

  • y: number

    Top coordinate

  • width: number

    Rectangle width (must be non-negative)

  • height: number

    Rectangle height (must be non-negative)

  Returns Rect

height

width

x

y

area

• get area(): number

  Rectangle area (width * height).

  Returns number

bottom

• get bottom(): number

  Bottom edge coordinate.

  Returns number

center

• get center(): { x: number; y: number }

  Geometric center point.

  Returns { x: number; y: number }

centerX

• get centerX(): number

  Geometric center x-coordinate.

  Returns number

centerY

• get centerY(): number

  Geometric center y-coordinate.

  Returns number

isEmpty

• get isEmpty(): boolean

  Whether this rectangle has zero or negative area. Note: width and height are guaranteed non-negative.

  Returns boolean

left

• get left(): number

  Left edge coordinate.

  Returns number

right

• get right(): number

  Right edge coordinate.

  Returns number

top

• get top(): number

  Top edge coordinate.

  Returns number

ceilCopy

• ceilCopy(): Rect

  Create a copy with all edges rounded up.

  Returns Rect

clone

• clone(): Rect

  Create a deep copy of this rectangle.

  Returns Rect

containsPoint

• containsPoint(px: number, py: number): boolean

  Test whether a point lies inside or on the edges of this rectangle.

  Parameters

  • px: number
  • py: number

  Returns boolean

containsRect

• containsRect(other: Rect): boolean

  Test whether another rectangle is fully contained within this rectangle.

  Parameters

  • other: Rect

  Returns boolean

equals

• equals(other: Rect): boolean

  Test for exact equality with another rectangle.

  Parameters

  • other: Rect

  Returns boolean

expandCopy

• expandCopy(px: number, py: number): Rect

  Expand this rectangle to include a point.

  Parameters

  • px: number
  • py: number

  Returns Rect

floorCopy

• floorCopy(): Rect

  Create a copy with all edges rounded down.

  Returns Rect

inflateCopy

• inflateCopy(dx: number, dy: number): Rect

  Create an inflated (expanded) copy of this rectangle.

  Parameters

  • dx: number

    Horizontal expansion

  • dy: number

    Vertical expansion

  Returns Rect

insetCopy

• insetCopy(dx: number, dy: number): Rect

  Create an inset (shrunken) copy of this rectangle.

  Parameters

  • dx: number

    Horizontal inset

  • dy: number

    Vertical inset

  Returns Rect

intersectionCopy

• intersectionCopy(other: Rect): Rect

  Compute the intersection of this rectangle with another rectangle.

  Returns an empty rectangle if there is no overlap.

  Parameters

  • other: Rect

  Returns Rect

• intersectionCopy(
      other: { height: number; left: number; top: number; width: number },
  ): Rect

  Compute the intersection of this rectangle with another rectangle.

  Returns an empty rectangle if there is no overlap.

  Parameters

  • other: { height: number; left: number; top: number; width: number }

  Returns Rect

intersects

• intersects(other: Rect): boolean

  Test whether this rectangle intersects another rectangle.

  Edge-touching is considered an intersection.

  Parameters

  • other: Rect

  Returns boolean

• intersects(
      other: { height: number; left: number; top: number; width: number },
  ): boolean

  Test whether this rectangle intersects another rectangle.

  Edge-touching is considered an intersection.

  Parameters

  • other: { height: number; left: number; top: number; width: number }

  Returns boolean

offsetCopy

• offsetCopy(dx: number, dy: number): Rect

  Create a translated copy of this rectangle.

  Parameters

  • dx: number
  • dy: number

  Returns Rect

offsetInPlace

• offsetInPlace(dx: number, dy: number): Rect

  Move this rectangle by the given offset. Modifies this instance.

  Parameters

  • dx: number
  • dy: number

  Returns Rect

roundCopy

• roundCopy(): Rect

  Create a copy with all edges rounded to the nearest integer.

  Returns Rect

scaleCopy

• scaleCopy(scaleX: number, scaleY?: number): Rect

  Create a scaled copy of this rectangle. Scaling is performed around the geometric center.

  Parameters

  • scaleX: number
  • scaleY: number = scaleX

  Returns Rect

scaleInPlace

• scaleInPlace(scaleX: number, scaleY?: number): Rect

  Scale this rectangle around its geometric center. Modifies this instance.

  Parameters

  • scaleX: number

    Horizontal scale factor

  • scaleY: number = scaleX

    Vertical scale factor (defaults to scaleX)

  Returns Rect

set

• set(): Rect

  Reset this rectangle to the origin with zero size.

  Returns Rect

• set(width: number, height: number): Rect

  Set rectangle size and reset position to the origin.

  Parameters

  • width: number

    Rectangle width (must be non-negative)

  • height: number

    Rectangle height (must be non-negative)

  Returns Rect

• set(x: number, y: number, width: number, height: number): Rect

  Set rectangle position and size.

  Parameters

  • x: number

    Left coordinate

  • y: number

    Top coordinate

  • width: number

    Rectangle width (must be non-negative)

  • height: number

    Rectangle height (must be non-negative)

  Returns Rect

toAnchoredRect

• toAnchoredRect(): AnchoredRect

  Convert this rectangle to an AnchoredRect. The anchor is placed at the geometric center.

  Returns AnchoredRect

toString

• toString(): string

  Returns string

unionCopy

• unionCopy(other: Rect): Rect

  Compute the union of this rectangle with another rectangle.

  Parameters

  • other: Rect

  Returns Rect

• unionCopy(
      other: { height: number; left: number; top: number; width: number },
  ): Rect

  Compute the union of this rectangle with another rectangle.

  Parameters

  • other: { height: number; left: number; top: number; width: number }

  Returns Rect

StaticfromCenter

• fromCenter(cx: number, cy: number, width: number, height: number): Rect

  Create a rectangle centered at the given point.

  Parameters

  • cx: number

    Center x-coordinate

  • cy: number

    Center y-coordinate

  • width: number

    Rectangle width

  • height: number

    Rectangle height

  Returns Rect

StaticfromPoints

• fromPoints(p1: { x: number; y: number }, p2: { x: number; y: number }): Rect

  Create the smallest rectangle enclosing two points.

  Parameters

  • p1: { x: number; y: number }
  • p2: { x: number; y: number }

  Returns Rect