Class Rect2

The Rect2 implements a 2D rectangle with an origin in top left and a width and height. The class follows the 'copy-on-write' pattern, which means that every operation such as Rect2.inset or Rect2.outset returns a copy of the rect with updates values. It also implies that the values of the rect cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

Properties

_height _width _x _y

Accessors

bottom height left right top width x y

Methods

assign clipPoint clone contains doClip doEncapsulate doInset doOutset doRoundToMultiple encapsulated getArea getSignedArea inset intersectLine isAlmostEqual isEqual outset overlaps roundedToMultiple set toCenter toPosition toSize toSizeVector toString isAlmostEqual isEqual withVectors

Constructors

constructor

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

  • Parameters

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

    Returns Rect2

Properties

Protected_height

_height: number

Protected_width

_width: number

Protected_x

_x: number

Protected_y

_y: number

Accessors

bottom

  • get bottom(): number

  • Gets the Y position of the bottom edge.

    Returns number

height

  • get height(): number

  • Returns number

  • set height(value): void

  • Parameters

    • value: number

    Returns void

left

  • get left(): number

  • Gets the X position of the left edge.

    Returns number

right

  • get right(): number

  • Gets the X position of the right edge.

    Returns number

top

  • get top(): number

  • Gets the Y position of the top edge.

    Returns number

width

  • get width(): number

  • Returns number

  • set width(value): void

  • Parameters

    • value: number

    Returns void

x

  • get x(): number

  • Returns number

  • set x(value): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • Returns number

  • set y(value): void

  • Parameters

    • value: number

    Returns void

Methods

assign

  • assign(other): Rect2

  • Copies all properties defined by the prototype of Rect2 from other to this instance.

    Parameters

    Returns Rect2

clipPoint

  • clipPoint(point): void

  • Clips the point to the rectangle.

    Parameters

    Returns void

clone

  • clone(): Rect2

  • Clones this instance and returns a new Rect2 with identical values.

    Returns Rect2

contains

  • contains(point): boolean

  • Returns true if the rectangle contains the provided point.

    Parameters

    Returns boolean

doClip

  • doClip(rhs): Rect2

  • Clips current rectangle so that it does not overlap the provided rectangle. After clipping no area of this rectangle will intersect the clip area.

    Parameters

    Returns Rect2

doEncapsulate

  • doEncapsulate(rhs): Rect2

  • Extends this rectangle so that the provided rectangle is completely contained within it.

    Parameters

    Returns Rect2

doInset

  • doInset(inset): Rect2

  • Insets this rectangle by the given amount.

    Parameters

    • inset: number

      The amount to inset the rectangle by.

    Returns Rect2

    This rectangle modified by the given inset.

doOutset

  • doOutset(outset): Rect2

  • Insets this rectangle by the given amount.

    Parameters

    • outset: number

    Returns Rect2

    This rectangle modified by the given inset.

doRoundToMultiple

  • doRoundToMultiple(multiple): Rect2

  • Rounds the vector to the nearest multiple.

    Parameters

    • multiple: number

      Multiple to round to.

    Returns Rect2

    This instance.

    Note

    This is a helpful utility to quickly snap an rectangle to a specic grid size.

encapsulated

  • encapsulated(rhs): Rect2

  • Returns a copy of this rectangle extended by the provided rectangle, so that the given rectangle is completely contained within this.

    Parameters

    Returns Rect2

getArea

  • getArea(): number

  • Computes the absolute area of the rectangle.

    Returns number

getSignedArea

  • getSignedArea(): number

  • Computes the signed area of the rectangle.

    Returns number

inset

  • inset(inset): Rect2

  • Insets a rectangle by the given amount.

    Parameters

    • inset: number

      The amount to inset the rectangle by.

    Returns Rect2

    Returns a new rectangle with the insets applied.

intersectLine

  • intersectLine(start, end): Vector2

  • Performs a segment/rectangle intersection using the Liang-Barsky line clipping algorithm.

    Parameters

    Returns Vector2

    Returns the intersection point or null if no intersection was found.

isAlmostEqual

  • isAlmostEqual(rhs, epsilon?): boolean

  • Returns whether the provided rect, given a error margin, has the same rect components values as this one.

    Parameters

    • rhs: Immutable<Rect2>

      The other rect to compare with.

    • Optionalepsilon: number

      Optional. Error margin within which the numbers should be considered equal.

    Returns boolean

    True if equal, false otherwise.

isEqual

  • isEqual(rhs): boolean

  • Determines if both rectangles are element-wise equal.

    Parameters

    Returns boolean

outset

  • outset(outset): Rect2

  • Outsets a rectangle by the given amount.

    Parameters

    • outset: number

      The amount to outset the rectangle by.

    Returns Rect2

    Returns a new rectangle with the outsets applied.

overlaps

  • overlaps(rhs): boolean

  • Returns true if the rectangle overlaps the provided rectangle. Also returns true if the rectangles are contained within each other completely (no intersecting edges).

    Parameters

    Returns boolean

roundedToMultiple

  • roundedToMultiple(multiple): Rect2

  • Returns a copy of the rectangle rounded to the nearest multiple.

    Parameters

    • multiple: number

      Multiple to round to.

    Returns Rect2

    This instance.

    Note

    This is a helpful utility to quickly snap an rectangle to a specic grid size.

set

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

  • Assigns the values to the rectangle.

    Parameters

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

    Returns void

toCenter

toPosition

toSize

  • toSize(): Size2

  • Returns a new Size2 that represents the size of the Rect.

    Returns Size2

toSizeVector

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

StaticisAlmostEqual

  • isAlmostEqual(lhs, rhs, epsilon?): boolean

  • Compares two rectangles with an error margin.

    Parameters

    • lhs: Immutable<Rect2>

      First rect to compare.

    • rhs: Immutable<Rect2>

      Second rect to compare.

    • Optionalepsilon: number

      Optional. Error margin within which the numbers should be considered equal.

    Returns boolean

    True if equal, false otherwise.

StaticisEqual

  • isEqual(lhs, rhs): boolean

  • Determines if both rectangles are element-wise equal.

    Parameters

    Returns boolean

StaticwithVectors

  • withVectors(position, size): Rect2

  • Creates a new rectangle from the given position and size.

    Parameters

    Returns Rect2

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods