Class Rect

constructor

• new Rect(x?: r1.Interval, y?: r1.Interval): r2.Rect

  Returns a new Rect.

  Parameters

  • x: r1.Interval = ...
  • y: r1.Interval = ...

  Returns r2.Rect

Staticempty

• empty(): r2.Rect

  Constructs the canonical empty rectangle. Use isEmpty() to test for empty rectangles, since they have more than one representation. new Interval(0, 0) is not the same as the empty Rect.

  Returns r2.Rect

StaticfromCenterSize

• fromCenterSize(center: r2.Point, size: r2.Point): r2.Rect

  Constructs a rectangle with the given center and size. Both dimensions of size must be non-negative.

  Parameters

  • center: r2.Point
  • size: r2.Point

  Returns r2.Rect

StaticfromPoints

• fromPoints(...pts: r2.Point[]): r2.Rect

  Constructs a Rect that contains the given points.

  Parameters

  • ...pts: r2.Point[]

  Returns r2.Rect

StaticfromRect

• fromRect(or: r2.Rect): r2.Rect

  Constructs a rectangle from another rectangle (ie. make a copy)

  Parameters

  • or: r2.Rect

  Returns r2.Rect

x

y

addPoint

• addPoint(p: r2.Point): r2.Rect

  Expands the rectangle to include the given point. The rectangle is expanded by the minimum amount possible.

  Parameters

  • p: r2.Point

  Returns r2.Rect

addRect

• addRect(or: r2.Rect): r2.Rect

  Expands the rectangle to include the given rectangle. This is the same as replacing the rectangle by the union of the two rectangles, but is more efficient.

  Parameters

  • or: r2.Rect

  Returns r2.Rect

approxEqual

• approxEqual(or: r2.Rect): boolean

  Returns true if the x- and y-intervals of the two rectangles are the same up to the given tolerance.

  Parameters

  • or: r2.Rect

  Returns boolean

center

• center(): r2.Point

  Returns the center of the rectangle in (x,y)-space.

  Returns r2.Point

clampPoint

• clampPoint(p: r2.Point): r2.Point

  Returns the closest point in the rectangle to the given point. The rectangle must be non-empty.

  Parameters

  • p: r2.Point

  Returns r2.Point

contains

• contains(or: r2.Rect): boolean

  Reports whether the rectangle contains the given rectangle.

  Parameters

  • or: r2.Rect

  Returns boolean

containsPoint

• containsPoint(p: r2.Point): boolean

  Reports whether the rectangle contains the given point. Rectangles are closed regions, i.e. they contain their boundary.

  Parameters

  • p: r2.Point

  Returns boolean

expanded

• expanded(margin: r2.Point): r2.Rect

  Returns a rectangle that has been expanded in the x-direction by margin.X, and in y-direction by margin.Y. If either margin is empty, then shrink the interval on the corresponding sides instead. The resulting rectangle may be empty. Any expansion of an empty rectangle remains empty.

  Parameters

  • margin: r2.Point

  Returns r2.Rect

expandedByMargin

• expandedByMargin(margin: number): r2.Rect

  Returns a Rect that has been expanded by the amount on all sides.

  Parameters

  • margin: number

  Returns r2.Rect

hi

• hi(): r2.Point

  Returns the high corner of the rect.

  Returns r2.Point

interiorContains

• interiorContains(or: r2.Rect): boolean

  Reports whether the interior of this rectangle contains all of the points of the given or: Rectangle (including its boundary).

  Parameters

  • or: r2.Rect

  Returns boolean

interiorContainsPoint

• interiorContainsPoint(p: r2.Point): boolean

  Returns true iff the given point is contained in the interior of the region (i.e. the region excluding its boundary).

  Parameters

  • p: r2.Point

  Returns boolean

interiorIntersects

• interiorIntersects(or: r2.Rect): boolean

  Reports whether the interior of this rectangle intersects any point (including the boundary) of the given or: Rectangle.

  Parameters

  • or: r2.Rect

  Returns boolean

intersection

• intersection(or: r2.Rect): r2.Rect

  Returns the smallest rectangle containing the intersection of this rectangle and the given rectangle.

  Parameters

  • or: r2.Rect

  Returns r2.Rect

intersects

• intersects(or: r2.Rect): boolean

  Reports whether this rectangle and the or: Rectangle have any points in common.

  Parameters

  • or: r2.Rect

  Returns boolean

isEmpty

• isEmpty(): boolean

  Reports whether the rectangle is empty.

  Returns boolean

isValid

• isValid(): boolean

  Reports whether the rectangle is valid. This requires the width to be empty iff the height is empty.

  Returns boolean

lo

• lo(): r2.Point

  Returns the low corner of the rect.

  Returns r2.Point

size

• size(): r2.Point

  Returns the width and height of this rectangle in (x,y)-space. Empty rectangles have a negative width and height.

  Returns r2.Point

string

• string(): string

  Generates a human readable string.

  Returns string

union

• union(or: r2.Rect): r2.Rect

  Returns the smallest rectangle containing the union of this rectangle and the given rectangle.

  Parameters

  • or: r2.Rect

  Returns r2.Rect

vertexIJ

• vertexIJ(i: number, j: number): r2.Point

  VertexIJ returns the vertex in direction i along the X-axis (0=left, 1=right) and direction j along the Y-axis (0=down, 1=up).

  Parameters

  • i: number
  • j: number

  Returns r2.Point

vertices

• vertices(): r2.Point[]

  Vertices returns all four vertices of the rectangle. Vertices are returned in CCW direction starting with the lower left corner.

  Returns r2.Point[]