绑定自定义控件

版本：2021.3+

此示例演示了如何将自定义控件绑定到原生 Unity 类型。

示例概述

此示例创建了一个显示 2D 图像的自定义控件。它将自定义编辑器中的自定义控件用于新资源类型，并将自定义控件绑定到新类型资源中的字段。

您可以在此 GitHub 代码仓库中找到此示例创建的完整文件。

先决条件

本指南适用于熟悉 Unity 编辑器、UI 工具包和 C# 脚本的开发者。在开始之前，请熟悉以下内容：

创建序列化对象

创建包含 Texture2D 的序列化对象。

使用任何模板创建 Unity 项目。
在项目 (Project) 窗口中，创建一个名为 bind-custom-control 的文件夹来存储文件。
创建一个名为 TextureAsset.cs 的 C# 脚本，并将其内容替换为以下代码：

using UnityEngine;

namespace UIToolkitExamples
{
    [CreateAssetMenu(menuName = "UIToolkitExamples/TextureAsset")]
    public class TextureAsset : ScriptableObject
    {
        public Texture2D texture;

        public void Reset()
        {
            texture = null;
        }
    }
}

创建一个自定义控件并设置其样式

使用 C# 创建一个自定义控件，表示对 2D 纹理资源的引用，并使用 USS 设置其样式。

在该文件夹中，创建一个名为 Editor 的文件夹。
在 Editor 文件夹中，创建一个名为 TexturePreviewElement.cs 的 C# 脚本。
将 TexturePreviewElement.cs 的内容替换为以下内容：

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);
                }
            }
        }
    }
}

在 Editor 文件夹中，创建一个名为 Resources 的文件夹。
在 Resources 文件夹中，创建一个名为 texture_preview_element.uss 的样式表 (StyleSheet)，并将其内容替换为以下内容：

.texture-preview-element {
    width: 200px;
    height: 200px;
}

.texture-preview-element > .unity-image {
    flex-grow: 1;
}

创建 Inspector UI

创建 Inspector__ UI__（即用户界面，User Interface）让用户能够与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
See in Glossary，并将自定义控件绑定到 Texture2D 对象。

在 Editor 文件夹中创建一个名为 TextureAssetEditor.cs 的 C# 脚本，并将其内容替换为以下代码：

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();
        }
    }
}

使用 UXML 设置绑定

使用 TexturePreviewElement 创建一个 UXML 文件，并将 binding-path 属性设置为 texture。这会将 TexturePreviewElement 绑定到 TextureAsset.texture。

在 Editor 文件夹中，创建一个名为 texture_asset_editor.uxml 的 UI 文档，并将其内容替换为以下内容：

<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:example="UIToolkitExamples" editor-extension-mode="True">
    <example:TexturePreviewElement binding-path="texture" />
</ui:UXML>

在项目 (Project) 窗口中，选择 TextureAssetEditor.cs。
在检视面板 (Inspector) 中将 texture_asset_editor.uxml 拖动到 Visual Tree 上。

测试绑定

从菜单中选择资源 (Assets) > 创建 (Create) > UIToolkitExamples > TextureAsset。这将创建 TextureAsset 实例。
选择新的 TextureAsset 对象。在检视面板 (Inspector) 中，可以看到纹理预览元素 (Texture Preview Element)。如果将纹理资源引用放入字段中，则可以在字段上方看到预览。如果在 UI 中的纹理预览元素中更改资源引用，则 TextureAsset.texture 会更改。

其他资源

绑定到没有 ListView 的列表

将自定义控件绑定到自定义数据类型