Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

HandleUtility.PointOnLineParameter

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

Sumbission failed

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

Close

Cancel

public static function PointOnLineParameter(point: Vector3, linePoint: Vector3, lineDirection: Vector3): float;
public static float PointOnLineParameter(Vector3 point, Vector3 linePoint, Vector3 lineDirection);
public static def PointOnLineParameter(point as Vector3, linePoint as Vector3, lineDirection as Vector3) as float

Description

Returns the parameter for the projection of the point on the given line.

The return value can be negative if the projected point is in negative lineDirection relative to the linePoint/ See Also: ProjectPointLine.