To separate your event logic from your UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary code, use a manipulator to handle events. Manipulators are state machinesThe set of states in an Animator Controller that a character or animated GameObject can be in, along with a set of transitions between those states and a variable to remember the current state. The states available will depend on the type of gameplay, but typical states include things like idling, walking, running and jumping. More info
See in Glossary that handle user interaction with UI elements. They store, register, and unregister event callbacks. A manipulator streamlines setting up that user interaction, so you don’t have to handle each callback one by one. To handle events, use or inherit from one of the manipulators that UI Toolkit supports.
To create and use a manipulator:
The following table lists the supported manipulator classes:
Manipulator | Inherits from | Description |
---|---|---|
Manipulator |
Base class for all provided manipulators. | |
KeyboardNavigationManipulator |
Manipulator |
Handles translation of device-specific input events to higher-level navigation operations with a keyboard. |
MouseManipulator |
Manipulator |
Handles mouse input. Has a list of activation filters. |
ContextualMenuManipulator |
MouseManipulator |
Displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard. |
PointerManipulator |
MouseManipulator |
Handles pointer input. Has a list of activation filters. |
Clickable |
PointerManipulator |
Tracks mouse events on an element, and identifies when a click occurs, which is both a pointer press and release on the same element. |
The following examples demonstrate how to use manipulators to handle events. They do the following:
PointerManipulators
class, which handles mouse input.activators
list to specify the conditions that activate the manipulator. For example, to activate the manipulator when the user clicks the left mouse button, add
ManipulatorActivationFilter
to the activators
list with the button
field set to MouseButton.LeftMouse
.target
property to access the element that the manipulator is attached to.RegisterCallbacksOnTarget
and UnregisterCallbacksFromTarget
methods to register and unregister the event callbacks.The following example creates a manipulator that moves an element when you click and drag it:
using UnityEngine; using UnityEngine.UIElements; public class ExampleDragger : PointerManipulator { private Vector3 m_Start; protected bool m_Active; private int m_PointerId; private Vector2 m_StartSize; public ExampleDragger() { m_PointerId = -1; activators.Add(new ManipulatorActivationFilter { button = MouseButton.LeftMouse }); m_Active = false; } protected override void RegisterCallbacksOnTarget() { target.RegisterCallback<PointerDownEvent>(OnPointerDown); target.RegisterCallback<PointerMoveEvent>(OnPointerMove); target.RegisterCallback<PointerUpEvent>(OnPointerUp); } protected override void UnregisterCallbacksFromTarget() { target.UnregisterCallback<PointerDownEvent>(OnPointerDown); target.UnregisterCallback<PointerMoveEvent>(OnPointerMove); target.UnregisterCallback<PointerUpEvent>(OnPointerUp); } protected void OnPointerDown(PointerDownEvent e) { if (m_Active) { e.StopImmediatePropagation(); return; } if (CanStartManipulation(e)) { m_Start = e.localPosition; m_PointerId = e.pointerId; m_Active = true; target.CapturePointer(m_PointerId); e.StopPropagation(); } } protected void OnPointerMove(PointerMoveEvent e) { if (!m_Active || !target.HasPointerCapture(m_PointerId)) return; Vector2 diff = e.localPosition - m_Start; target.style.top = target.layout.y + diff.y; target.style.left = target.layout.x + diff.x; e.StopPropagation(); } protected void OnPointerUp(PointerUpEvent e) { if (!m_Active || !target.HasPointerCapture(m_PointerId) || !CanStopManipulation(e)) return; m_Active = false; target.ReleaseMouse(); e.StopPropagation(); } }
The following example creates a manipulator that resizes an element when you drag it:
using UnityEngine; using UnityEngine.UIElements; public class ExampleResizer : PointerManipulator { private Vector3 m_Start; protected bool m_Active; private int m_PointerId; private Vector2 m_StartSize; public ExampleResizer() { m_PointerId = -1; activators.Add(new ManipulatorActivationFilter { button = MouseButton.LeftMouse }); m_Active = false; } protected override void RegisterCallbacksOnTarget() { target.RegisterCallback<PointerDownEvent>(OnPointerDown); target.RegisterCallback<PointerMoveEvent>(OnPointerMove); target.RegisterCallback<PointerUpEvent>(OnPointerUp); } protected override void UnregisterCallbacksFromTarget() { target.UnregisterCallback<PointerDownEvent>(OnPointerDown); target.UnregisterCallback<PointerMoveEvent>(OnPointerMove); target.UnregisterCallback<PointerUpEvent>(OnPointerUp); } protected void OnPointerDown(PointerDownEvent e) { if (m_Active) { e.StopImmediatePropagation(); return; } if (CanStartManipulation(e)) { m_Start = e.localPosition; m_StartSize = target.layout.size; m_PointerId = e.pointerId; m_Active = true; target.CapturePointer(m_PointerId); e.StopPropagation(); } } protected void OnPointerMove(PointerMoveEvent e) { if (!m_Active || !target.HasPointerCapture(m_PointerId)) return; Vector2 diff = e.localPosition - m_Start; target.style.height = m_StartSize.y + diff.y; target.style.width = m_StartSize.x + diff.x; e.StopPropagation(); } protected void OnPointerUp(PointerUpEvent e) { if (!m_Active || !target.HasPointerCapture(m_PointerId) || !CanStopManipulation(e)) return; m_Active = false; target.ReleasePointer(m_PointerId); m_PointerId = -1; e.StopPropagation(); } }
To add a manipulator to an element, use the AddManipulator
method. To remove a manipulator from an element, use the RemoveManipulator
method.
The following example adds and removes the ExampleDragger
to a VisualElement
:
// Create a VisualElement. var myElement = new VisualElement(); var dragger = new ExampleDragger(); // Add manipulators to the VisualElement. myElement.AddManipulator(dragger); // Remove manipulators from the VisualElement. myElement.RemoveManipulator(dragger);
The following example adds the ExampleResizer
to a VisualElement
:
var box = new VisualElement() { style = { left = 100, top = 100, width = 100, height = 100, backgroundColor = Color.red }, pickingMode = PickingMode.Position, }; box.AddManipulator(new ExampleResizer());
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.