Class Rect2

Represents a rectangle in 2D space, parallel to the XY axes.

Example:

import { Rect2, Vec2 } from '@js-draw/math';

const rect = Rect2.fromCorners(
  Vec2.of(0, 0),
  Vec2.of(10, 10),
);
console.log('area', rect.area);
console.log('topLeft', rect.topLeft);

invariant: w ≥ 0, h ≥ 0, immutable

Hierarchy (View Summary)

Abstract2DShape
- Rect2

Constructors

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
Overrides Abstract2DShape.constructor
- Defined in math/src/shapes/Rect2.ts:42

Properties

`Readonly`area

area: number

`Readonly`h

h: number

Height

`Readonly`size

size: Vec3

`Readonly`topLeft

topLeft: Vec3

Derived state: topLeft assumes up is -y

`Readonly`w

w: number

Width

`Readonly`x

x: number

Top left x coordinate

`Readonly`y

y: number

Top left y coordinate

`Static`empty

empty: Rect2 = ...

`Static`unitSquare

unitSquare: Rect2 = ...

Accessors

bottomLeft

get bottomLeft(): Vec3
Returns Vec3
- Defined in math/src/shapes/Rect2.ts:279

bottomRight

get bottomRight(): Vec3
Returns Vec3
- Defined in math/src/shapes/Rect2.ts:271

center

get center(): Vec2Impl
Returns Vec2Impl
- Defined in math/src/shapes/Rect2.ts:291

corners

get corners(): Vec3[]
Returns Vec3[]
- Defined in math/src/shapes/Rect2.ts:259

height

get height(): number
Returns number
- Defined in math/src/shapes/Rect2.ts:287

maxDimension

get maxDimension(): number
Returns number
- Defined in math/src/shapes/Rect2.ts:263

minDimension

get minDimension(): number
Returns number
- Defined in math/src/shapes/Rect2.ts:267

topRight

get topRight(): Vec3
Returns Vec3
- Defined in math/src/shapes/Rect2.ts:275

width

get width(): number
Returns number
- Defined in math/src/shapes/Rect2.ts:283

Methods

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
Overrides Abstract2DShape.containsPoint
- Defined in math/src/shapes/Rect2.ts:79

containsRect

containsRect(other: Rect2): boolean
Parameters
- other: Rect2
Returns boolean
true iff other is completely within this Rect2.
- Defined in math/src/shapes/Rect2.ts:89

distance

distance(point: Vec3): number
Parameters
- point: Vec3
Returns number
the distance from point to this shape. If point is within this shape, this returns the distance from point to the edge of this shape.

See
signedDistance
Inherited from Abstract2DShape.distance
- Defined in math/src/shapes/Abstract2DShape.ts:18

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[]
- Defined in math/src/shapes/Rect2.ts:147

eq

eq(other: Rect2, tolerance?: number): boolean
Parameters
- other: Rect2
- tolerance: number = 0
Returns boolean
true iff this is equal to other ± tolerance
- Defined in math/src/shapes/Rect2.ts:344

getClosestPointOnBoundaryTo

getClosestPointOnBoundaryTo(target: Vec3): Vec3
Parameters
- target: Vec3
Returns Vec3
- Defined in math/src/shapes/Rect2.ts:225

getEdges

getEdges(): LineSegment2[]
Returns edges in the order [ rightEdge, topEdge, leftEdge, bottomEdge ]

Returns LineSegment2[]
- Defined in math/src/shapes/Rect2.ts:297

getLooseBoundingBox

getLooseBoundingBox(): Rect2
Returns a bounding box that loosely fits the content of this shape.

The result of this call can be larger than the result of getTightBoundingBox, but should not be smaller. Thus, a call to getLooseBoundingBox can be significantly faster than a call to getTightBoundingBox for some shapes.

Returns Rect2
Inherited from Abstract2DShape.getLooseBoundingBox
- Defined in math/src/shapes/Abstract2DShape.ts:65

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
Overrides Abstract2DShape.getTightBoundingBox
- Defined in math/src/shapes/Rect2.ts:328

grownBy

grownBy(margin: number): Rect2
Returns this grown by [margin] in both the x and y directions.
Parameters
- margin: number
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:182

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
- Defined in math/src/shapes/Rect2.ts:176

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
- Defined in math/src/shapes/Rect2.ts:209

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
- Defined in math/src/shapes/Rect2.ts:126

intersects

intersects(other: Rect2): boolean
Parameters
- other: Rect2
Returns boolean
true iff this and other overlap
- Defined in math/src/shapes/Rect2.ts:101

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.
Overrides Abstract2DShape.intersectsLineSegment
- Defined in math/src/shapes/Rect2.ts:307

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
- Defined in math/src/shapes/Rect2.ts:250

resizedTo

resizedTo(size: Vec3): Rect2
Returns a copy of this with the given size (but same top-left).
Parameters
- size: Vec3
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:75

signedDistance

signedDistance(point: Vec3): number
Computes the signed distance function for this shape.
Parameters
- point: Vec3
Returns number
Overrides Abstract2DShape.signedDistance
- Defined in math/src/shapes/Rect2.ts:318

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in math/src/shapes/Rect2.ts:348

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
- Defined in math/src/shapes/Rect2.ts:334

translatedBy

translatedBy(vec: Vec3): Rect2
Parameters
- vec: Vec3
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:70

union

union(other: Rect2): Rect2
Returns a new rectangle containing both [this] and [other].
Parameters
- other: Rect2
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:138

`Static`bboxOf

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
- Defined in math/src/shapes/Rect2.ts:363

`Static`fromCorners

fromCorners(corner1: Vec3, corner2: Vec3): Rect2
Parameters
- corner1: Vec3
- corner2: Vec3
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:352

`Static`of

of(template: RectTemplate): Rect2
Parameters
- template: RectTemplate
Returns Rect2
- Defined in math/src/shapes/Rect2.ts:416

`Static`union

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.
- Defined in math/src/shapes/Rect2.ts:394

Class Rect2

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect2

Properties

Readonlyarea

Readonlyh

Readonlysize

ReadonlytopLeft

Readonlyw

Readonlyx

Readonlyy

Staticempty

StaticunitSquare

Accessors

bottomLeft

Returns Vec3

bottomRight

Returns Vec3

center

Returns Vec2Impl

corners

Returns Vec3[]

height

Returns number

maxDimension

Returns number

minDimension

Returns number

topRight

Returns Vec3

width

Returns number

Methods

containsPoint

Parameters

Returns boolean

containsRect

Parameters

Returns boolean

distance

Parameters

Returns number

See

divideIntoGrid

Parameters

Returns Rect2[]

eq

Parameters

Returns boolean

getClosestPointOnBoundaryTo

Parameters

Returns Vec3

getEdges

Returns LineSegment2[]

getLooseBoundingBox

Returns Rect2

getTightBoundingBox

Returns Rect2

grownBy

Parameters

Returns Rect2

grownToPoint

Parameters

Returns Rect2

grownToSize

Parameters

Returns Rect2

intersection

Parameters

Returns null | Rect2

intersects

Parameters

`Readonly`area

`Readonly`h

`Readonly`size

`Readonly`topLeft

`Readonly`w

`Readonly`x

`Readonly`y

`Static`empty

`Static`unitSquare

`Static`bboxOf

`Static`fromCorners

`Static`of

`Static`union