Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

Rigidbody2D.ClosestPoint

Other Versions
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

Switch to Manual
public Vector2 ClosestPoint(Vector2 position);

Parameters

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

Returns

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

Description

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

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store