Class Rect

constructor

• new Rect(x, y, w, h): Rect

• Creates a new rectangle.

  Parameters

  • x: number

    The x position of the rectangle.

  • y: number

    The y position of the rectangle.

  • w: number

    The width of the rectangle.

  • h: number

    The height of the rectangle.

  Returns Rect

edges

indices

points

pos

type

bottom

• get bottom(): number

• bottom coordinate of the Rectangle

  Returns number

centerX

• get centerX(): number

• absolute center of this rectangle on the horizontal axis

  Returns number

• set centerX(value): void

• Parameters

  • value: number

  Returns void

centerY

• get centerY(): number

• absolute center of this rectangle on the vertical axis

  Returns number

• set centerY(value): void

• Parameters

  • value: number

  Returns void

height

• get height(): number

• height of the Rectangle

  Returns number

• set height(value): void

• Parameters

  • value: number

  Returns void

left

• get left(): number

• The left coordinate of the Rectangle.

  Returns number

right

• get right(): number

• right coordinate of the Rectangle

  Returns number

top

• get top(): number

• top coordinate of the Rectangle

  Returns number

width

• get width(): number

• width of the Rectangle

  Returns number

• set width(value): void

• Parameters

  • value: number

  Returns void

centerOn

• centerOn(x, y): Rect

• center the rectangle position around the given coordinates

  Parameters

  • x: number

    the x coordinate around which to center this rectangle

  • y: number

    the y coordinate around which to center this rectangle

  Returns Rect

  this rectangle

clone

• clone(): Rect

• clone this rectangle

  Returns Rect

  new rectangle

contains

• contains(x, y): boolean

• Returns true if the polygon contains the given point.
  (Note: it is highly recommended to first do a hit test on the corresponding
  bounding rect, as the function can be highly consuming with complex shapes)

  Parameters

  • x: number

    x coordinate or a vector point to check

  • y: number

    y coordinate

  Returns boolean

  True if the polygon contain the point, otherwise false

  Example

  if (polygon.contains(10, 10)) {
  // do something
  }
  // or
  if (polygon.contains(myVector2d)) {
  // do something
  }
  Copy

• contains(vector): boolean

• Returns true if the polygon contains the given point.
  (Note: it is highly recommended to first do a hit test on the corresponding
  bounding rect, as the function can be highly consuming with complex shapes)

  Parameters

  • vector: Vector2d

  Returns boolean

  True if the polygon contain the point, otherwise false

  Example

  if (polygon.contains(10, 10)) {
  // do something
  }
  // or
  if (polygon.contains(myVector2d)) {
  // do something
  }
  Copy

containsRectangle

• containsRectangle(rectangle): boolean

• Returns true if the rectangle contains the given rectangle

  Parameters

  • rectangle: Rect

    rectangle to test

  Returns boolean

  True if the rectangle contain the given rectangle, otherwise false

  Example

  if (rect.containsRectangle(myRect)) {
  // do something
  }
  Copy

copy

• copy(rect): Rect

• copy the position and size of the given rectangle into this one

  Parameters

  • rect: Rect

    Source rectangle

  Returns Rect

  new rectangle

equals

• equals(rect): boolean

• Check if this rectangle is identical to the specified one.

  Parameters

  • rect: Rect

    Other rectangle.

  Returns boolean

  true if equals

getBounds

• getBounds(): Bounds

• returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.

  Returns Bounds

  this shape bounding box Rectangle object

getIndices

• getIndices(): number[]

• returns a list of indices for all triangles defined in this polygon

  Returns number[]

  an array of vertex indices for all triangles forming this polygon.

isConvex

• isConvex(): null | boolean

• Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).

  Returns null | boolean

  true if the vertices are convex, false if not, null if not computable

isFinite

• isFinite(): boolean

• Determines whether all coordinates of this rectangle are finite numbers.

  Returns boolean

  false if all coordinates are positive or negative Infinity or NaN; otherwise, true.

overlaps

• overlaps(rect): boolean

• check if this rectangle is intersecting with the specified one

  Parameters

  • rect: Rect

    Other rectangle.

  Returns boolean

  true if overlaps

recalc

• recalc(): Rect

• Computes the calculated collision polygon. This must be called if the points array, angle, or offset is modified manually.

  Returns Rect

  Reference to this object for method chaining

resize

• resize(w, h): Rect

• resize the rectangle

  Parameters

  • w: number

    new width of the rectangle

  • h: number

    new height of the rectangle

  Returns Rect

  this rectangle

rotate

• rotate(angle, v?): Rect

• Rotate this Polygon (counter-clockwise) by the specified angle (in radians).

  Parameters

  • angle: number

    The angle to rotate (in radians)

  • Optionalv: XYPoint | Vector2d

    an optional point to rotate around

  Returns Rect

  Reference to this object for method chaining

scale

• scale(x, y?): Rect

• scale the rectangle

  Parameters

  • x: number

    a number representing the abscissa of the scaling vector.

  • Optionaly: number = x

    a number representing the ordinate of the scaling vector.

  Returns Rect

  this rectangle

scaleV

• scaleV(v): Rect

• Scales the polygon by the given vector.

  Parameters

  • v: Vector2d

    A vector containing the scaling factors for the x and y axes.

  Returns Rect

  Reference to this object for method chaining

setShape

• setShape(x, y, points): Rect

• set new value to the Polygon

  Parameters

  • x: number

    position of the Polygon

  • y: number

    position of the Polygon

  • points: PolygonVertices | LineVertices

    array of vector or vertice defining the Polygon

  Returns Rect

  this instance for objecf chaining

setSize

• setSize(width, height): Rect

• Set new dimensions for the rectangle.

  Parameters

  • width: number

    The new width of the rectangle.

  • height: number

    The new height of the rectangle.

  Returns Rect

setVertices

• setVertices(vertices): Rect

• set the vertices defining this Polygon

  Parameters

  • vertices: PolygonVertices | LineVertices

    array of vector or vertice defining the Polygon

  Returns Rect

  this instance for objecf chaining

shift

• shift(x, y?): void

• Shifts the Polygon to the given position vector.

  Parameters

  • x: number

    The x coordinate or a vector point to shift to.

  • Optionaly: number

    The y coordinate. This parameter is required if the first parameter is a number.

  Returns void

  Example

  polygon.shift(10, 10);
  // or
  polygon.shift(myVector2d);
  Copy

• shift(vector): void

• Parameters

  • vector: Vector2d

  Returns void

to2d

• to2d(): Rect

• apply a 2d projection to this shapen

  Returns Rect

  Reference to this object for method chaining

toIso

• toIso(): Rect

• apply an isometric projection to this shape

  Returns Rect

  Reference to this object for method chaining

toPolygon

• toPolygon(): Polygon

• Returns a polygon whose edges are the same as this box.

  Returns Polygon

  a new Polygon that represents this rectangle.

transform

• transform(m): Rect

• apply the given transformation matrix to this Polygon

  Parameters

  • m: Matrix2d

    the transformation matrix

  Returns Rect

  Reference to this object for method chaining

translate

• translate(x, y?): Polygon

• Translates the Polygon by the specified offset.

  Parameters

  • x: number

    The x offset or a vector point to translate by.

  • Optionaly: number

    The y offset. This parameter is required if the first parameter is a number.

  Returns Polygon

  Reference to this object for method chaining

  Example

  polygon.translate(10, 10);
  // or
  polygon.translate(myVector2d);
  Copy

• translate(vector): Polygon

• Parameters

  • vector: Vector2d

  Returns Polygon

union

• union(rect): Rect

• merge this rectangle with another one

  Parameters

  • rect: Rect

    other rectangle to union with

  Returns Rect

  the union(ed) rectangle

updateBounds

• updateBounds(): Bounds

• update the bounding box for this shape.

  Returns Bounds

  this shape bounding box Rectangle object