Class Bounds

constructor

• new Bounds(vertices?): Bounds

• Parameters

  • Optionalvertices: Vector2d[] | Point[]

    an array of Vector2d or Point

  Returns Bounds

_center

max

min

type

"Bounds"
Copy

bottom

• get bottom(): number

• bottom coordinate of the bound

  Returns number

center

• get center(): Vector2d

• return the center position of the bound

  Returns Vector2d

centerX

• get centerX(): number

• center position of the bound on the x axis

  Returns number

centerY

• get centerY(): number

• center position of the bound on the y axis

  Returns number

height

• get height(): number

• width of the bounds

  Returns number
• set height(value): void

• Parameters

  • value: number

  Returns void

left

• get left(): number

• left coordinate of the bound

  Returns number

right

• get right(): number

• right coordinate of the bound

  Returns number

top

• get top(): number

• top coordinate of the bound

  Returns number

width

• get width(): number

• width of the bounds

  Returns number
• set width(value): void

• Parameters

  • value: number

  Returns void

x

• get x(): number

• x position of the bound

  Returns number
• set x(value): void

• Parameters

  • value: number

  Returns void

y

• get y(): number

• y position of the bounds

  Returns number
• set y(value): void

• Parameters

  • value: number

  Returns void

add

• add(vertices, clear?): void

• add the given vertices to the bounds definition.

  Parameters

  • vertices: Vector2d[] | Point[]

    an array of Vector2d or Point
  • Optionalclear: boolean = false

    either to reset the bounds before adding the new vertices

  Returns void

addBounds

• addBounds(bounds, clear?): void

• add the given bounds to the bounds definition.

  Parameters

  • bounds: Bounds
  • Optionalclear: boolean = false

    either to reset the bounds before adding the new vertices

  Returns void

addFrame

• addFrame(x0, y0, x1, y1, m?): void

• add the given quad coordinates to this bound definition, multiplied by the given matrix

  Parameters

  • x0: number

    left X coordinates of the quad
  • y0: number

    top Y coordinates of the quad
  • x1: number

    right X coordinates of the quad
  • y1: number

    bottom y coordinates of the quad
  • Optionalm: any

    an optional transform to apply to the given frame coordinates

  Returns void

addPoint

• addPoint(point, m?): void

• add the given point to the bounds definition.

  Parameters

  • point: Vector2d | Point

    the vector or point to be added to the bounds
  • Optionalm: any

    an optional transform to apply to the given point (if the given point is a Vector2d)

  Returns void

centerOn

• centerOn(x, y): Bounds

• center the bounds position around the given coordinates

  Parameters

  • x: number

    the x coordinate around which to center this bounds
  • y: number

    the y coordinate around which to center this bounds

  Returns Bounds

clear

• clear(): void

• reset the bound

  Returns void

clone

• clone(): Bounds

• clone this bounds

  Returns Bounds

contains

• contains(...args): boolean

• Returns true if the bounds contains the given point.

  Parameters

  • Rest...args: any

  Returns boolean

  True if the bounds contain the point, otherwise false

  Example

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

isFinite

• isFinite(): boolean

• determines whether all coordinates of this bounds are finite numbers.

  Returns boolean

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

overlaps

• overlaps(bounds): boolean

• Returns true if the two bounds intersect.

  Parameters

  • bounds: Rect | Bounds

  Returns boolean

  True if the bounds overlap, otherwise false

setMinMax

• setMinMax(minX, minY, maxX, maxY): void

• sets the bounds to the given min and max value

  Parameters

  • minX: number
  • minY: number
  • maxX: number
  • maxY: number

  Returns void

shift

• shift(...args): void

• Shifts the bounds to the given x, y position.

  Parameters

  • Rest...args: any

  Returns void

  Example

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

toPolygon

• toPolygon(): Polygon

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

  Returns Polygon

  a new Polygon that represents this bounds.

translate

• translate(...args): void

• Translates the bounds by the given point

  Parameters

  • Rest...args: any

  Returns void

  Example

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

update

• update(vertices): void

• Updates bounds using the given vertices

  Parameters

  • vertices: Vector2d[] | Point[]

    an array of Vector2d or Point

  Returns void