创建弹出窗口

此示例演示如何使用 UnityEditor.PopupWindow 创建弹出窗口。

示例概述

此示例创建一个弹出窗口，该窗口通过自定义编辑器窗口中的按钮显示。弹出窗口具有三个切换按钮，并且在失去焦点时关闭。

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

先决条件

本指南适用于熟悉 Unity 编辑器、UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 术语表 工具包和 C# 脚本的开发者。在开始之前，请熟悉以下内容

• UXML
• USS
• UnityEditor.PopupWindow

创建自定义编辑器窗口

创建一个带有按钮的自定义编辑器窗口。在 UI 文档（UXML 文件）中定义按钮，并在 USS 文件中设置其样式。最后，在 C# 脚本中定义按钮逻辑，以便单击按钮时显示弹出窗口。

1. 使用任何模板创建一个 Unity 项目。

2. 在“项目”窗口中右键单击，然后选择创建 > UI 工具包 > 编辑器窗口。

3. 在UI 工具包编辑器窗口创建器窗口的C# 框中，输入PopupExample。

4. 选择确认。这将创建三个文件：PopupExample.cs、PopupExample.uxml 和 PopupExample.uss。

5. 将 PopupExample.uxml 替换为以下内容

          
   <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="True">
   <Style src="PopupExample.uss" />
   <ui:Button text="Popup Options" display-tooltip-when-elided="true" class="popup-button" />
   </ui:UXML>
        
   

6. 将 PopupExample.cs 替换为以下内容

           
   using UnityEditor;
   using UnityEngine.UIElements;
   using PopupWindow = UnityEditor.PopupWindow;
       
   public class PopupExample : EditorWindow
   {
        //Add menu item
        [MenuItem("Examples/Popup Example")]
        static void Init()
        {
             EditorWindow window = EditorWindow.CreateInstance<PopupExample>();
             window.Show();
        }
       
        private void CreateGUI()
        {
             var visualTreeAsset = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/ui-toolkit-manual-code-examples/create-a-popup-window/PopupExample.uxml");
             visualTreeAsset.CloneTree(rootVisualElement);
       
             var button = rootVisualElement.Q<Button>();
             button.clicked += () => PopupWindow.Show(button.worldBound, new PopupContentExample());
        }
   }
   

7. 将 PopupExample.uss 替换为以下内容

   .popup-button {
       width: 200px;
   }
   

创建弹出窗口内容

创建一个 UI 文档（UXML 文件）以定义弹出窗口中的内容。创建一个 C# 类来设置窗口大小并显示窗口。

1. 在Editor 文件夹中，创建一个名为 PopupWindowContent.uxml 的 UI 文档，其内容如下

   <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="True">
       <ui:Toggle label="Toggle 1" name="Toggle1"/>
       <ui:Toggle label="Toggle 2" />
       <ui:Toggle label="Toggle 3" />
   </ui:UXML>
   

2. 在Editor 文件夹中，创建一个名为 PopupContentExample.cs 的 C# 文件，其内容如下

   using UnityEditor;
   using UnityEngine;
   using UnityEngine.UIElements;
       
   public class PopupContentExample : PopupWindowContent
   { 
       public override void OnOpen()
       {
           Debug.Log("Popup opened: " + this);
       }
       
       public override VisualElement CreateGUI()
       {
           var visualTreeAsset = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/ui-toolkit-manual-code-examples/create-a-popup-window/PopupWindowContent.uxml");
           return visualTreeAsset.CloneTree();
       }
       
       public override void OnClose()
       {
           Debug.Log("Popup closed: " + this);
       }
   }
   

3. 要测试弹出窗口，请从菜单中选择示例 > 弹出窗口示例 > 弹出窗口选项。