Class default

The Matter.Collision module contains methods for detecting collisions between a given pair of bodies.

For efficient detection between a list of bodies, see Matter.Detector and Matter.Query.

See Matter.Engine for collision events.

Hierarchy

default

Index

Constructors

Properties

_overlapAB _overlapBA _supports

Methods

_findSupports _overlapAxes _projectToAxis collides create

Constructors

constructor

new default(): default
Returns default

Properties

`Static` `Protected` _overlapAB

_overlapAB: IOverlap = ...

`Static` `Protected` _overlapBA

_overlapBA: IOverlap = ...

`Static` `Protected` _supports

_supports: IVertex[] = []

Methods

`Static` `Protected` _findSupports

_findSupports(bodyA, bodyB, normal, direction): IVertex[]
Finds supporting vertices given two bodies along a given direction using hill-climbing.
Parameters
- bodyA: IBody
- bodyB: IBody
- normal: IVector
- direction: number
Returns IVertex[]

Method
_findSupports
- Defined in src/collision/Collision.ts:304

`Static` `Protected` _overlapAxes

_overlapAxes(result, verticesA, verticesB, axes): void
Find the overlap between two sets of vertices.
Parameters
- result: IOverlap
- verticesA: IVertex[]
- verticesB: IVertex[]
- axes: IAxes
Returns void

Method
_overlapAxes
- Defined in src/collision/Collision.ts:203

`Static` `Protected` _projectToAxis

_projectToAxis(projection, vertices, axis): void
Projects vertices on an axis and returns an interval.
Parameters
- projection: {
  max: number;
  min: number;
  }
  - max: number
  - min: number
- vertices: IVertex[]
- axis: IVector
Returns void

Method
_projectToAxis
- Defined in src/collision/Collision.ts:274

`Static` collides

collides(bodyA, bodyB, pairs?): null | ICollision
Detect collision between two bodies.
Parameters
- bodyA: IBody
- bodyB: IBody
- Optional pairs: null | IPairs
  
  Optionally reuse collision records from existing pairs.
Returns null | ICollision
A collision record if detected, otherwise null

Method
collides
- Defined in src/collision/Collision.ts:79

`Static` create

create(bodyA, bodyB): ICollision
Creates a new collision record.
Parameters
- bodyA: IBody
  
  The first body part represented by the collision record
- bodyB: IBody
  
  The second body part represented by the collision record
Returns ICollision
A new collision record

Method
create
- Defined in src/collision/Collision.ts:55

Generated using TypeDoc