Pair

Models a potential collision between 2 colliders

Index

Constructors

• constructor

Properties

• colliderA
• colliderB
• id

Accessors

• canCollide

Methods

• collide
• hasCollider
• calculatePairHash
• canCollide
• isDormant

Constructors

constructor

• Pair(colliderA: Collider, colliderB: Collider): Pair

• Parameters

  • colliderA: Collider

  • colliderB: Collider

  Returns Pair

Properties

publiccolliderA

colliderA: Collider

publiccolliderB

colliderB: Collider

publicid

id: string

Accessors

publiccanCollide

• get canCollide(): boolean

• Returns whether or not it is possible for the pairs to collide

  ---

  Returns boolean

Methods

publiccollide

• collide(): CollisionContact[]

• Runs the collision intersection logic on the members of this pair

  ---

  Returns CollisionContact[]

publichasCollider

• hasCollider(collider: Collider): boolean

• Check if the collider is part of the pair

  ---

  Parameters

  • collider: Collider

  Returns boolean

publicstaticcalculatePairHash

• calculatePairHash(idA: Id<collider>, idB: Id<collider>): string

• Calculates the unique pair hash id for this collision pair (owning id)

  ---

  Parameters

  • idA: Id<collider>

  • idB: Id<collider>

  Returns string

publicstaticcanCollide

• canCollide(colliderA: Collider, colliderB: Collider): boolean

• Returns whether a it is allowed for 2 colliders in a Pair to collide

  ---

  Parameters

  • colliderA: Collider

  • colliderB: Collider

  Returns boolean

publicstaticisDormant

• isDormant(bodyA: BodyComponent | null | undefined, bodyB: BodyComponent | null | undefined): boolean

• A pair is dormant when neither body can move: both are asleep, or one is asleep against a CollisionType.Fixed body. Dormant pairs need no collision detection, the collision system carries their last contact over unchanged until one of them wakes.

  ---

  Parameters

  • bodyA: BodyComponent | null | undefined

  • bodyB: BodyComponent | null | undefined

  Returns boolean