Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rectangle

A rectangle in 2D space

Hierarchy

  • Rectangle

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

    Parameters

    • x: number = 0
    • y: number = 0
    • width: number = 0
    • height: number = 0

    Returns Rectangle

Properties

height

height: number

Height in 2D space

width

width: number

Width in 2D space

x

x: number

X coordinate in 2D space

y

y: number

Y coordinate in 2D space

Accessors

bottom

  • get bottom(): number
  • Return the bottom-most coordinate

    Returns number

right

  • get right(): number
  • Return the right-most coordinate

    Returns number

Methods

fit

  • Fit this rectangle inside another

    Parameters

    Returns void

set

  • set(x: number, y: number, width: number, height: number): void
  • Set this rectangle's dimensions

    Parameters

    • x: number

      X coordinate

    • y: number

      Y coordinate

    • width: number

      Width

    • height: number

      Height

    Returns void

Static fit

Generated using TypeDoc