Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

Collider.ClosestPoint

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

public Vector3 ClosestPoint(Vector3 position);

Parameters

positionLocation you want to find the closest point to.

Returns

Vector3 The point on the collider that is closest to the specified location.

Description

Returns a point on the collider that is closest to a given location.

This method computes the point on the collider that is closest to a 3d location in the world. In the example below closestPoint is the point on the collider and location is the point in 3d space.

Note: The difference from ClosestPointOnBounds is that the returned point is actually on the collider instead of on the bounds of the collider. (bounds is a box that surrounds the collider.)

using UnityEngine;

// Note that closestPoint is based on the surface of the collider. // location represents a point in 3d space. // The gizmos work in the editor.

// Attach this to a GameObject that has a Collider component attached public class ShowClosestPoint : MonoBehaviour { public Vector3 location;

public void OnDrawGizmos() { var collider = GetComponent<Collider>();

if (!collider) return; // nothing to do without a collider

Vector3 closestPoint = collider.ClosestPoint(location);

Gizmos.DrawSphere(location, 0.1f); Gizmos.DrawWireSphere(closestPoint, 0.1f); } }

Note: Same as Physics.ClosestPoint but doesn't allow passing a custom position and rotation. Instead, it uses the position of the collider.

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