Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ClosestPoint(Vector2)

Returns a point on the perimeter of all enabled Colliders attached to this Rigidbody 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

position

Vector2
The position from which to find the closest point on this Rigidbody.

Returns

Type

Description

Vector2A point on the perimeter of a Collider attached to this rigidbody 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 enabled Collider2D type attached to this Rigidbody.
In the case where the 
position
is inside any of the enabled Collider2D attached to this Rigidbody, the input 
position
is returned instead.