【IMGUI】 GUI、GUILayout、EditorGUI、EditorGUILayout_guilayoutoption

主要区别

首先GUI、GUILayout所属的命名空间是UnityEngine。
EditorGUI、EditorGUILayout所属的命名空间是Editor。

GUI和GUILayout都可用于游戏界面Runtime下的布局。
使用GUI和EditorGUI需要手动设置控件的Rect方法，这样，布局都是定死了（添加Button的话，Button的Text也不能自适应）。

使用GUILayout和EditorGUILayout是自动布局，不用设置Rect。

GUILayout

静态函数

GUILayout.BeginScrollView

public class GUILayout1 : EditorWindow
{
    public string txtArea = "ff";
   Vector2 scrollPosition;
    string t = "This is a string inside a Scroll view!";
 
    [MenuItem("Tool/GUILayout 1")]
  public static void ShowWindow()
    {
        EditorWindow.GetWindow<GUILayout1>(true, "GUILayout1");
    }
    public void OnGUI()
    {
        EditorGUILayout.BeginHorizontal();
        scrollPosition = GUILayout.BeginScrollView(scrollPosition);//注意：scrollPosition 必须要有，不然会拖动不了
        GUILayout.Label(t);
        GUILayout.EndScrollView();
        EditorGUILayout.EndHorizontal();
        if (GUILayout.Button("Add More Text"))
            t += " \nAnd this is more text!";
        if (GUILayout.Button("Clear"))
            t = "";
    }
}
 

尽量使用如下方法进行布局相关的代码编辑，因为using可以在IDE下可以折叠，可读性更优，而且可以避免成对编码时的遗漏问题，比如写了Begin...，却忘记写End...。

    Vector2 _scrollPos; 
 
    private void OnGUI()
    {
        using (EditorGUILayout.ScrollViewScope sv = new EditorGUILayout.ScrollViewScope(_scrollPos, GUI.skin.box))
        {
            _scrollPos = sv.scrollPosition;
        }
 
        using (new EditorGUILayout.HorizontalScope())
        {
        }
        
        using (new GUILayout.HorizontalScope())
        {
        }
    }

GUILayout.Button

public static bool Button (Texture image, params GUILayoutOption[] options);
public static bool Button (string text, params GUILayoutOption[] options);
public static bool Button (GUIContent content, params GUILayoutOption[] options);
public static bool Button (Texture image, GUIStyle style, params GUILayoutOption[] options);
public static bool Button (string text, GUIStyle style, params GUILayoutOption[] options);
public static bool Button (GUIContent content, GUIStyle style, params GUILayoutOption[] options);

返回
bool 当用户单击该按钮时，返回 true

if(GUILayout.Button(...))
    {
 
    }

GUILayout.HorizontalScrollbar

public static float HorizontalScrollbar (float value, float size, float leftValue, float rightValue, params GUILayoutOption[] options);
public static float HorizontalScrollbar (float value, float size, float leftValue, float rightValue, GUIStyle style, params GUILayoutOption[] options);

public float scrollbarValue = 0f;
public void OnGUI()
{
    scrollbarValue = GUILayout.HorizontalScrollbar(scrollbarValue, 10, 0, 1000);
}
 

GUILayout.HorizontalSlider

public static float HorizontalSlider (float value, float leftValue, float rightValue, params GUILayoutOption[] options);
public static float HorizontalSlider (float value, float leftValue, float rightValue, GUIStyle slider, GUIStyle thumb, params GUILayoutOption[] options);

public float sliderValue = 0f;
public void OnGUI()
{
    sliderValue = GUILayout.HorizontalScrollbar(sliderValue, 10, 0, 1000);
}
 

GUILayout.Label

创建一个自动布局标签,标签不与用户交互，不捕捉鼠标点击操作，并始终以正常样式呈现。若要创建对用户输入提供视觉响应的控件，请使用 Button 控件。

public static void Label (Texture image, params GUILayoutOption[] options);
public static void Label (string text, params GUILayoutOption[] options);
public static void Label (GUIContent content, params GUILayoutOption[] options);
public static void Label (Texture image, GUIStyle style, params GUILayoutOption[] options);
public static void Label (string text, GUIStyle style, params GUILayoutOption[] options);
public static void Label (GUIContent content, GUIStyle style, params GUILayoutOption[] options);

GUILayout.Label("LabelText");
GUILayout.Label(texture, GUILayout.MaxHeight(100), GUILayout.MaxWidth(100));

GUIContent类

静态变量

变量

MaxHeight、MaxWidth、MinHeight、MinWidth

Rect windowRect = new Rect(10, 10, 100, 100);
windowRect = GUILayout.Window(0, windowRect, ScalingWindow, "resizeable",
GUILayout.MinHeight(80), GUILayout.MaxHeight(200));

GUILayout.PasswordField

public static string PasswordField (string password, char maskChar, params GUILayoutOption[] options);
public static string PasswordField (string password, char maskChar, int maxLength, params GUILayoutOption[] options);
public static string PasswordField (string password, char maskChar, GUIStyle style, params GUILayoutOption[] options);
public static string PasswordField (string password, char maskChar, int maxLength, GUIStyle style, params GUILayoutOption[] options);

GUILayout.TextArea

多行文本输入框

GUILayout.TextFiled

单行文本输入框

相比与EditorGUILayout，更不好用，EditorGUILayout可以传入label参数

GUILayout.Toolbar

public static int Toolbar (int selected, string[] texts, params GUILayoutOption[] options);
public static int Toolbar (int selected, Texture[] images, params GUILayoutOption[] options);
public static int Toolbar (int selected, GUIContent[] contents, params GUILayoutOption[] options);
public static int Toolbar (int selected, string[] texts, GUIStyle style, params GUILayoutOption[] options);
public static int Toolbar (int selected, Texture[] images, GUIStyle style, params GUILayoutOption[] options);
public static int Toolbar (int selected, GUIContent[] contents, GUIStyle style, params GUILayoutOption[] options);
public static int Toolbar (int selected, string[] texts, GUIStyle style, GUI.ToolbarButtonSize buttonSize, params GUILayoutOption[] options);
public static int Toolbar (int selected, Texture[] images, GUIStyle style, GUI.ToolbarButtonSize buttonSize, params GUILayoutOption[] options);
public static int Toolbar (int selected, GUIContent[] contents, GUIStyle style, GUI.ToolbarButtonSize buttonSize, params GUILayoutOption[] options);

using UnityEngine;
 
public class ExampleScript : MonoBehaviour
{
    int toolbarInt = 0;
    string[] toolbarStrings = ["Toolbar1", "Toolbar2", "Toolbar3"];
 
    void OnGUI()
    {
        toolbarInt = GUILayout.Toolbar(toolbarInt, toolbarStrings);
    }
}

EditorGUILayout

EditorGUI 的自动布局版本。

EditorGUILayout.BeginFadeGroup

public class MyWindow : EditorWindow
{
    AnimBool m_ShowExtraFields;
    string m_String;
    Color m_Color = Color.white;
    int m_Number = 0;
 
    [MenuItem("Window/My Window")]
    static void Init()
    {
        MyWindow window = (MyWindow)EditorWindow.GetWindow(typeof(MyWindow));
    }
 
    void OnEnable()
    {
        m_ShowExtraFields = new AnimBool(true);
        m_ShowExtraFields.valueChanged.AddListener(Repaint);
    }
 
    void OnGUI()
    {
        m_ShowExtraFields.target = EditorGUILayout.ToggleLeft("Show extra fields", m_ShowExtraFields.target);
 
        //Extra block that can be toggled on and off.
        if (EditorGUILayout.BeginFadeGroup(m_ShowExtraFields.faded))
        {
            EditorGUI.indentLevel++;
            EditorGUILayout.PrefixLabel("Color");
            m_Color = EditorGUILayout.ColorField(m_Color);
            EditorGUILayout.PrefixLabel("Text");
            m_String = EditorGUILayout.TextField(m_String);
            EditorGUILayout.PrefixLabel("Number");
            m_Number = EditorGUILayout.IntSlider(m_Number, 0, 10);
            EditorGUI.indentLevel--;
        }
 
        EditorGUILayout.EndFadeGroup();
    }
}

EditorGUILayout.BeginFoldoutHeaderGroup

创建一个左侧带有折叠箭头的标签。

这适用于文件夹之类的结构，其中子对象仅在展开父项时显示。此控件不能嵌套在其他 BeginFoldoutHeaderGroup 中。要使用多个折叠，每个方法都必须以 EndFoldoutHeaderGroup 结尾。
 

创建可隐藏或显示所选变换的可折叠标题菜单。

public class FoldoutHeaderUsage : EditorWindow
{
    bool showPosition = true;
    string status = "Select a GameObject";
 
    [MenuItem("Examples/Foldout Header Usage")]
    static void CreateWindow()
    {
        GetWindow<FoldoutHeaderUsage>();
    }
 
    public void OnGUI()
    {
        showPosition = EditorGUILayout.BeginFoldoutHeaderGroup(showPosition, status);
 
        if (showPosition)
            if (Selection.activeTransform)
            {
                Selection.activeTransform.position =
                    EditorGUILayout.Vector3Field("Position", Selection.activeTransform.position);
                status = Selection.activeTransform.name;
            }
 
        if (!Selection.activeTransform)
        {
            status = "Select a GameObject";
            showPosition = false;
        }
        // End the Foldout Header that we began above.
        EditorGUILayout.EndFoldoutHeaderGroup();
    }
}

EditorGUILayout.DelayedxxxField

我们以DelayedTextField为例。

创建一个延迟文本字段。

与 EditorGUILayout.TextField 类似，但在用户按 Enter 键或将焦点从文本字段移开之前，不会返回新值。

    private string _showText;
 
    void OnGUI()
    {
        _showText = EditorGUILayout.DelayedTextField(_showText);
        EditorGUILayout.TextField(_showText);
    }

EditorGUILayout.DropdownButton

创建一个能够对鼠标按下做出反应的按钮，用于显示您自己的下拉菜单内容。

此控件不会执行任何操作，只是在单击时针对鼠标按下返回 true；这与常规按钮相反，后者在鼠标松开时返回 true。

这可用于以下拉菜单形式打开 GenericMenu 或您自己的自定义 EditorWindow 的按钮。

与 GenericMenu 结合使用时，请使用 GenericMenu.Dropdown 并向此方法传递与用于按钮的矩形相同的矩形，可使用 GUILayoutUtility.GetLastRect 获取此矩形。

与自定义 EditorWindow 结合使用时，请使用 EditorWindow.ShowAsDropdown 并向此方法传递与用于按钮的矩形相同的矩形，可使用 GUILayoutUtility.GetLastRect 获取此矩形。

        if (EditorGUILayout.DropdownButton(new GUIContent("DropDownButton"), FocusType.Keyboard))
        {
            GenericMenu menu = new GenericMenu();
            menu.AddItem(new GUIContent("Test1"), false, OnTest1);
            menu.AddItem(new GUIContent("Test2"), false, OnTest2);
            menu.DropDown(GUILayoutUtility.GetLastRect());
        }

EditorGUILayout.GetControlRect

获取编辑器控件的矩形。

在创建新的编辑器控件时，用于实现实际控件的声音设计并不依赖于 GUILayout，而是让控件将 Rect 作为参数，类似于 EditorGUI 类中的控件。这样可确保该控件还可以用于 PropertyDrawer 等类中，而此类中不允许使用 GUILayout。

实现控件的非布局版本后，也可以轻松创建布局版本，只需调用非布局版本即可。要获取适合控件的矩形，可以使用 GetControlRect 函数。

EditorGUILayout.HelpBox

创建一块提示区域。

 EditorGUILayout.HelpBox("提示", MessageType.Info);

比较常见的就不过多讲解了，可以看下表的API进行查阅。

静态函数

GUI

GUI 类是 Unity GUI 的接口，并且具有手动定位功能。Editor下使用比较少，不做过多讲解。

GUI.backgroundColor、color

可以用来改变GUI的颜色使用。

静态变量

静态函数

委托

EditorGUI

EditorGUI.indentLevel

字段标签的缩进级别。

EditorGUILayout.LabelField 将显示以参数形式给出的字符串。该字符串可以显示在水平位置，具体位置由 indentLevel 更改。随着 indentLevel 提高，标签将向右移动。降低 indentLevel 将使标签向左移动。

这些方法的运行方式与常规 GUI 函数十分相似，并且在 EditorGUILayout 中也有匹配实现。

静态变量

静态函数