Unity 编辑器篇|（七）编辑器拓展EditorGUILayout类（全面总结

1. 前言

EditorGUILayout专门用于编辑器界面的GUI类，提供了Unity内置类或结构体的控件函数，比如Color类、Vector3类等定义的控件。
为编辑器在Inspector和EditorWindow中扩展提供了很大的方便。

2. 参数

静态函数描述BeginBuildTargetSelectionGrouping开始构建目标组并返回所选 BuildTargetGroup。BeginFadeGroup开始一个可隐藏/显示的组，并且过渡将生成动画。BeginFoldoutHeaderGroup创建一个左侧带有折叠箭头的标签。BeginHorizontal开始一个水平组并找回其矩形。BeginScrollView开始一个自动布局的滚动视图。BeginToggleGroup开始一个垂直组，带有可一次性启用或禁用所有控件的开关。BeginVertical开始一个垂直组并找回其矩形。BoundsField创建用于输入 Bounds 的 Center 和 Extents 字段。BoundsIntField创建用于输入 BoundsInt 的 Position 和 Size 字段。ColorField创建一个用于选择 Color 的字段。CurveField创建一个用于编辑 AnimationCurve 的字段。DelayedDoubleField创建一个用于输入双精度浮点数的延迟文本字段。DelayedFloatField创建一个用于输入浮点数的延迟文本字段。DelayedIntField创建一个用于输入整数的延迟文本字段。DelayedTextField创建一个延迟文本字段。DoubleField生成一个用于输入双精度值的文本字段。DropdownButton创建一个能够对鼠标按下做出反应的按钮，用于显示您自己的下拉菜单内容。EditorToolbar创建一个用指定的编辑器工具集合填充的工具栏。EditorToolbarForTarget创建一个工具栏，该工具栏用与目标对象的 EditorToolAttribute 匹配的编辑器工具集合来填充。EndBuildTargetSelectionGrouping关闭以 BeginBuildTargetSelectionGrouping 开头的组。EndFadeGroup关闭由 BeginFadeGroup 开始的组。EndFoldoutHeaderGroup关闭以 BeginFoldoutHeaderGroup 开头的组。EndHorizontal闭合以 BeginHorizontal 开始的组。EndScrollView结束使用 BeginScrollView 调用开始的滚动视图。EndToggleGroup关闭由 BeginToggleGroup 开始的组。EndVertical闭合以 BeginVertical 开始的组。EnumFlagsField单击后，系统会为枚举类型的每个值显示带有选项的菜单。EnumPopup创建一个枚举弹出选择字段。FloatField生成一个用于输入浮点值的文本字段。Foldout创建一个左侧带有折叠箭头的标签。GetControlRect获取编辑器控件的矩形。GradientField创建一个用于编辑 Gradient 的字段。HelpBox创建一个带有发送给用户的消息的帮助框。InspectorTitlebar创建一个类似于 Inspector 窗口的标题栏。IntField创建一个用于输入整数的文本字段。IntPopup创建一个整数弹出选择字段。IntSlider创建一个滑动条，用户可以进行拖动以在最小值和最大值之间更改整数值。LabelField生成一个标签字段。（用于显示只读信息。）LayerField创建一个层选择字段。LinkButtonMake a clickable link label.LongField创建一个用于输入长整数的文本字段。MaskField创建一个适用于掩码的字段。MinMaxSlider创建一个特殊滑动条，用户可利用该滑动条指定最小值和最大值之间的一个范围。ObjectField生成一个可接收任何对象类型的字段。PasswordField创建一个可让用户输入密码的文本字段。Popup创建一个通用弹出选择字段。PrefixLabel创建一个显示在特定控件前的标签。PropertyField为 SerializedProperty 生成一个字段。RectField创建用于输入 Rect 的 X、Y、W 和 H 字段。RectIntField创建用于输入 RectInt 的 X、Y、W 和 H 字段。SelectableLabel生成一个可选择标签字段。（用于显示可复制粘贴的只读信息。）Slider创建一个滑动条，用户可以进行拖动以在最小值和最大值之间更改值。Space在上一个控件和下一个控件之间留出一个小空间。TagField创建一个标签选择字段。TextArea创建一个文本区域。TextField创建一个文本字段。Toggle创建一个开关。ToggleLeft创建一个开关字段，其中开关位于左侧，标签紧随其右。ToolContextToolbar使用指定的编辑器工具上下文集合填充工具栏。ToolContextToolbarForTarget使用与目标对象的 EditorToolContextAttribute.targetType 匹配的 EditorToolContextVector2Field创建用于输入 Vector2 的 X 和 Y 字段。Vector2IntField创建用于输入 Vector2Int 的 X 和 Y 整数字段。Vector3Field创建用于输入 Vector3 的 X、Y 和 Z 字段。Vector3IntField创建用于输入 Vector3Int 的 X、Y 和 Z 整数字段。Vector4Field创建用于输入 Vector4 的 X、Y、Z 和 W 字段。

3. 功能

3.1 折叠菜单： Foldout

Foldout：创建一个左侧带有折叠箭头的标签。bool 用户选择的折叠状态。如果为 true，则应渲染子对象。这适用于创建树或文件夹之类的结构，其中子对象仅在父项展开时显示。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{publicbool showPosition =true;publicstring status ="Select a GameObject";[MenuItem("Examples/Foldout Usage")]staticvoidInit(){UnityEditor.EditorWindow window =GetWindow(typeof(EditorGUIExample));
        window.position =newRect(0,0,150,60);
        window.Show();}voidOnGUI(){
        showPosition = EditorGUILayout.Foldout(showPosition, status);if(showPosition)if(Selection.activeTransform){
                Selection.activeTransform.position = EditorGUI.Vector3Field(newRect(3,25, position.width -6,40),"Position", Selection.activeTransform.position);
                status = Selection.activeTransform.name;}if(!Selection.activeTransform){
            status ="Select a GameObject";
            showPosition =false;}}voidOnInspectorUpdate(){Repaint();}}

3.2 折叠组： FoldoutGroup

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

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{privatebool foldOut;[MenuItem("Window/BeginFoldoutHeaderGroup")]staticvoidInit(){var example =(EditorGUIExample)EditorWindow.GetWindow(typeof(EditorGUIExample));
        example.Show();}voidOnGUI(){
        foldOut = EditorGUILayout.BeginFoldoutHeaderGroup(foldOut,"折叠栏组");if(foldOut)//只有foldout为true时，才会显示下方内容，相当于“折叠”了。{
            EditorGUILayout.LabelField("这是折叠标签内容");}
        EditorGUILayout.EndFoldoutHeaderGroup();//只不过这种折叠需要成对使用，不然会有BUG}}

3.4 下拉菜单：DropdownButton

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

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/TestOnGUI")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}bool _foldoutValue;publicvoidOnGUI(){
        _foldoutValue = EditorGUI.Foldout(newRect(0,0,20,20), _foldoutValue,"折叠");if(_foldoutValue){if(EditorGUI.DropdownButton(newRect(0,20,200,40),newGUIContent("下拉菜单"), FocusType.Keyboard)){GenericMenu genericMenu =newGenericMenu();
                genericMenu.AddItem(newGUIContent("One"),false,()=>{ Debug.Log("回调函数");});
                genericMenu.AddSeparator(string.Empty);//分割线
                genericMenu.AddItem(newGUIContent("Two"),false,()=>{});
                genericMenu.AddItem(newGUIContent("There"),false,()=>{});
                genericMenu.DropDown(newRect(0,20,20,20));}}}}

3.5 超链接：LinkButton

LinkButton ：超链接按钮。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/TestOnGUI")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}publicvoidOnGUI(){if(EditorGUILayout.LinkButton("超链接")){
            Application.OpenURL("www.baidu.com");}}}

3.6 颜色字段：ColorField

ColorField ：创建一个用于选择 Color 的字段。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/TestOnGUI")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}Color _colorFiled;publicvoidOnGUI(){
        _colorFiled = EditorGUILayout.ColorField(_colorFiled);}}

3.7 边界盒字段：BoundsField 、BoundsIntField

BoundsField ：创建用于输入 Bounds 的 Center 和 Extents 字段。
BoundsIntField ：创建用于输入 BoundsInt 的 Position 和 Size 字段。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/TestOnGUI")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}Bounds _boundsFiledValue;BoundsInt _boundsIntFiledValue;publicvoidOnGUI(){
         _boundsFiledValue = EditorGUILayout.BoundsField(_boundsFiledValue);
  _boundsIntFiledValue = EditorGUILayout.BoundsIntField(_boundsIntFiledValue);}}

3.8 动画曲线面板：CurveField

CurveField ：生成一个用于编辑 AnimationCurve 的字段。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/TestOnGUI")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}privateAnimationCurve _animationCurveValue =newAnimationCurve();publicvoidOnGUI(){
        _animationCurveValue = EditorGUILayout.CurveField(_animationCurveValue);}}

3.9 渐变：GradientField

GradientField ：创建一个用于编辑 Gradient 的字段。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{Gradient gradient =newGradient();[MenuItem("Examples/Gradient Field demo")]staticvoidInit(){EditorWindow window =GetWindow(typeof(EditorGUIExample));
        window.position =newRect(0,0,400,199);
        window.Show();}voidOnGUI(){
         gradient = EditorGUILayout.GradientField("Gradient", gradient);}}

3.10 对象选择器：ObjectField

ObjectField ：创建一个对象字段。您可以通过拖放对象或使用对象选择器选择对象来分配对象。当对象引用作为资源的一部分进行存储时，请确保 allowSceneObjects 参数为 false，因为资源无法存储对场景中对象的引用。如果 ObjectField 是脚本组件的自定义编辑器的一部分，请使用 EditorUtility.IsPersistent() 检查该组件是位于资源还是场景对象中。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{[MenuItem("Tool/ObjectField")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}privateSprite _objectFieldValue;publicvoidOnGUI(){
        _objectFieldValue =(Sprite)EditorGUILayout.ObjectField(_objectFieldValue,typeof(Sprite),true);}}

3.11 双精度浮点数字段：DoubleField、DelayedDoubleField

DoubleField ：生成一个用于输入双精度浮点数的文本字段。
DelayedDoubleField ：创建一个用于输入双精度浮点数的延迟文本字段。与DoubleField 类似，但在用户按 Enter 键或将焦点从双精度浮点数字段移开之前，不会返回新值。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{double value1 =0F;double value2 =0F;[MenuItem("Tool/DoubleField")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}publicvoidOnGUI(){
        value1 = EditorGUILayout.DoubleField(value1);
        value2 = EditorGUILayout.DelayedDoubleField(value2);}}

3.12 多维字段：RectField、RectIntField、Vector2Field、Vector2IntField、Vector3Field、Vector3IntField、Vector4Field

RectField ：创建用于输入 Rect 的 X、Y、W 和 H 字段。
RectIntField ：创建用于输入 RectInt 的 X、Y、W 和 H 字段。
Vector2Field ：创建用于输入 Vector2 的 X 和 Y 字段。
Vector2IntField ：创建用于输入 Vector2Int 的 X 和 Y 整数字段。
Vector3Field ：创建用于输入 Vector3 的 X、Y 和 Z 字段。
Vector3IntField ：创建用于输入 Vector3Int 的 X、Y 和 Z 整数字段。
Vector4Field ：创建用于输入 Vector4 的 X、Y、Z 和 W 字段。

RectField:

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{Camera[] cameras;[MenuItem("Tool/DoubleField")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}voidOnGUI(){if(GUI.Button(newRect(3,3, position.width -6,20),"Update list"))
            cameras =FindObjectsOfType<Camera>();if(cameras.Length >0){for(var i =0; i < cameras.Length; i++){
                 cameras[i].rect = EditorGUILayout.RectField(
     cameras[i].name,
     cameras[i].rect);}}}}

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{Vector2 v2;Vector2Int v2Int;Vector3 v3;Vector3Int v3Int;Vector4 v4Int;[MenuItem("Tool/DoubleField")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}voidOnGUI(){
         v2 = EditorGUILayout.Vector2Field("Vector2Field", v2);
  v2Int = EditorGUILayout.Vector2IntField("Vector2IntField", v2Int);

  v3 = EditorGUILayout.Vector2Field("Vector3Field", v3);
  v3Int = EditorGUILayout.Vector3IntField("Vector3IntField", v3Int);

  v4Int = EditorGUILayout.Vector4Field("Vector4Field", v4Int);}}

3.13 切换框：Toggle、ToggleLeft

Toggle ：创建一个开关。
ToggleLeft ：创建一个开关字段，其中开关位于左侧，标签紧随其右。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{bool showClose =true;[MenuItem("Tool/Toggle")]privatestaticvoidOpenGUIExample(){GetWindow<EditorGUIExample>().Show();}voidOnGUI(){
        showClose = EditorGUILayout.Toggle("Show Close Button", showClose);

 showClose = EditorGUILayout.ToggleLeft("Show Close Button", showClose);}}

3.14 选择标签：TagField、LayerField

TagField ：创建一个标签选择字段。
LayerField ：创建一个层选择字段。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{string selectedTag ="";int selectedLayer =0;[MenuItem("Examples/Field")]staticvoidInit(){EditorWindow window =GetWindow<EditorGUIExample>();
        window.position =newRect(0,0,350,70);
        window.Show();}voidOnGUI(){
       selectedTag = EditorGUILayout.TagField("TagField:", selectedTag);
 selectedLayer = EditorGUILayout.LayerField("LayerField:", selectedLayer);}voidOnInspectorUpdate(){Repaint();}}

3.15 滑动条：Slider、MinMaxSlider

Slider ：创建一个滑动条，用户可以进行拖动以在最小值和最大值之间更改值。
MinMaxSlider ：创建一个特殊滑动条，用户可利用该滑动条指定最小值和最大值之间的一个范围。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{float scale =1.0f;float minVal =-10;float minLimit =-20;float maxVal =10;float maxLimit =20;[MenuItem("Examples/Slider")]staticvoidInit(){EditorWindow window =GetWindow<EditorGUIExample>();
        window.position =newRect(0,0,350,70);
        window.Show();}voidOnGUI(){
         scale = EditorGUILayout.Slider(scale,1,100);
 EditorGUILayout.MinMaxSlider(newGUIContent("Random range:"),ref minVal,ref maxVal,
     minLimit, maxLimit);}}

3.16 间隔：Space

Space ：在上一个控件和下一个控件之间留出一个小空间。

EditorGUILayout.LabelField("----上面的Label----");
EditorGUILayout.Space(10);//进行10个单位的间隔
EditorGUILayout.LabelField("----下面的Label----");

3.17 帮助框：HelpBox

HelpBox ：创建一个带有发送给用户的消息的帮助框。

EditorGUILayout.HelpBox("一般提示，你应该这样做...", MessageType.Info);
EditorGUILayout.HelpBox("警告提示，你可能需要这样做...", MessageType.Warning);
EditorGUILayout.HelpBox("错误提示，你不能这样做...", MessageType.Error);

在这里插入图片描述

3.18 Inspector标题栏：InspectorTitlebar

InspectorTitlebar ：创建一个类似于 Inspector 窗口的标题栏。

usingUnityEditor;usingUnityEngine;publicclassEditorGUIExample:EditorWindow{bool showing =true;[MenuItem("Examples/InspectorTitlebar")]staticvoidInit(){EditorWindow window =GetWindow<EditorGUIExample>();
        window.position =newRect(0,0,350,70);
        window.Show();}voidOnGUI(){var currObj = Selection.activeTransform;
 showing = EditorGUILayout.InspectorTitlebar(showing, currObj, showing);}}