ClosestPoint(Vector2)
Returns a point on the perimeter of this Collider that is closest to the specified position.
Read time 1 minuteLast updated 13 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
public Vector2 ClosestPoint(Vector2 position)
Parameters
The position from which to find the closest point on this Collider.
Returns
Type | Description |
|---|---|
| Vector2 | A point on the perimeter of this Collider that is closest to the specified position. |
Remarks
This function provides the ability to calculate the closest point of a specified position to the perimeter of any Collider2D type.
In the case where the position is inside this Collider or this Collider is disabled, then the input position is returned instead.
Additional Resources: Rigidbody2D.ClosestPoint & Physics2D.ClosestPoint.