Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Plane.GetDistanceToPoint

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 function GetDistanceToPoint(inPt: Vector3): float;
public float GetDistanceToPoint(Vector3 inPt);

Description

Returns a signed distance from plane to point.

The value returned is positive if the point is on the side of the plane into which the plane's normal is facing, and negative otherwise.