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.

Index

Constructors

constructor

new Rect2(x?: number, y?: number, width?: number, height?: number): Rect2
Parameters
- Optionalx: number
- Optionaly: number
- Optionalwidth: number
- Optionalheight: number
Returns Rect2

Inherited from Rect2Generated.constructor

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

Inherited from Rect2Generated.height
set height(value: number): void
Parameters
- value: number
Returns void

Inherited from Rect2Generated.height

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

Inherited from Rect2Generated.width
set width(value: number): void
Parameters
- value: number
Returns void

Inherited from Rect2Generated.width

x

get x(): number

Returns number

Inherited from Rect2Generated.x
set x(value: number): void
Parameters
- value: number
Returns void

Inherited from Rect2Generated.x

y

get y(): number

Returns number

Inherited from Rect2Generated.y
set y(value: number): void
Parameters
- value: number
Returns void

Inherited from Rect2Generated.y

Methods

assign

assign(other: Immutable<Rect2>): Rect2
Copies all properties defined by the prototype of Rect2 from other to this instance.
Parameters
- other: Immutable<Rect2>
Returns Rect2

Inherited from Rect2Generated.assign

clipPoint

clipPoint(point: Vector2): void
Clips the point to the rectangle.
Parameters
- point: Vector2
  The point to clip.
Returns void

clone

clone(): Rect2

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

Returns Rect2

Inherited from Rect2Generated.clone

contains

contains(point: Immutable<Vector2>): boolean
Returns true if the rectangle contains the provided point.
Parameters
- point: Immutable<Vector2>
Returns boolean

doClip

doClip(rhs: Immutable<Rect2>): 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
- rhs: Immutable<Rect2>
  Rectangle to clip against.
Returns Rect2

doEncapsulate

doEncapsulate(rhs: Immutable<Rect2>): Rect2
Extends this rectangle so that the provided rectangle is completely contained within it.
Parameters
- rhs: Immutable<Rect2>
Returns Rect2

doInset

doInset(inset: number): 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: number): Rect2
Insets this rectangle by the given amount.
Parameters
- outset: number
Returns Rect2
This rectangle modified by the given inset.

doRoundToMultiple

doRoundToMultiple(multiple: number): 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: Immutable<Rect2>): Rect2
Returns a copy of this rectangle extended by the provided rectangle, so that the given rectangle is completely contained within this.
Parameters
- rhs: Immutable<Rect2>
  The rectangle to encapsulate this with.
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: number): 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: Immutable<Vector2>, end: Immutable<Vector2>): Vector2
Performs a segment/rectangle intersection using the Liang-Barsky line clipping algorithm.
Parameters
- start: Immutable<Vector2>
  The start position of the line segment.
- end: Immutable<Vector2>
  The end position of the line segment.
Returns Vector2
Returns the intersection point or null if no intersection was found.

isAlmostEqual

isAlmostEqual(rhs: Immutable<Rect2>, epsilon?: number): 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: Immutable<Rect2>): boolean
Determines if both rectangles are element-wise equal.
Parameters
- rhs: Immutable<Rect2>
Returns boolean

Overrides Rect2Generated.isEqual

outset

outset(outset: number): 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: Immutable<Rect2>): 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
- rhs: Immutable<Rect2>
  The rectangle to check for overlapping.
Returns boolean

roundedToMultiple

roundedToMultiple(multiple: number): 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?: number, y?: number, width?: number, height?: number): void
Assigns the values to the rectangle.
Parameters
- Optionalx: number
- Optionaly: number
- Optionalwidth: number
- Optionalheight: number
Returns void

toCenter

toCenter(): Vector2

Returns a new Vector2 that represents center position of the Rect.

Returns Vector2

toPosition

toPosition(): Vector2

Returns a new Vector2 that represents the x and y position.

Returns Vector2

toSize

toSize(): Size2

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

Returns Size2

toSizeVector

toSizeVector(): Vector2

Returns a new Vector2 that represents the size of the Rect.

Returns Vector2

toString

toString(): string

Returns a string representation of an object.

Returns string

`Static`isAlmostEqual

isAlmostEqual(
    lhs: Immutable<Rect2>,
    rhs: Immutable<Rect2>,
    epsilon?: number,
): 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.

`Static`isEqual

isEqual(lhs: Immutable<Rect2>, rhs: Immutable<Rect2>): boolean
Determines if both rectangles are element-wise equal.
Parameters
- lhs: Immutable<Rect2>
- rhs: Immutable<Rect2>
Returns boolean

Overrides Rect2Generated.isEqual

`Static`withVectors

withVectors(position: Immutable<Vector2>, size: Immutable<Vector2>): Rect2
Creates a new rectangle from the given position and size.
Parameters
- position: Immutable<Vector2>
  The origin position of the rectangle.
- size: Immutable<Vector2>
  The size of the rectangle.
Returns Rect2

Class Rect2

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect2

Properties

Protected_height

Protected_width

Protected_x

Protected_y

Accessors

bottom

Returns number

height

Returns number

Parameters

Returns void

left

Returns number

right

Returns number

top

Returns number

width

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

assign

Parameters

Returns Rect2

clipPoint

Parameters

Returns void

clone

Returns Rect2

contains

Parameters

Returns boolean

doClip

Parameters

Returns Rect2

doEncapsulate

Parameters

Returns Rect2

doInset

Parameters

Returns Rect2

doOutset

Parameters

Returns Rect2

doRoundToMultiple

Parameters

Returns Rect2

Note

encapsulated

Parameters

Returns Rect2

getArea

Returns number

getSignedArea

Returns number

inset

Parameters

Returns Rect2

intersectLine

Parameters

`Protected`_height

`Protected`_width

`Protected`_x

`Protected`_y

`Static`isAlmostEqual

`Static`isEqual

`Static`withVectors