Unity自定义数组在Inspector窗口的显示方式

已于 2024-10-29 13:52:52 修改
阅读量1.1k 收藏 4
点赞数 7
文章标签： unity 游戏引擎
于 2024-10-29 11:38:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43796392/article/details/143320943
版权

了解

  1. 单行高度:EditorGUIUtility.singleLineHeight
  2. 获取 PropertyField 控件所需的高度:EditorGUI.GetPropertyHeight
  3. 属性是否在Inspector窗口展开：SerializedProperty.isExpanded
  4. 可重新排序列表类：ReorderableList
  5. 绘制纯色矩形：EditorGUI.DrawRect

示例

使用版本：2021.3.6f1c1
此版本的Unity已经实现数组元素添加，移除，移动功能。

自定义类

[System.Serializable]
public class Test 
{
    public string name;
    public int age;
}

数据类

定义一个数组，数组元素为自定义类

using System.Collections.Generic;
using UnityEngine;
[CreateAssetMenu]
public class TestSO : ScriptableObject
{
    public List<Test> testList;
}

数据类文件默认显示如下

在这里插入图片描述

修改数据类显示

数据元素内容显示为一行

注意：不能使用自动布局api

using UnityEngine;
using UnityEditor;
[CustomPropertyDrawer(typeof(Test))]
public class TestDrawer : PropertyDrawer
{
    public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
    {
        var spName = property.FindPropertyRelative("name");
        var spAge = property.FindPropertyRelative("age");

        var rect1 = position;
        var rect2 = position;

        var indentlevel = EditorGUI.indentLevel;
        var lableWidth = EditorGUIUtility.labelWidth;
        EditorGUI.indentLevel = 2;
        EditorGUIUtility.labelWidth = 60;

        rect1.width = position.width / 2;
        rect1.height = EditorGUIUtility.singleLineHeight;

        rect2.width = position.width / 2;
        rect2.height = EditorGUIUtility.singleLineHeight;

        rect2.x = position.width / 2+40;
        rect2.y = rect1.y;

        EditorGUI.PropertyField(rect1, spName, new GUIContent("名字"));
        EditorGUI.PropertyField(rect2, spAge, new GUIContent("年龄"));

        EditorGUI.indentLevel = indentlevel;
        EditorGUIUtility.labelWidth = lableWidth;

        //EditorGUI.DrawRect(rect1, Color.green);
        //EditorGUI.DrawRect(rect2, Color.gray);
    }

	//获取属性高度
    public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
    {
        return base.GetPropertyHeight(property, label);
    }
}

修改后显示效果如下图所示
在这里插入图片描述

TestList修改为指定名称；Element修改为指定名称

using UnityEngine;
using UnityEditor;
using UnityEditorInternal;
[CustomEditor(typeof(TestSO))]
public class TestSOEditor : Editor
{
    SerializedProperty sPTestList;
    ReorderableList arrayList;

    private void OnEnable()
    {
        sPTestList = serializedObject.FindProperty("testList");

        if (arrayList == null)
        {
            arrayList = new ReorderableList(serializedObject, sPTestList, true, true, true, true);    
            //绘制Header
            arrayList.drawHeaderCallback += DrawHeader;
            //绘制数组元素
            arrayList.drawElementCallback += DrawElement;
            //获取数组的高度
            arrayList.elementHeightCallback += DrawElementHeight;
        }
    }

    void DrawHeader(Rect rect)
    {
        EditorGUI.LabelField(rect, "测试列表");
    }

    void DrawElement(Rect rect, int index, bool isActive, bool isFocused)
    {
        var element = sPTestList.GetArrayElementAtIndex(index);
        var arrowRect = rect;

        int indentLevel = EditorGUI.indentLevel;
        EditorGUI.indentLevel = 1;
        arrowRect.height = EditorGUIUtility.singleLineHeight;
        element.isExpanded = EditorGUI.Foldout(arrowRect, element.isExpanded, new GUIContent("元素" + index));
        EditorGUI.indentLevel = indentLevel;

        //EditorGUI.DrawRect(rect, Color.red);
        //EditorGUI.DrawRect(arrowRect, Color.blue);

        if (element.isExpanded)
        {
            rect.y += arrowRect.height;
            EditorGUI.PropertyField(rect, element);
        }
    }

    float DrawElementHeight(int index)
    {
        var element = sPTestList.GetArrayElementAtIndex(index);
        var height = EditorGUIUtility.singleLineHeight;//折叠箭头的高度   
        if (element.isExpanded)//如果元素展开 获取展开内容的高度和箭头的高度之和
            height += EditorGUI.GetPropertyHeight(element);
        return height;
    }

    public override void OnInspectorGUI()
    {
        serializedObject.Update();
        arrayList.DoLayoutList();
        serializedObject.ApplyModifiedProperties();
    }
}

修改后如下图所示
在这里插入图片描述

示例二

高度计算放在PropertyDrawer的OnGUI中

自定义类

显示折叠箭头，数据元素内容显示为一行，Element修改为指定名称

using UnityEngine;
using UnityEditor;
[CustomPropertyDrawer(typeof(Test))]
public class TestDrawer : PropertyDrawer
{
    public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
    {
        var spName = property.FindPropertyRelative("name");
        var spAge = property.FindPropertyRelative("age");

        var rect0 = position;
        rect0.height = EditorGUIUtility.singleLineHeight;

        var indentlevel = EditorGUI.indentLevel;
        EditorGUI.indentLevel = 1;
      
        property.isExpanded = EditorGUI.Foldout(rect0, property.isExpanded, label);
      
        EditorGUI.indentLevel = indentlevel;

        if (property.isExpanded)
        {
            var rect1 = position;
            var rect2 = position;

            indentlevel = EditorGUI.indentLevel;
            var lableWidth = EditorGUIUtility.labelWidth;
            EditorGUI.indentLevel = 2;
            EditorGUIUtility.labelWidth = 60;

            rect1.width = position.width / 2;
            rect1.height = EditorGUIUtility.singleLineHeight;
            rect1.y += EditorGUIUtility.singleLineHeight;

            rect2.width = position.width / 2;
            rect2.height = EditorGUIUtility.singleLineHeight;

            rect2.x = position.width / 2 + 40;
            rect2.y = rect1.y;

            EditorGUI.PropertyField(rect1, spName, new GUIContent("名字"));
            EditorGUI.PropertyField(rect2, spAge, new GUIContent("年龄"));

            EditorGUI.indentLevel = indentlevel;
            EditorGUIUtility.labelWidth = lableWidth;
            //EditorGUI.DrawRect(rect1, Color.green);
            //EditorGUI.DrawRect(rect2, Color.gray);
        }
    }

    public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
    {
        if (property.isExpanded)
            return EditorGUIUtility.singleLineHeight * 2;
        else
            return EditorGUIUtility.singleLineHeight;
    }
}

数据类

TestList修改为指定名称

using UnityEngine;
using UnityEditor;
using UnityEditorInternal;
[CustomEditor(typeof(TestSO))]
public class TestSOEditor : Editor
{
    SerializedProperty sPTestList;
    ReorderableList arrayList;

    private void OnEnable()
    {
        sPTestList = serializedObject.FindProperty("testList");
        if (arrayList == null)
        {
            arrayList = new ReorderableList(serializedObject, sPTestList, true, true, true, true);
            //绘制Header
            arrayList.drawHeaderCallback += DrawHeader;
            //绘制数组元素
            arrayList.drawElementCallback += DrawElement;
            //绘制元素高度
            arrayList.elementHeightCallback += DrawHeight;

            void DrawHeader(Rect rect)
            {
                EditorGUI.LabelField(rect, "测试列表");
            }

            void DrawElement(Rect rect, int index, bool isActive, bool isFocused)
            {
            	//参数会传递给PropertyDrawer的OnGUI 
                EditorGUI.PropertyField(rect, sPTestList.GetArrayElementAtIndex(index), new GUIContent("元素 " + index));
            }

            float DrawHeight(int index)
            {
                return EditorGUI.GetPropertyHeight(sPTestList.GetArrayElementAtIndex(index));
            }
        }
    }

    public override void OnInspectorGUI()
    {
        serializedObject.Update();
        arrayList.DoLayoutList();
        serializedObject.ApplyModifiedProperties();
    }
}

参考

看完后理解列表的高度如何计算

心前阳光
关注
Unity自定义脚本布局显示在Inspector面板上
qq_53580817的博客
01-16 756
EditorGUILayout 是Unity提供的一组用于在Inspector面板中创建GUI元素的方法。以下是一些常用的EditorGUILayout布局：
【Unity】在Unity的Inspector面板里显示按钮，并实现功能
UnityCC0526的博客
01-18 1865
【Unity】在Unity的Inspector面板里显示按钮，并实现功能
【无标题】
最新发布
qq_17026475的博客
03-10 338
将list显示在unity的inspector面板上，只要给类加上[System.Serializable]就好了。[Header(“震动的持续时间”)]//[Header(“开始震动的时间”)]//[Header(“震动的强度”)] //[Header(“震动的平滑度”)]//
Unity中在Inspector窗口使用按钮调试方法
洛苍离的博客
10-24 875
使用Unity原生的Attribute特性和自定义Editor代码，在Inspector窗口绘制调试方法的按钮
笔记：unity在inspector面板显示自定义类数组
Dore__的博客
09-03 2335
[Serializable] public class PosInfo{ public Vector3 targetPos, targetRotate; } public class Test : MonoBehaviour { public List<PosInfo> targetPos; }
Unity小技巧——Inspector中插入数组元素
UnityAsk
07-16 3793
选中其中一个元素，CTRL+D复制，然后修改它的值，相当于插入了一个新元素。这样不用为了插入一个元素，而需要顺次修改后面所有原素的值。
Unity 双层数组或字典可在Inspector面板中进行修改添加
sinat_24629665的博客
08-30 443
就可以在面板上直接添加对应的物体了。
在检视器Inspector中通过自定义属性实现显示中文名称
m0_69630773的博客
06-18 785
之前的代码是只能判断emum[]，而不能判断List<enum>，让我挺恼火的，折腾了半天总算是解决了，因此发出来，希望以后如果有人也遇到这个问题时可以提供一点帮助。然后，我们在\Editor下面创建另一个类CustomLabelDrawer (具体绘制时执行用的类)如果存在一些折叠的变量（集合等）会导致布局错乱，所以我抄了一个大佬的作品来优化了一下布局的高度。首先，在\Scripts下创建一个类CustomLabelAttribute。在前人的基础上，整出来了一些完善一些的版本。
Unity自定义Preview窗口的方法
qq_27275225的博客
08-21 1883
如名字所描述的一样，这两个函数都是绘制这个PreviewGUI的函数，OnInteractivePreviewGUI（）就是可以允许用户进行交互的那种，比如滑动鼠标滚轮进行缩放，拖拽物体旋转，等等，一般3d模型展示常有这种效果，如果是有这样的需求的话，那么就必须使用OnInteractivePreviewGUI()来进行复写，如果是只是静态显示一些信息，那么用OnPreviewGUI就够了。想要在这里显示一个东西，需要在这个空间里新建物体，然后新建摄像机，对准物体渲染，然后把得到的图片取出。
unity中链接字符串和变量显示_Unity编辑器环境在Inspector面板中显示变量
weixin_39629969的博客
01-17 1015
Serialize功能Unity3D 中提供了非常方便的功能可以帮助用户将 成员变量 在Inspector中显示，并且定义Serialize关系。简单的说，在没有自定义Inspector的情况下所有显示在Inspector 中的属性都同时具有Serialize功能。换句话说，就是你在Inspector看到什么，保存游戏的时候，这些值就会被保存成二进制文件。本文说说可被Serialize的变量的定义...
unity3d Inspector扩展插件
04-07
FullInspector
【Unity-Tool】特性扩展：条件控制Inspector属性显隐
manqi的博客
03-05 1795
特性扩展：条件控制Inspector属性显隐
在Inspector面板内显示自定义的类的数组
lilybeast的专栏
03-07 2386
想要在Inspector里显示自己的数组并且可以更改数组大小以及里面的数据。 如图 只要在自己定义的类前加上[System.Serializable ] 代码： using UnityEngine; using System.Collections; [System.Serializable ] public class te { int a; int b;
Unity编辑器多维数组展示
asdwzx142的博客
09-15 1027
using UnityEngine; using UnityEditor; public class DoubleDimensional: ScriptableWizard { [MenuItem("Tools/E_DoubleDimensional")] static void Start() { ScriptableWizard.DisplayWizard<DoubleDimensional>("Selection", "Create", "Appl.
[Unity, 笔记] 在 Inspector 中显示结构体, 结构体的序列化
诺尔的博客
08-31 1367
给结构体添加 System.Serializable 特性就可以让结构体显示在 Inspector 中了
Unity 使用注解通用设置Inspector窗口的显示内容
qq_53759768的博客
06-25 648
与网上常见的需要针对每个类单独设置的情况不同，此版本更加通用，但对应更大的开销。
unity中Inspector面板常用
a1164307228的博客
11-07 605
12.[RequireComponent(typeof (BoxCollider))] 添加该脚本时必然添加括号内脚本内容 作者：unity_某某师_高锦锦 https://www.bilibili.com/read/cv17522303/ 出处：bilibili。6.1.[Tooltip（“在此添加一个被执行的物体如 门 /水龙头等”）]3.非要让public的不显示在"[HideInInspector]"6.2.[Space] 换行 [Space(50)]10.Preset 预设值内容。
Unity中如何在Inspector里更改属性
03-08
### 如何在 Unity Inspector 中编辑和更改属性 #### 自定义 Inspector 基础设置 为了能够在 Unity 的 Inspector 窗口中修改对象属性，通常会创建自定义的 `Editor` 类继承于 `UnityEditor.Editor` 并重写特定的方法。对于希望保留原有 GUI 绘制逻辑的同时添加额外功能的情况，可以通过调用 `m_Editor.OnInspectorGUI()` 来确保原始布局不被破坏[^1]。 #### 使用 SerializedProperty 进行安全访问 当涉及到具体属性的操作时，推荐利用 `SerializedProperty` 对象而非直接操作组件中的成员变量。这不仅提供了更安全的方式去读取或更新数据，而且还能更好地支持 Undo/Redo 功能以及 Prefab 实例化后的同步机制[^2]。 ```csharp using UnityEngine; using UnityEditor; [CustomEditor(typeof(MyComponent))] public class MyComponentEditor : Editor { public override void OnInspectorGUI() { DrawDefaultInspector(); var myProp = serializedObject.FindProperty("myField"); EditorGUILayout.PropertyField(myProp); serializedObject.ApplyModifiedProperties(); } } ``` #### 属性标签本地化处理 针对那些需要展示给用户的界面文字（比如字段名称），可以采用自定义特性的方式来实现在不影响代码内部命名的前提下对外呈现不同的描述信息。例如，通过 `[DisplayNameAttribute]` 或者其他类似的解决方案可以在保持 C# 变量名为英文的情况下，在 Inspector 上显示对应的中文说明[^3]。 #### 处理复杂类型的可视化调整 面对诸如数组、列表这样的复合型数据结构，默认情况下它们可能会以一种不太直观的形式展现出来。此时可考虑覆写 `GetPropertyHeight` 方法来自适应地控制这些元素所占用的空间大小，从而改善用户体验并防止潜在的 UI 排列问题发生[^4]。 #### 数据持久性和运行时一致性维护 最后需要注意的是，某些时候即使是在编辑状态下成功改变了某个私有字段的内容，但在进入 Play Mode 后却发现其并未生效。为了避免这种情况的发生，应当适时调用 `EditorUtility.SetDirty(object)` 函数标记目标实例已发生变化；另外也可以尝试将原本受保护级别的域声明为公共可见或是附加 `[SerializeField]` 特性以便让引擎能够正常保存改动过的数值[^5]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值