Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Handles

class in UnityEditor

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

Switch to Manual

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 Variables

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.
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.

Variables

currentCameraSetup viewport and stuff for a current camera.

Static Functions

ArrowCapDraw an arrow like those used by the move tool.
BeginGUIBegin a 2D GUI block inside the 3D handle GUI.
ButtonMake a 3D Button.
CircleCapDraw a camera-facing Circle. Pass this into handle functions.
ClearCameraClears the camera.
ConeCapDraw a Cone. Pass this into handle functions.
CubeCapDraw a cube. Pass this into handle functions.
CylinderCapDraw a Cylinder. Pass this into handle functions.
DiscMake a 3D disc that can be dragged with the mouse.
DotCapDraw a camera-facing dot. 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.
DrawLineDraw a line from p1 to p2.
DrawPolyLineDraw a line going through the list of all points.
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.
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 3D Scene view position handle.
RadiusHandleMake a Scene view radius handle.
RotationHandleMake a Scene view rotation handle.
ScaleHandleMake a Scene view scale handle.
ScaleSliderMake a directional scale slider.
ScaleValueHandleMake a single-float draggable handle.
SelectionFrameDraw a camera facing selection frame.
SetCameraSet the current camera so all Handles and Gizmos are draw with its settings.
SliderMake a 3D slider.
Slider2DSlide a handle in a 2D plane.
SnapValueRounds the value val to the closest multiple of snap (snap can only be posiive).
SphereCapDraw a Sphere. Pass this into handle functions.

Delegates

DrawCapFunctionThe function to use for drawing the handle e.g. Handles.RectangleCap.
Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download