Class Rect2

constructor

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

• Parameters

  • x: number

    Top left x coordinate
  • y: number

    Top left y coordinate
  • w: number

    Width
  • h: number

    Height

  Returns Rect2

Readonlyarea

Readonlyh

Readonlysize

ReadonlytopLeft

Readonlyw

Readonlyx

Readonlyy

Staticempty

StaticunitSquare

bottomLeft

• get bottomLeft(): Vec3

• Returns Vec3

bottomRight

• get bottomRight(): Vec3

• Returns Vec3

center

• get center(): Vec2Impl

• Returns Vec2Impl

corners

• get corners(): Vec3[]

• Returns Vec3[]

height

• get height(): number

• Returns number

maxDimension

• get maxDimension(): number

• Returns number

minDimension

• get minDimension(): number

• Returns number

topRight

• get topRight(): Vec3

• Returns Vec3

width

• get width(): number

• Returns number

containsPoint

• containsPoint(other: Vec3): boolean

• Returns true if and only if the given point is contained within this shape.

  epsilon is a small number used to counteract floating point error. Thus, if point is within epsilon of the inside of this shape, containsPoint may also return true.

  The default implementation relies on signedDistance. Subclasses may override this method to provide a more efficient implementation.

  Parameters

  • other: Vec3

  Returns boolean

containsRect

• containsRect(other: Rect2): boolean

• Parameters

  • other: Rect2

  Returns boolean

  true iff other is completely within this Rect2.

divideIntoGrid

• divideIntoGrid(columns: number, rows: number): Rect2[]

• Returns a the subdivision of this into [columns] columns and [rows] rows. For example, Rect2.unitSquare.divideIntoGrid(2, 2) -> [ Rect2(0, 0, 0.5, 0.5), Rect2(0.5, 0, 0.5, 0.5), Rect2(0, 0.5, 0.5, 0.5), Rect2(0.5, 0.5, 0.5, 0.5) ] The rectangles are ordered in row-major order.

  Parameters

  • columns: number
  • rows: number

  Returns Rect2[]

eq

• eq(other: Rect2, tolerance?: number): boolean

• Parameters

  • other: Rect2
  • tolerance: number = 0

  Returns boolean

  true iff this is equal to other ± tolerance

getClosestPointOnBoundaryTo

• getClosestPointOnBoundaryTo(target: Vec3): Vec3

• Parameters

  • target: Vec3

  Returns Vec3

getEdges

• getEdges(): LineSegment2[]

• Returns edges in the order [ rightEdge, topEdge, leftEdge, bottomEdge ]

  Returns LineSegment2[]

getTightBoundingBox

• getTightBoundingBox(): Rect2

• Returns a bounding box that precisely fits the content of this shape.

  Note: This bounding box should aligned with the x/y axes. (Thus, it may be possible to find a tighter bounding box not axes-aligned).

  Returns Rect2

grownBy

• grownBy(margin: number): Rect2

• Returns this grown by [margin] in both the x and y directions.

  Parameters

  • margin: number

  Returns Rect2

grownToPoint

• grownToPoint(point: Vec3, margin?: number): Rect2

• Returns a rectangle containing this and [point]. [margin] is the minimum distance between the new point and the edge of the resultant rectangle.

  Parameters

  • point: Vec3
  • margin: number = 0

  Returns Rect2

grownToSize

• grownToSize(minSize: Vec3): Rect2

• If this rectangle is smaller than minSize, returns a copy of this with a larger width/height.

  If smaller than minSize, padding is applied on both sides.

  Parameters

  • minSize: Vec3

  Returns Rect2

intersection

• intersection(other: Rect2): null | Rect2

• Returns the overlap of this and [other], or null, if no such overlap exists

  Parameters

  • other: Rect2

  Returns null | Rect2

intersects

• intersects(other: Rect2): boolean

• Parameters

  • other: Rect2

  Returns boolean

  true iff this and other overlap

intersectsLineSegment

• intersectsLineSegment(lineSegment: LineSegment2): Vec3[]

• Parameters

  • lineSegment: LineSegment2

  Returns Vec3[]

  points at which this shape intersects the given lineSegment.

  If this is a closed shape, returns points where the given lineSegment intersects the boundary of this.

isWithinRadiusOf

• isWithinRadiusOf(radius: number, point: Vec3): boolean

• Returns true iff all points in this rectangle are within distance from point:

  If $R$ is the set of points in this rectangle, returns true iff $$\forall {\bf a} \in R, |\texttt{point} - {\bf a}| < \texttt{radius}$$

  Parameters

  • radius: number
  • point: Vec3

  Returns boolean

resizedTo

• resizedTo(size: Vec3): Rect2

• Returns a copy of this with the given size (but same top-left).

  Parameters

  • size: Vec3

  Returns Rect2

signedDistance

• signedDistance(point: Vec3): number

• Computes the signed distance function for this shape.

  Parameters

  • point: Vec3

  Returns number

toString

• toString(): string

• Returns a string representation of an object.

  Returns string

transformedBoundingBox

• transformedBoundingBox(affineTransform: Mat33): Rect2

• [affineTransform] is a transformation matrix that both scales and translates. the bounding box of this' four corners after transformed by the given affine transformation.

  Parameters

  • affineTransform: Mat33

  Returns Rect2

translatedBy

• translatedBy(vec: Vec3): Rect2

• Parameters

  • vec: Vec3

  Returns Rect2

union

• union(other: Rect2): Rect2

• Returns a new rectangle containing both [this] and [other].

  Parameters

  • other: Rect2

  Returns Rect2

StaticbboxOf

• bboxOf(points: Vec3[], margin?: number): Rect2

• Returns a box that contains all points in [points] with at least [margin] between each point and the edge of the box.

  Parameters

  • points: Vec3[]
  • margin: number = 0

  Returns Rect2

StaticfromCorners

• fromCorners(corner1: Vec3, corner2: Vec3): Rect2

• Parameters

  • corner1: Vec3
  • corner2: Vec3

  Returns Rect2

Staticof

• of(template: RectTemplate): Rect2

• Parameters

  • template: RectTemplate

  Returns Rect2

Staticunion

• union(...rects: Rect2[]): Rect2

• Parameters

  • ...rects: Rect2[]

  Returns Rect2

  a rectangle that contains all of the given rectangles, the bounding box of the given rectangles.