Class HSRect

constructor

• new HSRect(x: number, y: number, w: number, h: number): HSRect

  Create a new HSRect object

  Parameters

  • x: number

    The x-axis coordinate of the top-left corner

  • y: number

    The y-axis coordinate of the top-left corner

  • w: number

    The width of the rectangle

  • h: number

    The height of the rectangle

  Returns HSRect

h

origin

size

w

x

y

angleTo

• angleTo(other: HSRect | HSPoint): number

  Returns the angle between the positive x axis and the vector from this rect's center to another point or rect's center

  Parameters

  • other: HSRect | HSPoint

    An HSPoint, or an HSRect (whose center will be used)

  Returns number

  A number containing the angle in radians, or 0 if other is not an HSPoint or HSRect

distance

• distance(other: HSRect | HSPoint): number

  Finds the distance between this rect's center and another point or rect's center

  Parameters

  • other: HSRect | HSPoint

    An HSPoint, or an HSRect (whose center will be used)

  Returns number

  A number containing the distance, or 0 if other is not an HSPoint or HSRect

equals

• equals(other: HSRect): boolean

  Checks if this rect is equal to another rect

  Parameters

  • other: HSRect

    An HSRect to compare against

  Returns boolean

  true if both rects have the same origin and size, otherwise false

fit

• fit(bounds: HSRect): HSRect

  Ensures this rect is fully inside bounds, scaling it down (preserving aspect ratio) if it's larger, and moving it if necessary

  Parameters

  • bounds: HSRect

    An HSRect describing the bounds to fit within

  Returns HSRect

  A new HSRect that fits fully inside bounds

floor

• floor(): HSRect

  Truncates the origin and size of this rect towards negative infinity

  Returns HSRect

  A new HSRect with the x, y, w and h values floored to the nearest integer

fromUnitRect

• fromUnitRect(frame: HSRect): HSRect

  Converts a unit rect (coordinates and dimensions between 0 and 1) within a given frame into absolute coordinates

  Parameters

  • frame: HSRect

    An HSRect describing the frame this unit rect is relative to

  Returns HSRect

  A new HSRect with coordinates and dimensions converted from the 0-1 range into absolute values within frame

inside

• inside(rect: HSRect): boolean

  Checks if this rect lies fully inside another rect

  Parameters

  • rect: HSRect

    An HSRect to check against

  Returns boolean

  true if this rect lies fully within the bounds of rect, otherwise false

intersect

• intersect(rect: HSRect): HSRect

  Returns the intersection of this rect and another rect

  Parameters

  • rect: HSRect

    An HSRect to intersect with

  Returns HSRect

  A new HSRect describing the overlapping area, or a zero-sized HSRect if they don't overlap

move

• move(offset: HSSize | HSPoint): HSRect

  Moves this rect by an offset

  Parameters

  • offset: HSSize | HSPoint

    An HSPoint (using its x/y), or an HSSize (using its w/h)

  Returns HSRect

  A new HSRect moved by the given offset, or an unchanged copy of this rect if offset is not an HSPoint or HSSize

scale

• scale(factor: number | HSSize | HSPoint): HSRect

  Scales the size of this rect, keeping its center constant

  Parameters

  • factor: number | HSSize | HSPoint

    A number to scale both dimensions uniformly, or an HSSize/HSPoint to scale the width and height independently

  Returns HSRect

  A new HSRect scaled by the given factor, or an unchanged copy of this rect if factor is not a positive number, HSSize or HSPoint

toUnitRect

• toUnitRect(frame: HSRect): HSRect

  Converts this rect into a unit rect (coordinates and dimensions between 0 and 1) within a given frame

  Parameters

  • frame: HSRect

    An HSRect describing the frame this rect is relative to

  Returns HSRect

  A new HSRect with coordinates and dimensions normalized to the 0-1 range within frame

union

• union(rect: HSRect): HSRect

  Returns the smallest rect that encloses both this rect and another rect

  Parameters

  • rect: HSRect

    An HSRect to union with

  Returns HSRect

  A new HSRect that fully encloses both rects

vector

• vector(other: HSRect | HSPoint): HSPoint

  Returns the vector from this rect's center to another point or rect's center

  Parameters

  • other: HSRect | HSPoint

    An HSPoint, or an HSRect (whose center will be used)

  Returns HSPoint

  A new HSPoint representing the vector, or new HSPoint(0, 0) if other is not an HSPoint or HSRect