Version: 2021.3+
This example demonstrates how to bind a custom control to a native Unity type.
The example creates a custom control that displays a 2D image. It uses the custom control in a custom Editor for a new asset type, and it binds the custom control to a field in an asset of the new type.
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:
BindableElement
INotifyValueChanged
Create a serialized object that contains a Texture2D.
Assets
folder (Project tab) More infobind-custom-control
to store the files.TextureAsset.cs
and replace its contents with the following:using UnityEngine; namespace UIToolkitExamples { [CreateAssetMenu(menuName = "UIToolkitExamples/TextureAsset")] public class TextureAsset : ScriptableObject { public Texture2D texture; public void Reset() { texture = null; } } }
Create a custom control with C# that represents a reference to a 2D texture asset, and style it with USS.
Editor
.TexturePreviewElement.cs
.TexturePreviewElement.cs
with the following:using System; using UnityEditor.UIElements; using UnityEngine; using UnityEngine.UIElements; using Object = UnityEngine.Object; namespace UIToolkitExamples { [UxmlElement] public partial class TexturePreviewElement : BindableElement, INotifyValueChanged<Object> { public static readonly string ussClassName = "texture-preview-element"; Image m_Preview; ObjectField m_ObjectField; Texture2D m_Value; public TexturePreviewElement() { AddToClassList(ussClassName); // Create a preview image. m_Preview = new Image(); Add(m_Preview); // Create an ObjectField, set its object type, and register a callback when its value changes. m_ObjectField = new ObjectField(); m_ObjectField.objectType = typeof(Texture2D); m_ObjectField.RegisterValueChangedCallback(OnObjectFieldValueChanged); Add(m_ObjectField); styleSheets.Add(Resources.Load<StyleSheet>("texture_preview_element")); } void OnObjectFieldValueChanged(ChangeEvent<Object> evt) { value = evt.newValue; } public void SetValueWithoutNotify(Object newValue) { if (newValue == null || newValue is Texture2D) { // Update the preview Image and update the ObjectField. m_Value = newValue as Texture2D; m_Preview.image = m_Value; // Notice that this line calls the ObjectField's SetValueWithoutNotify() method instead of just setting // m_ObjectField.value. This is very important; you don't want m_ObjectField to send a ChangeEvent. m_ObjectField.SetValueWithoutNotify(m_Value); } else throw new ArgumentException($"Expected object of type {typeof(Texture2D)}"); } public Object value { get => m_Value; // The setter is called when the user changes the value of the ObjectField, which calls // OnObjectFieldValueChanged(), which calls this. set { if (value == this.value) return; var previous = this.value; SetValueWithoutNotify(value); using (var evt = ChangeEvent<Object>.GetPooled(previous, value)) { evt.target = this; SendEvent(evt); } } } } }
Resources
.texture_preview_element.uss
and replace its contents with the following:.texture-preview-element { width: 200px; height: 200px; } .texture-preview-element > .unity-image { flex-grow: 1; }
Create 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 UI, and bind the custom control to the Texture2D object.
TextureAssetEditor.cs
and replace its contents with the following:using UnityEditor; using UnityEngine.UIElements; using UnityEngine; namespace UIToolkitExamples { [CustomEditor(typeof(TextureAsset))] public class TextureAssetEditor : Editor { [SerializeField] VisualTreeAsset m_VisualTree; public override VisualElement CreateInspectorGUI() { return m_VisualTree.CloneTree(); } } }
Create a UXML file with a TexturePreviewElement, and set the binding-path
property to texture
. This binds the TexturePreviewElement to TextureAsset.texture
.
texture_asset_editor.uxml
and replace its contents with the following:<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:example="UIToolkitExamples" editor-extension-mode="True"> <example:TexturePreviewElement binding-path="texture" /> </ui:UXML>
TextureAsset
.TextureAsset.texture
changes.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.