Class default

The Matter.Bounds module contains methods for creating and manipulating axis-aligned bounding boxes (AABB).

Hierarchy

default

Index

Constructors

Methods

contains create overlaps shift translate update

Constructors

constructor

new default(): default
Returns default

Methods

`Static` contains

contains(bounds, point): boolean
Returns true if the bounds contains the given point.
Parameters
- bounds: IBounds
- point: IVector
Returns boolean
True if the bounds contain the point, otherwise false

Method
contains
- Defined in src/geometry/Bounds.ts:85

`Static` create

create(vertices?): IBounds
Creates a new axis-aligned bounding box (AABB) for the given vertices.
Parameters
- Optional vertices: IVector[]
Returns IBounds
A new bounds object

Method
create
- Defined in src/geometry/Bounds.ts:18

`Static` overlaps

overlaps(boundsA, boundsB): boolean
Returns true if the two bounds intersect.
Parameters
- boundsA: IBounds
- boundsB: IBounds
Returns boolean
True if the bounds overlap, otherwise false

Method
overlaps
- Defined in src/geometry/Bounds.ts:101

`Static` shift

shift(bounds, position): void
Shifts the bounds to the given position.
Parameters
- bounds: IBounds
- position: IVector
Returns void

Method
shift
- Defined in src/geometry/Bounds.ts:129

`Static` translate

translate(bounds, vector): void
Translates the bounds by the given vector.
Parameters
- bounds: IBounds
- vector: IVector
Returns void

Method
translate
- Defined in src/geometry/Bounds.ts:116

`Static` update

update(bounds, vertices, velocity?): void
Updates bounds using the given vertices and extends the bounds given a velocity.
Parameters
- bounds: IBounds
- vertices: IVector[]
- Optional velocity: IVector
Returns void

Method
update
- Defined in src/geometry/Bounds.ts:38

Generated using TypeDoc