Class Pair

The Matter.Pair module contains methods for creating and manipulating collision pairs.

Pair

Index

Constructors

Methods

create id setActive update

Constructors

constructor

new Pair(): MatterJS.Pair
Returns MatterJS.Pair

Methods

`Static`create

create(collision: MatterJS.ICollisionData, timestamp: number): MatterJS.IPair
Creates a pair.
Parameters
- collision: MatterJS.ICollisionData
- timestamp: number
Returns MatterJS.IPair
A new pair

Method
create
- Defined in types/matter.d.ts:3703

`Static`id

id(bodyA: MatterJS.BodyType, bodyB: MatterJS.BodyType): string
Get the id for the given pair.
Parameters
- bodyA: MatterJS.BodyType
- bodyB: MatterJS.BodyType
Returns string
Unique pairId

Method
id
- Defined in types/matter.d.ts:3730

`Static`setActive

setActive(pair: MatterJS.IPair, isActive: boolean, timestamp: number): void
Set a pair as active or inactive.
Parameters
- pair: MatterJS.IPair
- isActive: boolean
- timestamp: number
Returns void
Method
setActive
- Defined in types/matter.d.ts:3721

`Static`update

update(
    pair: MatterJS.IPair,
    collision: MatterJS.ICollisionData,
    timestamp: number,
): void
Updates a pair given a collision.
Parameters
- pair: MatterJS.IPair
- collision: MatterJS.ICollisionData
- timestamp: number
Returns void
Method
update
- Defined in types/matter.d.ts:3712