Show:
API

Matter.Detector

Defined in: src/collision/Detector.js:1

The Matter.Detector module contains methods for efficiently detecting collisions between a list of bodies using a broadphase algorithm.

Methods

Matter.Detector._sortCompare

(bodyA, bodyB)
→ Number private

The comparison function used in the broadphase algorithm. Returns the signed delta of the bodies bounds on the x-axis.

Parameters

Returns

Number

The signed delta used for sorting

src/collision/Detector.js:155 · Usages · Examples

Matter.Detector.canCollide

(filterA, filterB)
→ Bool

Returns true if both supplied collision filters will allow a collision to occur. See body.collisionFilter for more information.

Parameters

Returns

Bool

true if collision can occur

src/collision/Detector.js:140 · Usages · Examples

Matter.Detector.clear

(detector)

Clears the detector including its list of bodies.

Parameters

src/collision/Detector.js:41 · Usages · Examples

Matter.Detector.collisions

(detector)
→ Collision[]

Efficiently finds all collisions among all the bodies in detector.bodies using a broadphase algorithm.

Note: The specific ordering of collisions returned is not guaranteed between releases and may change for performance reasons. If a specific ordering is required then apply a sort to the resulting array.

Parameters

Returns

Collision[]

collisions

src/collision/Detector.js:50 · Usages · Examples

Matter.Detector.create

(options)
→ Detector

Creates a new collision detector.

Parameters

Returns

Detector

A new collision detector

src/collision/Detector.js:16 · Usages · Examples

Matter.Detector.setBodies

(detector, bodies)

Sets the list of bodies in the detector.

Parameters

src/collision/Detector.js:31 · Usages · Examples

Properties / Options

The following properties if specified below are for objects created by Matter.Detector.create and may be passed to it as options.

Detector.bodies

Body[]

The array of Matter.Body between which the detector finds collisions.

Note: The order of bodies in this array is not fixed and will be continually managed by the detector.

Default: []

src/collision/Detector.js:174 · Usages · Examples

Detector.pairs

Pairs | Null

Optional. A Matter.Pairs object from which previous collision objects may be reused. Intended for internal Matter.Engine usage.

Default: null

src/collision/Detector.js:183 · Usages · Examples