Class Rectangle

Represents an axis-aligned bounding rectangle (AABR) defined by position, width and height. The position represents the bottom-left corner of the rectangle.
Provides methods and properties for manipulating and querying the rectangle's geometry.

Example

const rect = new Rectangle(0, 0, 100, 100);
rect.width // 100
rect.height // 100

rect.x // 0
rect.y // 0

rect.x1 // 100
rect.y1 // 100

rect.center // { x: 50, y: 50 }

rect.intersects(new Rectangle(50, 50, 100, 100)) // true

rect.contains(new Vector2(50, 50)) // true

rect.contains(new Rectangle(100, 100, 100, 100)) // false

rect.toString() // "(0, 0, 100, 100)"

Constructors

constructor

Properties

height width

Accessors

center position x x1 y y1

Methods

contains copy equals intersects set toString

Constructors

constructor

  • new Rectangle(x?, y?, width?, height?): Rectangle

  • Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalwidth: number
    • Optionalheight: number

    Returns Rectangle

Properties

height

height: number

width

width: number

Accessors

center

  • get center(): Vector2

  • Returns Vector2

position

  • get position(): Vector2

  • Returns Vector2

  • set position(position): void

  • Parameters

    Returns void

x

  • get x(): number

  • Returns number

  • set x(value): void

  • Parameters

    • value: number

    Returns void

x1

  • get x1(): number

  • Returns number

y

  • get y(): number

  • Returns number

  • set y(value): void

  • Parameters

    • value: number

    Returns void

y1

  • get y1(): number

  • Returns number

Methods

contains

  • contains(rect): boolean

  • Check if the target rectangle is contained

    Parameters

    Returns boolean

    TRUE or FALSE

  • contains(vector): boolean

  • Check if the target vector is contained

    Parameters

    Returns boolean

    TRUE or FALSE

copy

  • copy(rect): void

  • Copy the target rectangle properties

    Parameters

    Returns void

equals

  • equals(rectangle): boolean

  • Compare if two rectangles are equals

    Parameters

    • rectangle: Rectangle

      The rectangle to compare

    Returns boolean

    TRUE if the rectangles are equals, FALSE if not

intersects

  • intersects(rect): boolean

  • Check if the target rectangle is overlapping

    Parameters

    Returns boolean

    TRUE or FALSE

set

  • set(x, y, width, height): void

  • Set the rectangle

    Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns void

toString

  • toString(): string

  • Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods