Unity 编辑器篇|（八）编辑器工具类（EditorGUIUtility、EditorUtility、GUIUtility、GUILayoutUtility） （全面总结 | 建议收藏）_unity 编辑器工具 editor window

1. EditorGUIUtility

1.1 参数总览

1.2 选中提示： PingObject

• 在场景中对对象执行 Ping 操作，就像在检视面板中单击它一样。
  PingObject 将促使 Hierarchy 突出显示已执行 Ping 操作的对象。不必选择 已执行 Ping 操作的对象。例如，可以用于 GameObject.Find 来查找 要执行 Ping 操作的对象。

 [MenuItem("Examples/Ping Selected")]
 static void Ping()
 {
     if (!Selection.activeObject)
     {
         Debug.Log("Select an object to ping");
         return;
     }

     EditorGUIUtility.PingObject(Selection.activeObject);
 }
1
2
3
4
5
6
7
8
9
10
11

1.3 搜索框： ShowObjectPicker

private Texture tex;
...
if (GUILayout.Button("查找法线贴图"))
{
    //参数释义
    //1. 查找对象的引用
    //2. 是否允许查找场景对象
    //3. 查找对象名称过滤（比如这里的normal是指文件名称中有normal的会被搜索到）
    //4. controlID, 默认写0
    EditorGUIUtility.ShowObjectPicker<Texture>(tex, false, "normal", 0);
}
1
2
3
4
5
6
7
8
9
10
11

1.4 currentViewWidth

• 这个值和position.width的值，它们近似相等

        if (GUILayout.Button("Test"))
        {
            Debug.Log(EditorGUIUtility.currentViewWidth);
            Debug.Log(this.position.width);
        }
1
2
3
4
5

1.5 fieldWidth

• 为 Editor GUI 控件字段保留的最小宽度（以像素为单位）。
  大多数 Editor GUI 控件由标签和控制字段本身组成。字段的最小宽度由 fieldWidth 值控制。字段通常看起来比最小宽度要宽，因为 Editor GUI 控件通常设置为占用一个 Rect，该 Rect 会扩展以填充可用的水平空间。在此 Rect 中，该字段将占用 EditorGUIUtility.labelWidth 未使用的所有空间。

1.6 labelWidth

• 为 Editor GUI 控件标签保留的宽度（以像素为单位）。
  Editor GUI 控件为标签分配了特定的宽度。可通过将 labelWidth 设置为不同的值来更改此宽度。将其设置为 0 会将标签宽度重置为默认值。默认值可能有所不同，例如，取决于 Inspector 窗口的宽度。

EditorGUIUtility.labelWidth = 50;
EditorGUILayout.TextField("Label", "Text");
1
2

1.7 singleLineHeight

• 获取用于单个 Editor 控件（如单行 EditorGUI.TextField 或 EditorGUI.Popup）的高度。
  当您创建自己的多行控件（例如具有多个字段的自定义类的控件）时，可以使用 EditorGUILayout.GetControlRect 并传入一个高度值，该值是 EditorGUIUtility.singleLineHeight 的倍数。这比硬编码特定像素值更可取。

1.8 IconContent

• 从具有给定名称的 Unity 内置资源中获取 GUIContent。
  EditorGUIUtility.IconContent 用于为 GUI 元素创建 GUIContent。 只会加载图标.通常情况下，将使用第一个参数获取 Assets/Editor Default Resources/Icons 中的图标。 只需要图标的名称，而不需要 png 扩展名。 \ 第二个参数为悬停工具提示提供文本。此字符串 需要以竖线“|”字符开头以将其标记为工具提示。\ \ 注意：目前无法悬停定位在工具提示上方。

2. EditorUtility

2.1 参数总览

2.2 “脏”标志：ClearDirty、IsDirty、SetDirty

• Unity 使用“脏”标志查找必须保存到磁盘的已更改资源。如果对资源进行的更改无需保存（例如以后会恢复的临时更改）
• ClearDirty： 使用ClearDirty清除“脏”标志。
• IsDirty：判断是否带有“脏”标志。
• SetDirty：将对象标记为脏。当您想要修改对象而不撤消时，可以使用SetDirty，但仍要确保更改已保存且不会丢失。如果对象是场景的一部分，则该场景被标记为脏。

2.3 进度条：ClearProgressBar、DisplayCancelableProgressBar、DisplayProgressBar

• ClearProgressBar： 删除进度条。
• DisplayCancelableProgressBar： 显示或更新含有 Cancel 按钮的进度条。
• DisplayProgressBar： 显示或更新进度条。

using Unity.VisualScripting;
using Unity.VisualScripting.YamlDotNet.Core.Tokens;
using UnityEditor;
using UnityEngine;

public class EditorGUIExample : EditorWindow
{
    [MenuItem("Examples/ProgressBar(")]
    static void Init()
    {
        UnityEditor.EditorWindow window = GetWindow(typeof(EditorGUIExample));
        window.position = new Rect(0, 0, 150, 60);
        window.Show();
    }

    private float value; //定义进度条填充值
    private void OnGUI()
    {
        if (GUILayout.Button("增加进度")) //手动增加进度
        {
            value += 0.1f;
            value = Mathf.Clamp01(value); //约束value值到0~1
        }
        EditorUtility.DisplayProgressBar("进度条", "显示信息", value); //显示进度条
        if (value == 1)
        {
            EditorUtility.ClearProgressBar(); //关闭进度条
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

2.4 提示框：DisplayDialog、DisplayDialogComplex、DisplayPopupMenu

• DisplayDialog： 显示模态对话框。
• DisplayDialogComplex： 显示含有三个按钮的模态对话框。
• DisplayPopupMenu： 显示弹出菜单。

DisplayDialog

EditorUtility.DisplayDialog("Title", "Message", "ok", "cancel");
1

DisplayDialogComplex

 EditorUtility.DisplayDialogComplex("Title", "Message", "ok", "cancel", "alt");
1

DisplayPopupMenu

 if (GUILayout.Button("对话框"))
 {
     Event evt = Event.current;
     Vector2 mousePos = evt.mousePosition;
     EditorUtility.DisplayPopupMenu(new Rect(mousePos.x, mousePos.y, 0, 0), "Assets/", null);
 }
1
2
3
4
5
6

2.5 打开文件对话框：OpenFilePanel、OpenFilePanelWithFilters、OpenFolderPanel

• OpenFilePanel： 显示“打开文件”对话框并返回所选的路径名称。
• OpenFilePanelWithFilters： 显示“打开文件”对话框并返回所选的路径名称。
• OpenFolderPanel： 显示“打开文件夹”对话框并返回所选的路径名称。

OpenFilePanel

    private void OnGUI()
    {
        if (GUILayout.Button("OpenFilePanel"))
        {
            string path = EditorUtility.OpenFilePanel("png", "", "png");
        }
    }
1
2
3
4
5
6
7

OpenFilePanelWithFilters

 if (GUILayout.Button("OpenFilePanelWithFilters"))
 {
     string path = EditorUtility.OpenFilePanelWithFilters("png", "", 
         new string[] { "Image files", "png,jpg,jpeg", "All files", "*" });
 }
1
2
3
4
5

OpenFolderPanel

    private void OnGUI()
    {
        if (GUILayout.Button("OpenFolderPanel"))
        {
            string path = EditorUtility.OpenFolderPanel("Load png Textures", "", "");
        }
    }
1
2
3
4
5
6
7

2.6 保存文件对话框：SaveFilePanel、SaveFilePanelInProject、SaveFolderPanel

• SaveFilePanel： 显示“保存文件”对话框并返回所选的路径名称。
• SaveFilePanelInProject： 在项目的 Assets 文件夹中显示“保存文件”对话框并返回所选的路径名称。
• SaveFolderPanel： 显示“保存文件夹”对话框并返回所选的路径名称。

SaveFilePanel

     private void OnGUI()
   {
       if (GUILayout.Button("SaveFilePanel"))
       {
           var path = EditorUtility.SaveFilePanel(
          "Save texture as PNG",
          "",
          "texture.png",
          "png");
       }
   }
1
2
3
4
5
6
7
8
9
10
11

SaveFilePanelInProject

   if (GUILayout.Button("SaveFilePanelInProject"))
   {
       string path = EditorUtility.SaveFilePanelInProject("Save png", "texture.png", "png",
        "Please enter a file name to save the texture to");
   }
1
2
3
4
5

SaveFolderPanel

    if (GUILayout.Button("SaveFolderPanel"))
   {
       string path = EditorUtility.SaveFolderPanel("Save textures to folder", "", "");
   }
1
2
3
4

2.6 SetObjectEnabled、GetObjectEnabled

• 设置/获取对象的启用状态。

3. GUIUtility

3.1 参数总览

4. GUILayoutUtility

4.1 参数总览

5. 总结

• EditorGUIUtility、EditorUtility、GUIUtility、GUILayoutUtility都是Unity编辑器中用于UI开发的工具类，但它们的功能和使用场景有所不同。

  • EditorGUIUtility：主要用于编辑器界面的UI开发，提供了创建和管理编辑器界面的工具和函数。它继承自GUIUtility，因此具有GUIUtility的所有功能。
  • EditorUtility：一个辅助类，主要用于编辑器脚本的开发。它提供了一系列实用的静态方法，用于处理编辑器中的各种任务，例如获取场景中的相机、设置游戏对象的属性等。
  • GUIUtility：一个基础的UI绘制类，主要用于在场景中创建和管理UI元素。它提供了很多基础的UI组件，例如按钮、标签、滑动条等，但需要手动设置控件的位置和大小。
  • GUILayoutUtility：类似于GUIUtility，用于在场景中创建和管理UI元素。但它提供了自动布局的功能，可以自动调整控件的位置和大小，使其适应不同的屏幕尺寸和分辨率。

• 总结来说，EditorGUIUtility主要用于编辑器界面的UI开发，EditorUtility主要用于编辑器脚本的开发，GUIUtility提供基础的UI组件但需要手动布局，而GUILayoutUtility则提供了自动布局的功能。

我的博客即将同步至腾讯云开发者社区，邀请大家一同入驻：https://cloud.tencent.com/developer/support-plan?invite_code=1vi5kv7wjb1cc