Class Bounds

constructor

• new Bounds(vertices?: Vector2d[] | Point[] | XYPoint[]): Bounds

  Constructs a Bounds object with optional vertices.

  Parameters

  • Optionalvertices: Vector2d[] | Point[] | XYPoint[]

    An array of Vector2d or Point to initialize the bounds.

  Returns Bounds

_center

max

min

type

bottom

• get bottom(): number

  Gets the bottom coordinate of the bounds.

  Returns number

  The bottom coordinate.

center

• get center(): Vector2d

  Gets the center position of the bounds.

  Returns Vector2d

  The center position as a Vector2d.

centerX

• get centerX(): number

  Gets the center position of the bounds on the x axis.

  Returns number

  The center x coordinate.

centerY

• get centerY(): number

  Gets the center position of the bounds on the y axis.

  Returns number

  The center y coordinate.

height

• get height(): number

  Gets the height of the bounds.

  Returns number

  The height.

• set height(value: number): void

  Sets the height of the bounds.

  Parameters

  • value: number

    The new height.

  Returns void

left

• get left(): number

  Gets the left coordinate of the bounds.

  Returns number

  The left coordinate.

right

• get right(): number

  Gets the right coordinate of the bounds.

  Returns number

  The right coordinate.

top

• get top(): number

  Gets the top coordinate of the bounds.

  Returns number

  The top coordinate.

width

• get width(): number

  Gets the width of the bounds.

  Returns number

  The width.

• set width(value: number): void

  Sets the width of the bounds.

  Parameters

  • value: number

    The new width.

  Returns void

x

• get x(): number

  Gets the x position of the bounds.

  Returns number

  The x position.

• set x(value: number): void

  Sets the x position of the bounds.

  Parameters

  • value: number

    The new x position.

  Returns void

y

• get y(): number

  Gets the y position of the bounds.

  Returns number

  The y position.

• set y(value: number): void

  Sets the y position of the bounds.

  Parameters

  • value: number

    The new y position.

  Returns void

add

• add(vertices: Vector2d[] | Point[] | XYPoint[], clear?: boolean): void

  Adds the given vertices to the bounds definition.

  Parameters

  • vertices: Vector2d[] | Point[] | XYPoint[]

    An array of Vector2d or Point to add to the bounds.

  • Optionalclear: boolean = false

    Whether to reset the bounds before adding the new vertices. Defaults to false.

  Returns void

addBounds

• addBounds(bounds: Bounds, clear?: boolean): void

  Adds the given bounds to the bounds definition.

  Parameters

  • bounds: Bounds

    The bounds to add.

  • Optionalclear: boolean = false

    Whether to reset the bounds before adding the new bounds.

  Returns void

addFrame

• addFrame(
      x0: number,
      y0: number,
      x1: number,
      y1: number,
      m?: Matrix3d | Matrix2d,
  ): void

  Expands this bounds to include the axis-aligned bounding box of the given rect's four corners, optionally transformed through m first. With a non-identity m (rotation, scale, etc.) the result is the AABB of the transformed quad, not a transformed AABB.

  Parameters

  • x0: number

    The left x coordinate of the quad.

  • y0: number

    The top y coordinate of the quad.

  • x1: number

    The right x coordinate of the quad.

  • y1: number

    The bottom y coordinate of the quad.

  • Optionalm: Matrix3d | Matrix2d

    An optional transform applied to each corner before inclusion.

  Returns void

addPoint

• addPoint(point: Vector2d | Point, m?: Matrix3d | Matrix2d): void

  Adds the given point to the bounds definition.

  Parameters

  • point: Vector2d | Point

    The point to add to the bounds.

  • Optionalm: Matrix3d | Matrix2d

    An optional transform to apply to the given point.

  Returns void

addShapes

• addShapes(
      shapes:
          | { getBounds?: () => Bounds }
          | Iterable<{ getBounds?: () => Bounds }, any, any>,
      clear?: boolean,
  ): void

  Expand this bounds to include every shape in shapes. Each shape contributes its own .getBounds() (so Rect, Polygon, Ellipse, Bounds, and anything else implementing the same getter all work); shapes without .getBounds() are silently ignored. Use clear=true to compute a fresh union (matches the add / addBounds shape).

  Useful for sizing a renderable from its bodyDef.shapes before the underlying physics body has been constructed — used by the TMX shape factory and Trigger.

  Parameters

  • shapes: { getBounds?: () => Bounds } | Iterable<{ getBounds?: () => Bounds }, any, any>

    one shape or an iterable of shapes

  • Optionalclear: boolean = false

    reset the bounds before unioning

  Returns void

centerOn

• centerOn(x: number, y: number): Bounds

  Centers the bounds position around the given coordinates.

  Parameters

  • x: number

    The x coordinate to center around.

  • y: number

    The y coordinate to center around.

  Returns Bounds

  The current Bounds instance for method chaining.

clear

• clear(): void

  Resets the bounds to its initial state.

  Returns void

clone

• clone(): Bounds

  Creates a clone of this bounds.

  Returns Bounds

  A new Bounds object that is a copy of this bounds.

contains

• contains(x: number, y?: number): boolean

  Returns true if the bounds contain the given point or vector.

  Parameters

  • x: number
  • Optionaly: number

    The y coordinate if the first parameter is a number.

  Returns boolean

  True if the bounds contain the point or vector, otherwise false.

• contains(vector: Vector2d | Bounds): boolean

  Returns true if the bounds contain the given point or vector.

  Parameters

  • vector: Vector2d | Bounds

  Returns boolean

  True if the bounds contain the point or vector, otherwise false.

isFinite

• isFinite(): boolean

  Determines whether all coordinates of this bounds are finite numbers.

  Returns boolean

  False if any coordinates are positive or negative Infinity or NaN; otherwise, true.

overlaps

• overlaps(bounds: Bounds): boolean

  Returns true if the two bounds intersect.

  Parameters

  • bounds: Bounds

    The bounds to check for intersection.

  Returns boolean

  True if the bounds overlap, otherwise false.

setMinMax

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

  Sets the bounds to the given minimum and maximum values.

  Parameters

  • minX: number

    The minimum x value.

  • minY: number

    The minimum y value.

  • maxX: number

    The maximum x value.

  • maxY: number

    The maximum y value.

  Returns void

shift

• shift(x: number, y?: number): void

  Shifts the bounds to the given x, y position or vector.

  Parameters

  • x: number
  • Optionaly: number

    The y coordinate if the first parameter is a number.

  Returns void

• shift(vector: Vector2d): void

  Shifts the bounds to the given x, y position or vector.

  Parameters

  • vector: Vector2d

  Returns void

translate

• translate(x: number, y?: number): void

  Translates the bounds by the given point or vector.

  Parameters

  • x: number
  • Optionaly: number

    The y coordinate if the first parameter is a number.

  Returns void

• translate(vector: Vector2d): void

  Translates the bounds by the given point or vector.

  Parameters

  • vector: Vector2d

  Returns void

update

• update(vertices: Vector2d[] | Point[] | XYPoint[]): void

  Updates the bounds using the given vertices.

  Parameters

  • vertices: Vector2d[] | Point[] | XYPoint[]

    An array of Vector2d or Point to update the bounds.

  Returns void