Version: 2021.3+
This example demonstrates the lifecycle of a transition event.
The example creates a custom Editor window with a button and color palette. If you click the button, the following appears:
You can find the completed files that this example creates in this GitHub repository.
This guide is for developers familiar with the Unity Editor, UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit, and C# scripting. Before you start, get familiar with the following:
Create a project in Unity with any template.
From the menu, select Assets > Create > UI Toolkit > Editor Window.
In the UI Toolkit Editor Window Creator window, enter TransitionExample
.
Save your changes. This creates three files as TransitionExample.cs
, TransitionExample.uss
, and TransitionExample.uxml
.
Replace TransitionExample.cs
with the following content:
using System; using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class TransitionExample : EditorWindow { [SerializeField] private VisualTreeAsset m_VisualTreeAsset = default; private Button clickMeButton; private VisualElement colorChanger; private Label eventLabel; private Label timeLabel; private DateTime lastEvent; private static readonly TimeSpan NearlyInstantaneousThreshold = TimeSpan.FromMilliseconds(10); private static readonly string ClickMeButtonClass = "click-me"; private static readonly string ColorChangerClass = "color-changer"; private static readonly string ColorChangerTransitionClass = "color-transition"; private static readonly string EventLabelName = "eventLabel"; private static readonly string TimeLabelName = "timeLabel"; private static readonly string TimeBelowThresholdText = "Almost instantaneous."; [MenuItem("Window/UI Toolkit/Transition Example")] public static void ShowExample() { TransitionExample wnd = GetWindow<TransitionExample>(); wnd.titleContent = new GUIContent("TransitionExample"); wnd.minSize = new Vector2(500f, 400f); } public void CreateGUI() { lastEvent = DateTime.Now; // Each editor window contains a root VisualElement object VisualElement root = rootVisualElement; // Instantiate UXML VisualElement uxmlAsset = m_VisualTreeAsset.Instantiate(); root.Add(uxmlAsset); // Get the relevant elements by querying the root element clickMeButton = root.Q<Button>(className: ClickMeButtonClass); colorChanger = root.Q<VisualElement>(className: ColorChangerClass); eventLabel = root.Q<Label>(name: EventLabelName); timeLabel = root.Q<Label>(name: TimeLabelName); // Add callbacks for clicking on the button and monitoring the color changing element. clickMeButton.RegisterCallback<ClickEvent>(OnClickEvent); colorChanger.RegisterCallback<TransitionRunEvent>(OnTransitionRun); colorChanger.RegisterCallback<TransitionStartEvent>(OnTransitionStart); colorChanger.RegisterCallback<TransitionEndEvent>(OnTransitionEnd); colorChanger.RegisterCallback<TransitionCancelEvent>(OnTransitionCancel); } private void OnDisable() { clickMeButton.UnregisterCallback<ClickEvent>(OnClickEvent); colorChanger.UnregisterCallback<TransitionRunEvent>(OnTransitionRun); colorChanger.UnregisterCallback<TransitionStartEvent>(OnTransitionStart); colorChanger.UnregisterCallback<TransitionEndEvent>(OnTransitionEnd); colorChanger.UnregisterCallback<TransitionCancelEvent>(OnTransitionCancel); } private void OnClickEvent(ClickEvent evt) { colorChanger.ToggleInClassList(ColorChangerTransitionClass); } private void OnTransitionRun(TransitionRunEvent evt) { DisplayLatestEvent("TransitionRunEvent", DateTime.Now); } private void OnTransitionStart(TransitionStartEvent evt) { DisplayLatestEvent("TransitionStartEvent", DateTime.Now); } private void OnTransitionEnd(TransitionEndEvent evt) { DisplayLatestEvent("TransitionEndEvent", DateTime.Now); } private void OnTransitionCancel(TransitionCancelEvent evt) { DisplayLatestEvent("TransitionCancelEvent", DateTime.Now); } private void DisplayLatestEvent(string eventType, DateTime timestamp) { // If two events are sent too close together, add both to the Latest event line. // This happens if the delay is set to 0 and the TransitionRun and TransitionStart // are sent at the same time, or if the button was pressed before the transition // was over, thus sending TransitionCancel and TransitionRun (and potentially // TransitionStart) events close together. var elapsed = timestamp - lastEvent; if (elapsed <= NearlyInstantaneousThreshold) { timeLabel.text = TimeBelowThresholdText; eventLabel.text += eventType; } else { timeLabel.text = $"{elapsed:s\\.ff} s"; eventLabel.text = eventType; } lastEvent = timestamp; } }
Replace TransitionExample.uxml
with the following content:
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False"> <Style src="TransitionExample.uss"/> <ui:VisualElement class="main-container"> <ui:Button text="Click Me!" class="click-me"/> <ui:VisualElement class="color-changer"/> <ui:VisualElement class="label-section"> <ui:VisualElement class="label-line"> <ui:Label text="Latest event(s) : "/> <ui:Label name="eventLabel"/> </ui:VisualElement> <ui:VisualElement class="label-line"> <ui:Label text="Time since last event : "/> <ui:Label name="timeLabel"/> </ui:VisualElement> </ui:VisualElement> </ui:VisualElement> </ui:UXML>
Replace TransitionExample.uss
with the following content:
.click-me { width: 250px; height: 50px; font-size: 40px; -unity-font-style: bold-and-italic; margin: 30px; } .color-changer { margin: 10px; width: 150px; height: 150px; border-width: 10px; border-radius: 75px; background-color: rgb(0, 31, 138); transition: background-color 3s ease-in-out 1s; } .main-container { align-items: center; justify-content: space-between; flex-grow: 1; background-color: rgb(60, 60, 60); } .label-section { margin: 10px; border-width: 2px; width: 95%; align-items: center; } .label-line { flex-direction: row; margin: 5px; flex-grow: 1; align-items: center; width: 90%; height: 25px; font-size: 14px; padding: 0; } .color-transition { background-color: rgb(177, 221, 111); }
Select TransitionExample.cs
and drag TransitionExample.uxml
to the Visual TreeAn object graph, made of lightweight nodes, that holds all the elements in a window or panel. It defines every UI you build with the UI Toolkit.
See in Glossary Asset field in the InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary if it’s not already there.
To try the example, from the menu, select Window > UI Toolkit > Transition Example.
Click the button to view the color transition and the description of the events sent. There is a long delay between the TransitionRunEvent
and the TransitionStartEvent
. During the long duration, you can click the button again to interrupt the transition.
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.