Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ContactPair

A pair of Colliders that belong to the bodies in the parent ContactPairHeader struct.
Read time 1 minuteLast updated 2 days ago

Definition

  • Type: Struct
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule
public readonly struct ContactPair

Remarks

Contains an array of ContactPairPoints that can be retrieved using the ContactPair.GetContactPoint method.

Properties

Property

Description

colliderThe first Collider component of the ContactPair.
colliderInstanceIDInstance ID of the first Collider in the ContactPair.
contactCountThe number of ContactPairPoints that this pair contains.
impulseSumTotal impulse sum of the pair.
isCollisionEnterWhether or not this pair is equivalent to a pair reported in MonoBehaviour.OnCollisionEnter(Collision) events.
isCollisionExitWhether or not this pair is equivalent to a pair reported in MonoBehaviour.OnCollisionExit(Collision) events.
isCollisionStayWhether or not this pair is equivalent to a pair reported in MonoBehaviour.OnCollisionStay(Collision) events.
otherColliderThe second Collider component of the ContactPair.
otherColliderInstanceIDInstance ID of the second Collider in the ContactPair.

Methods

Method

Description

CopyToNativeArrayCopies the internal ContactPairPoint buffer to the provided buffer.
GetContactPointGets the ContactPairPoint at the provided index of this pair.
GetContactPointFaceIndexGet the index of a face that a particular contact point belongs to in this ContactPairPoint.