class in UnityEditor
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.
CloseFor 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.
CloseHelper functions for Scene View style 3D GUI.
These are mainly mathematical functions that assist in converting between the 3D Scene space and the 2D GUI. The functions are used in the construction of the Unity Editor itself and so using them is a good way to make your own Handles GUIs consistent with Unity's.
acceleration | Get standard acceleration for dragging values (Read Only). |
nearestControl | The controlID of the nearest Handle to the mouse cursor. |
niceMouseDelta | Get nice mouse delta to use for dragging a float value (Read Only). |
niceMouseDeltaZoom | Get nice mouse delta to use for zooming (Read Only). |
AddControl | Record a distance measurement from a handle. |
AddDefaultControl | Add the ID for a default control. This will be picked if nothing else is. |
CalcLineTranslation | Map a mouse drag onto a movement along a line in 3D space. |
ClosestPointToArc | Get the point on an arc (in 3D space) which is closest to the current mouse position. |
ClosestPointToDisc | Get the point on an disc (in 3D space) which is closest to the current mouse position. |
ClosestPointToPolyLine | Get the point on a polyline (in 3D space) which is closest to the current mouse position. |
DecodeSelectionId | Translates a Vector4 selectionId value retrieved from GPU into a single integer picking index. |
DistancePointBezier | Calculate distance between a point and a Bezier curve. |
DistancePointLine | Calculate distance between a point and a line. |
DistancePointToLine | Distance from a point p in 2d to a line defined by two points a and b. |
DistancePointToLineSegment | Distance from a point p in 2d to a line segment defined by two points a and b. |
DistanceToArc | Returns the distance in pixels from the mouse pointer to a 3D section of a disc. |
DistanceToCircle | Returns the distance in pixels from the mouse pointer to a camera facing circle. |
DistanceToCone | Returns the distance in pixels from the mouse pointer to a cone. |
DistanceToCube | Returns the distance in pixels from the mouse pointer to a cube. |
DistanceToDisc | Returns the distance in pixels from the mouse pointer to a 3D disc. |
DistanceToLine | Returns the distance in pixels from the mouse pointer to a line. |
DistanceToPolyLine | Returns the distance in pixels from the mouse pointer to a polyline. |
DistanceToRectangle | Returns the distance in pixels from the mouse pointer to a rectangle on screen. |
EncodeSelectionId | Translates a single integer picking index into a Vector4 selectionId value. The Vector4 selectionId is used to render the picking render textures during picking rendering. |
FindNearestVertex | Returns the nearest vertex to a guiPoint within a maximum radius of 50 pixels. |
GetHandleSize | Get world space size of a manipulator handle at given position. |
GetOverlappingObjects | Gets an ordered list of objects that would be picked under the give mouse position. |
GetPickingIncludeExcludeList | Gets the picking PickingIncludeExcludeList for the currently executing BatchRendererGroup.OnPerformCulling callback. |
GetSelectionOutlineIncludeExcludeList | Gets the selection outline PickingIncludeExcludeList for the currently executing BatchRendererGroup.OnPerformCulling callback. |
GUIPointToScreenPixelCoordinate | Converts a 2D GUI position to screen pixel coordinates. |
GUIPointToWorldRay | Convert 2D GUI position to a world space ray. |
PickAllObjects | Creates a list of all GameObjects under the specified position in screen coordinates. |
PickGameObject | Pick game object closest to specified position. |
PickRectObjects | Pick GameObjects that lie within a specified screen rectangle. |
PlaceObject | Casts a ray against the loaded scenes and returns the nearest intersected point on a collider. |
PointOnLineParameter | Returns the parameter for the projection of the point on the given line. |
PopCamera | Retrieve all camera settings. |
ProjectPointLine | Project point onto a line. |
PushCamera | Store all camera settings. |
RaySnap | Casts ray against the Scene and reports whether an object lies in its path. |
RegisterRenderPickingCallback | Registers a callback to invoke when Unity renders for picking. |
Repaint | Repaint the current view. |
UnregisterRenderPickingCallback | Unregisters the callback that was previously registered for custom picking rendering.The method throws InvalidOperationException if you try to call it inside render picking callbacks. |
WorldPointToSizedRect | Calculate a rectangle to display a 2D GUI element near a projected point in 3D space. |
WorldToGUIPoint | Convert a world space point to a 2D GUI position. |
WorldToGUIPointWithDepth | Convert a world space point to a 2D GUI position. |
getAuthoringObjectForEntity | The user-defined callback that Unity uses to retrieve the Unity Object associated with a DOTS Entity. |
getEntitiesForAuthoringObject | The user-defined callback that Unity uses to retrieve the DOTS Entity IDs associated with a Unity Object. |
pickGameObjectCustomPasses | Subscribe to this event to add additional picking objects to the HandleUtility.PickGameObject method. |
placeObjectCustomPasses | Subscribe to this event to handle object placement in the SceneView. |
PickGameObjectCallback | This is the method definition for pickGameObjectCustomPasses. |
PlaceObjectDelegate | This is the method definition for placeObjectCustomPasses. |
RenderPickingCallback | The delegate type to use with RegisterRenderPickingCallback and UnregisterRenderPickingCallback. |
ResolvePickingCallback | The delegate type to return from RenderPickingCallback through the RenderPickingResult.resolver member. |
ResolvePickingWithWorldPositionCallback | The delegate type to return from RenderPickingCallback through the RenderPickingResult.resolverWithWorldPos member, with the additional world space position and depth information of where the click occurred. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.