p1 | The position of the first line's end point in world space. |
p2 | The position of the second line's end point in world space. |
thickness | Line thickness in UI points (zero thickness draws single-pixel line). |
Draws a line from p1
to p2
.
The Handles.color and Handles.matrix properties colorize and additionally transform the line position. Unity ignores DrawLine
(that is, nothing happens) when the current GUI event type is not Repaint.
Draw Line in the Scene View.
Below is an example of an Editor script that draws lines in SceneView to GameObjects listed in a script.
// Draw lines to the connected game objects that a script has. // If the target object doesnt have any game objects attached // then it draws a line from the object to (0, 0, 0).
using UnityEditor; using UnityEngine;
[CustomEditor(typeof(ConnectedObjectsExampleScript))] class ConnectLineHandleExampleScript : Editor { void OnSceneGUI() { ConnectedObjectsExampleScript connectedObjects = target as ConnectedObjectsExampleScript; if (connectedObjects.objs == null) return;
Vector3 center = connectedObjects.transform.position; for (int i = 0; i < connectedObjects.objs.Length; i++) { GameObject connectedObject = connectedObjects.objs[i]; if (connectedObject) { Handles.DrawLine(center, connectedObject.transform.position); } else { Handles.DrawLine(center, Vector3.zero); } } } }
Example script to attach to a GameObject that will act as a handle:
using UnityEngine;
public class ConnectedObjectsExampleScript : MonoBehaviour { public GameObject[] objs = null; }
Line thickness
can be optionally set. Zero thickness draws a one-pixel line. Larger thickness values express line thickness in UI points. For example, a thickness of 1.0 could be two pixels wide on screen if the display zoom is 200% (see EditorGUIUtility.pixelsPerPoint).
Lines of varying thickness.
using UnityEngine; using UnityEditor;
public class ExampleScript : MonoBehaviour { }
// Displays lines of various thickness in the scene view [CustomEditor(typeof(ExampleScript))] public class ExampleEditor : Editor { public void OnSceneGUI() { var t = target as ExampleScript; var tr = t.transform; var position = tr.position; Handles.color = Color.yellow; for (int i = 0; i < 10; ++i) { var linePos = position + Vector3.right * (i * 0.5f); Handles.DrawLine(linePos, linePos + Vector3.up, i); } } }
Additional resources: Handles.lineThickness, Handles.DrawLines, Handles.DrawPolyLine, Handles.DrawWireDisc.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.