从即时模式 GUI （IMGUI） 迁移到 UI 工具包

本指南适用于对即时模式GUI（IMGUI）有经验的开发人员，以迁移到UI Toolkit。本指南重点介绍编辑器UI，但其信息也适用于运行时UI。

主要区别

代码驱动与 UI 驱动

IMGUI 由调用OnGUI函数。UI Toolkit为编辑器UI创建提供了更多选项。使用UI Toolkit，你可以在C#中定义行为脚本一段代码，允许您创建自己的组件、触发游戏事件、随时间修改组件属性以及以您喜欢的任何方式响应用户输入。更多信息
请参阅术语表. 但是，在定义 UI 元素和样式时，除了 C# 之外，还可以在 UI Builder 中直观地定义 UI 控件，或者直接编写类似 XML 的文本文件（称为 UXML）。有关详细信息，请参阅 UI 工具包入门。

立即与保留模式

使用 IMGUI，您可以在OnGUI()功能。 当事件进入 UI 或重新绘制 UI 时，您必须调用此函数。不同事件之间没有与 UI 树相关的持久信息。而您创建视觉元素实例化或派生自 C# 的可视化树的节点VisualElement类。您可以设置外观样式、定义行为并将其作为 UI 的一部分显示在屏幕上。更多信息
请参阅术语表在名为可视化树由轻量级节点组成的对象图，用于保存窗口或面板中的所有元素。它定义了使用 UI 工具包构建的每个 UI。
请参阅术语表. 可视化树中的信息将永久保留。

常量与状态变化

IMGUI 基于OnGUI()每帧至少运行一次的函数。您可以为每个可能的帧定义界面的外观和行为。的正文OnGUI()可能包含许多条件和不同的状态。

UI 工具包在事件驱动系统中运行。您可以定义默认状态下的 UI 外观，并定义 UI 响应事件的行为。您在 UI 工具包中所做的任何更改都会导致 UI 状态持续更改。

例如，IMGUI 中按钮的声明如下所示：

if (GUILayout.Button("Click me!"))
{
    //Code runs here in frames where the user clicks the button.

    //Code makes changes to the UI for frames where the user has just clicked the button.
}
else
{
    //Code specifies what happens in all other frames.
}

上面的示例在 UI Toolkit 中如下所示：

UIDocument document = GetComponent<UIDocument>();

//Create button.
Button button = new Button();
button.text = "Click me!";

//Set up event handler.
button.RegisterCallback<ClickEvent>((ClickEvent evt) =>
{
    //Code runs here after button receives ClickEvent.
});

//Add button to UI.
document.rootVisualElement.Add(button);

有关如何使用UI Toolkit创建自定义编辑器窗口的完整示例，请参阅UI Toolkit入门。

IMGUI 支持

使用IMGUIContainer将 IMGUI 代码放置在VisualElement.您可以在内部执行的一切OnGUI()被支持。

您可以安排多个IMGUIContainers 并通过混合来布置它们GUILayout和 UI 工具包布局。请注意，无法添加VisualElement实例IMGUIContainer.

从 IMGUI 到 UI Toolkit 的转换

下表列出了 IMGUI 和 UI 工具包之间的等效功能：

下表列出了 IMGUI 和 UI Toolkit 之间的等效方法、类和属性：

其他资源

• UI Toolkit 入门
• Unity 样式表 （USS）
• 例子
• IMGUI 事件