Skip to main content

BoundingBox

Axis Aligned collision primitive for Excalibur.

Index

Constructors

constructor

Properties

bottom
left
right
top

Accessors

bottomLeft
bottomRight
center
dimensions
height
topLeft
topRight
width

Constructors

constructor

new BoundingBox(leftOrOptions?: number | BoundingBoxOptions, top?: number, right?: number, bottom?: number): BoundingBox

Constructor allows passing of either an object with all coordinate components, or the coordinate components passed separately.
Parameters
- leftOrOptions: number | BoundingBoxOptions = 0
  Either x coordinate of the left edge or an options object containing the four coordinate components.
- top: number = 0
  y coordinate of the top edge
- right: number = 0
  x coordinate of the right edge
- bottom: number = 0
  y coordinate of the bottom edge
Returns BoundingBox

Properties

publicbottom

bottom: number

publicleft

left: number

publicright

right: number

publictop

top: number

Accessors

publicbottomLeft

get bottomLeft(): Vector

Returns Vector

publicbottomRight

get bottomRight(): Vector

Returns Vector

publiccenter

get center(): Vector

Returns the center of the bounding box
Returns Vector

publicdimensions

get dimensions(): Vector

Returns Vector

publicheight

get height(): number

Returns the calculated height of the bounding box
Returns number

publictopLeft

get topLeft(): Vector

Returns Vector

publictopRight

get topRight(): Vector

Returns Vector

publicwidth

get width(): number

Returns the calculated width of the bounding box
Returns number

Methods

publicclone

clone(dest?: BoundingBox): BoundingBox

Returns a new instance of BoundingBox that is a copy of the current instance
Parameters
- optionaldest: BoundingBox
Returns BoundingBox

publiccombine

combine(other: BoundingBox, dest?: BoundingBox): BoundingBox

Combines this bounding box and another together returning a new bounding box
Parameters
- other: BoundingBox
  The bounding box to combine
- optionaldest: BoundingBox
Returns BoundingBox

publiccontains

contains(p: Vector): boolean
contains(bb: BoundingBox): boolean

Tests whether a point is contained within the bounding box
Parameters
- p: Vector
  The point to test
Returns boolean

publicdraw

draw(ex: ExcaliburGraphicsContext, color?: Color): void

Draw a debug bounding box
Parameters
- ex: ExcaliburGraphicsContext
- color: Color = Color.Yellow
Returns void

publicgetPerimeter

getPerimeter(): number

Returns the perimeter of the bounding box
Returns number

publicgetPoints

getPoints(): Vector[]

Returns the world space points that make up the corners of the bounding box as a polygon
Returns Vector[]

publichasZeroDimensions

hasZeroDimensions(): boolean

Return whether the bounding box has zero dimensions in height,width or both
Returns boolean

publicintersect

intersect(other: BoundingBox): Vector

Test wether this bounding box intersects with another returning the intersection vector that can be used to resolve the collision. If there is no intersection null is returned.
Parameters
- other: BoundingBox
  Other BoundingBox to test intersection with
Returns Vector
A Vector in the direction of the current BoundingBox, this <- other

publicintersectWithSide

intersectWithSide(bb: BoundingBox): Side

Test whether the bounding box has intersected with another bounding box, returns the side of the current bb that intersected.
Parameters
- bb: BoundingBox
  The other actor to test
Returns Side

publicoverlaps

overlaps(other: BoundingBox, epsilon?: number): boolean

Returns true if the bounding boxes overlap.
Parameters
- other: BoundingBox
- optionalepsilon: number
  Optionally specify a small epsilon (default 0) as amount of overlap to ignore as overlap. This epsilon is useful in stable collision simulations.
Returns boolean

publicrayCast

rayCast(ray: Ray, farClipDistance?: number): boolean

Determines whether a ray intersects with a bounding box
Parameters
- ray: Ray
- farClipDistance: number = Infinity
Returns boolean

publicrayCastTime

rayCastTime(ray: Ray, farClipDistance?: number): number

Parameters
- ray: Ray
- farClipDistance: number = Infinity
Returns number

publicreset

reset(): void

Resets the bounds to a zero width/height box
Returns void

publicrotate

rotate(angle: number, point?: Vector): BoundingBox

Rotates a bounding box by and angle and around a point, if no point is specified (0, 0) is used by default. The resulting bounding box is also axis-align. This is useful when a new axis-aligned bounding box is needed for rotated geometry.
Parameters
- angle: number
- point: Vector = Vector.Zero
Returns BoundingBox

publicscale

scale(scale: Vector, point?: Vector): BoundingBox

Scale a bounding box by a scale factor, optionally provide a point
Parameters
- scale: Vector
- point: Vector = Vector.Zero
Returns BoundingBox

publictransform

transform(matrix: AffineMatrix): BoundingBox

Transform the axis aligned bounding box by a Matrix, producing a new axis aligned bounding box
Parameters
- matrix: AffineMatrix
Returns BoundingBox

publictranslate

translate(pos: Vector): BoundingBox

Parameters
- pos: Vector
Returns BoundingBox

publicstaticfromDimension

fromDimension(width: number, height: number, anchor?: Vector, pos?: Vector): BoundingBox

Creates a bounding box from a width and height
Parameters
- width: number
- height: number
- anchor: Vector = Vector.Half
  Default Vector.Half
- pos: Vector = Vector.Zero
  Default Vector.Zero
Returns BoundingBox

publicstaticfromPoints

fromPoints(points: Vector[]): BoundingBox

Parameters
- points: Vector[]
Returns BoundingBox

publicstaticgetSideFromIntersection

getSideFromIntersection(intersection: Vector): Side

Given bounding box A & B, returns the side relative to A when intersection is performed.
Parameters
- intersection: Vector
  Intersection vector between 2 bounding boxes
Returns Side