Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ClosestPoint

Returns a point on the perimeter of the Collider that is closest to the specified position.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule

ClosestPoint(Vector2, Collider2D)

Returns a point on the perimeter of the 
Collider
that is closest to the specified 
position
.
public static Vector2 ClosestPoint(Vector2 position, Collider2D collider)

Parameters

position

Vector2
The position from which to find the closest point on the specified 
Collider
.

collider

Collider2D

Returns

Type

Description

Vector2A point on the perimeter of the 
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 the 
Collider
or the 
Collider
is disabled, then the input 
position
is returned instead.

ClosestPoint(Vector2, Rigidbody2D)

Returns a point on the perimeter of all enabled Colliders attached to the 
rigidbody
that is closest to the specified 
position
.
public static Vector2 ClosestPoint(Vector2 position, Rigidbody2D rigidbody)

Parameters

position

Vector2
The position from which to find the closest point on the specified 
rigidbody
.

rigidbody

Rigidbody2D
The Rigidbody on which to find the closest specified 
position
.

Returns

Type

Description

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