Class Bounds

constructor

• new Bounds(min, max): Bounds

• The constructor.

  Parameters

  • min: XYCoords

    The min values (x,y) as a XYCoords tuple.
  • max: XYCoords

    The max values (x,y) as a XYCoords tuple.

  Returns Bounds

  Name

  Bounds

Readonly height

Readonly max

Readonly min

Readonly width

clone

• clone(): Bounds

• Clone this bounds object (create a deep clone).

  Returns Bounds

  Creates a deep clone of this bounds object.

  Method

  clone

  Instance

  Memberof

  Bounds

getCenter

• getCenter(): Vertex

• Get the center of this boinding box.

  Returns Vertex

  The center of these bounds.

  Method

  getCenter

  Instance

  Memberof

  Bounds

randomPoint

• randomPoint(horizontalSafeArea?, verticalSafeArea?): Vertex

• Generate a random point inside this bounds object. Safe areas at the border to avoid included.

  Parameters

  • horizontalSafeArea: number = 0
  • verticalSafeArea: number = 0

  Returns Vertex

  A pseudo random point inside these bounds.

  Method

  randomPoint

  Instance

  Memberof

  Bounds

toPolygon

• toPolygon(): Polygon

• Convert this rectangular bounding box to a polygon with four vertices.

  Returns Polygon

  This bound rectangle as a polygon.

  Method

  toPolygon

  Instance

  Memberof

  Bounds

toString

• toString(): string

• Convert these bounds to a human readable form.

  Note: the returned format might change in the future, so please do not rely on the returned string format.

  Returns string

  Get these bounds in a human readable form.

  Method

  toString

  Instance

  Memberof

  Bounds

Static computeFromVertices

• computeFromVertices(vertices): Bounds

• Compute the minimal bounding box for a given set of vertices.

  An empty vertex array will return an empty bounding box located at (0,0).

  Parameters

  • vertices: Vertex[]

    The set of vertices you want to get the bounding box for.

  Returns Bounds

  The minimal Bounds for the given vertices.

  Static

  Method

  computeFromVertices

  Memberof

  Bounds

Static fromDimension

• fromDimension(width, height, origin?): Bounds

• Create a new Bounds instance just from width and height, located at (0,0) or the optionally given origin.

  Parameters

  • width: number

    The width of the bounds
  • height: number

    The height of the bounds
  • Optional origin: XYCoords

    [optional] A origin to locate the new Bounds object at.

  Returns Bounds

  A new Bounds instance width given width and height, located at (0,0) or the given origin..