ColliderDistance2D
Represents the separation or overlap of two Collider2D.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
public struct ColliderDistance2D
Remarks
The ColliderDistance2D primarily defines a point on the exterior of each Collider2D along with the _distance between those two points. The _distance between them can be positive indicating that the Collider2D are separated (not overlapped), zero indicating that they are touching (but not overlapped) or negative indicating that they are overlapped.
A _normal is provided that is a normalized vector that points from _pointB to _pointA. This vector, when scaled with the _distance, provide a vector that can be used to move the Collider2D so that they are no longer overlapped (if the _distance is negative) or so they are touching (if the _distance is positive).
A common use-case for this is solving overlaps between two Collider2D, particularly when attached to a Rigidbody2D set to be RigidbodyType2D.Kinematic.
Properties
Property | Description |
|---|---|
| distance | Gets the distance between two colliders. |
| isOverlapped | Gets whether the |
| isValid | Gets whether the distance is valid or not. |
| normal | A normalized vector that points from |
| pointA | A point on a Collider2D that is a specific _distance away from _pointB. |
| pointB | A point on a Collider2D that is a specific _distance away from _pointA. |