Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

HandleUtility.DistanceToPolyLine

static function DistanceToPolyLine(params points: Vector3[]): float;
static float DistanceToPolyLine(params Vector3[] points);
static def DistanceToPolyLine(*points as Vector3[]) as float

Description

Pixel distance from mouse pointer to a polyline.

Calculates the screen space distance from the mouse pointer to the multi segment line that goes through the given world space points.

Uses the current camera to determine the distance.

See Also: DistanceToLine.