Version: 2021.1
LanguageEnglish
  • C#

Collider2D.ClosestPoint

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public Vector2 ClosestPoint(Vector2 position);

Parameters

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

Returns

Vector2 A point on the perimeter of this Collider that is closest to the specified position.

Description

Returns a point on the perimeter of this Collider that is closest to the specified position.

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.

See Also: Rigidbody2D.ClosestPoint & Physics2D.ClosestPoint.

Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961