Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles

class in UnityEditor

Other Versions
Leave feedback
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

Description

Custom 3D GUI controls and drawing in the scene view.

Handles are the 3D controls that Unity uses to manipulate items in the scene view. There are a number of built-in Handle GUIs, such as the familiar tools to position, scale and rotate an object via the Transform component. However, it is also possible to define your own Handle GUIs to use with custom component editors. Such GUIs can be a very useful way to edit procedurally-generated scene content, "invisible" items and groups of related objects, such as waypoints and location markers.

You can also supplement the 3D Handle GUI in the scene with 2D buttons and other controls overlaid on the scene view. This is done by enclosing standard Unity GUI calls in a Handles.BeginGUI / EndGUI pair within the //OnSceneGUI// function. You can use HandleUtility.GUIPointToWorldRay and HandleUtility.WorldToGUIPoint to convert coordinates between 2D GUI and 3D world coordinates.

Static Properties

centerColorColor to use for handles that represent the center of something.
colorColors of the handles.
inverseMatrixThe inverse of the matrix for all handle operations.
lightingAre handles lit?
matrixMatrix for all handle operations.
preselectionColorColor to use to highlight an unselected handle currently under the mouse pointer.
secondaryColorSoft color to use for for general things.
selectedColorColor to use for the currently active handle.
xAxisColorColor to use for handles that manipulates the X coordinate of something.
yAxisColorColor to use for handles that manipulates the Y coordinate of something.
zAxisColorColor to use for handles that manipulates the Z coordinate of something.
zTestzTest of the handles.

Properties

currentCameraSetup viewport and stuff for a current camera.

Static Methods

ArrowHandleCapDraw an arrow like those used by the move tool.
BeginGUIBegin a 2D GUI block inside the 3D handle GUI.
ButtonMake a 3D Button.
CircleHandleCapDraw a circle handle. Pass this into handle functions.
ClearCameraClears the camera.
ConeHandleCapDraw a cone handle. Pass this into handle functions.
CubeHandleCapDraw a cube handle. Pass this into handle functions.
CylinderHandleCapDraw a cylinder handle. Pass this into handle functions.
DiscMake a 3D disc that can be dragged with the mouse. Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.
DotHandleCapDraw a dot handle. Pass this into handle functions.
DrawAAConvexPolygonDraw anti-aliased convex polygon specified with point array.
DrawAAPolyLineDraw anti-aliased line specified with point array and width.
DrawBezierDraw textured bezier line through start and end points with the given tangents. To get an anti-aliased effect use a texture that is 1x2 pixels with one transparent white pixel and one opaque white pixel. The bezier curve will be swept using this texture.
DrawCameraDraws a camera inside a rectangle.
DrawDottedLineDraw a dotted line from p1 to p2.
DrawDottedLinesDraw a list of dotted line segments.
DrawLineDraw a line from p1 to p2.
DrawLinesDraw a list of line segments.
DrawPolyLineDraw a line going through the list of all points.
DrawSelectionFrameDraw a camera facing selection frame.
DrawSolidArcDraw a circular sector (pie piece) in 3D space.
DrawSolidDiscDraw a solid flat disc in 3D space.
DrawSolidRectangleWithOutlineDraw a solid outlined rectangle in 3D space.
DrawWireArcDraw a circular arc in 3D space.
DrawWireCubeDraw a wireframe box with center and size.
DrawWireDiscDraw the outline of a flat disc in 3D space.
EndGUIEnd a 2D GUI block and get back to the 3D handle GUI.
FreeMoveHandleMake an unconstrained movement handle.
FreeRotateHandleMake an unconstrained rotation handle.
GetMainGameViewSizeGet the width and height of the main game view.
LabelMake a text label positioned in 3D space.
MakeBezierPointsRetuns an array of points to representing the bezier curve. See Handles.DrawBezier.
PositionHandleMake a position handle.
RadiusHandleMake a Scene view radius handle.
RectangleHandleCapDraw a rectangle handle. Pass this into handle functions.
RotationHandleMake a Scene view rotation handle.
ScaleHandleMake a Scene view scale handle.Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.
ScaleSliderMake a directional scale slider.
ScaleValueHandleMake a 3D handle that scales a single float.
SetCameraSet the current camera so all Handles and Gizmos are draw with its settings.
SliderMake a 3D slider that moves along one axis.
Slider2DMake a 3D slider that moves along a plane defined by two axes.
SnapValueRounds the value val to the closest multiple of snap (snap can only be positive).
SphereHandleCapDraw a sphere handle. Pass this into handle functions.

Delegates

CapFunctionThe function to use for drawing the handle e.g. Handles.RectangleCap.
SizeFunctionA delegate type for getting a handle's size based on its current position.

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 2017.2-001U. Built: 2017-12-08.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information