【狂云歌之unity_vr】开发unity插件——一次搞定unity编辑器常用功能

ゞ浴缸里的玫瑰 2022-07-13 14:51 288阅读 0赞

# 【狂云歌之unity\_vr】开发unity插件——一次搞定unity编辑器常用功能 #

![unity][]

这篇文章主要分享unity中与editor插件等相关的使用，比较基础，不过如果都掌握了就可以扩展写一些unity插件了，平时开发中也会提升工作效率。

editor相关脚本一定要放在Editor文件夹下，继承monobehaviour的文件不要放到Editor文件夹下。

## monobehaviour相关的编辑器功能 ##

首先常用的在继承monobehaviour类中写public变量可以在inspector中序列化可编辑一般人都知道了，下面是一些可以更有效率更酷的方法。

### 增强序列化属性 ###

public bool isGood = false;
    
    [Tooltip("hp")]//鼠标hover的时候显示一个tooltip
    public int life = 0;
    
    [Range(0f, 1f)]//float slider
    public float CloudRange = 0.5f;
    
    [Range(0, 15)]//int slider
    public int CloudRangeInt = 1;
    
    [Header("OtherAttr")]//可以将属性隔离开，形成分组的感觉
    public float CloudHeader = 1f;
    
    [Space(30)]//可以与上面形成一个空隙
    public float CloudSpace = 1f;
    
    [HideInInspector]//使属性在inspector中隐藏，但是还是可序列化，想赋值可以通过写程序赋值序列化
    public float CloudHideInInspector = 1f;
    
    [NonSerialized]//使public属性不能序列化
    public float CloudNonSerialized = 1f;
    
    [SerializeField]//使private属性可以被序列化，在面板上显示并且可以读取保存
    private bool CloudSerializeField = true;

效果如下图，对于一些有范围的数值可以用range做个slider让策划来调节，可以用header和space来组织面板的外观，也可以针对不同的属性进行是否序列化的选择。

![serialize][]

### 序列化类 ###

也可以序列化一个类

[Serializable]//一个可序列化的类
    public class SerializableClass {
        public int x = 0;
        public Vector2 pos;
        public Color color;
        public Sprite sprite;
    }
    public SerializableClass serializedObject;//一个可序列化的类的实例

![serializedObject][]

### 组件面板的上下文菜单 ###

有时在monobehaviour中写一些方法可以初始化一些值或者随机产生某个值这种需求，都可以在菜单中触发，只要简单的加一行即可。

[ContextMenu("Init")]//可以在组件的右键菜单及设置（那个小齿轮按钮）菜单看到，
    void Init()
    {
        isGood = false;
        life = 0;
    }
    
    [ContextMenu("Random value")]
    void RandomValue()
    {
        Debug.Log("TestContextMenu " + gameObject.name);
        isGood = true;
        life = UnityEngine.Random.Range(1, 100);
    }

效果如下图，点击init就会赋一个初始的值，点击randomvalue可以随机产生一个life的值，这就是最简单的editor工具了

![contextmenu][]

## inspector相关的编辑器功能 ##

如果要在inspector中加上一些更高级的功能就需要使用editor相关的方法了

这是要使用的TestInspector类代码

[CustomEditor(typeof(TestInspector))]
    public class CloudTools : Editor {
        #region inspector
        TestInspector script;//所对应的脚本对象
        GameObject rootObject;//脚本的GameObject
        SerializedObject seriObject;//所对应的序列化对象
        SerializedProperty headColor;//一个[SerializeField][HideInInspector]且private的序列化的属性
        private static bool toggle = true;//toggle按钮的状态
    
        //初始化
        public void OnEnable()
        {
            seriObject = base.serializedObject;
            headColor = seriObject.FindProperty("headColor");
            var tscript = (TestInspector)(base.serializedObject.targetObject);
            if (tscript != null)
            {
                script = tscript;
                rootObject = script.gameObject;
            }else
            {
                Console.Error.WriteLine("tscript is null");
            }
        }
    
        //清理
        public void OnDisable()
        {
            var tscript = (TestInspector)(base.serializedObject.targetObject);
            if (tscript == null)
            {
                // 这种情况是脚本对象被移除了;  
                Debug.Log("tscript == null");
            }
            else
            {
                // 这种情况是编译脚本导致的重刷;  
                Debug.Log("tscript != null");
            }
            seriObject = null;
            script = null;
            rootObject = null;
        }
    
        public override void OnInspectorGUI()
        {
            base.OnInspectorGUI();
            seriObject.Update();
            //将target转化为脚本对象
            script = target as TestInspector;
            //random按钮  
            if (GUILayout.Button("RandomNum"))
            {
                //注册undo，可以在edit菜单里看到undo，也可以通过ctrl+z来回退
                Undo.RecordObject(script, "revert random num");
                script.RandomNum(script.num);
            }
    
            //save scene和toggle这组按钮
            GUILayout.BeginHorizontal();
            {
                if (GUILayout.Button("SaveScene"))
                {
                    EditorSceneManager.SaveCurrentModifiedScenesIfUserWantsTo();
                }
                if(GUILayout.Button(toggle ? "untoggle" : "toggle"))
                {
                    toggle = !toggle;
                }
            }
            GUILayout.EndHorizontal();
    
            script.isAlive = EditorGUILayout.BeginToggleGroup("isAlive", script.isAlive);
            if (script.isAlive)//如果isAlive不勾选则不显示life
            {
                script.life = EditorGUILayout.Slider("life", script.life, 0, 100f);
            }
            EditorGUILayout.EndToggleGroup();
    
            //可以显示TestInspector中序列化但是不在inspector中显示的属性
            EditorGUILayout.PropertyField(headColor);
            seriObject.ApplyModifiedProperties();
    
            //展示普通信息
            EditorGUILayout.LabelField("life " + script.life, GUILayout.Width(200));
            Repaint();
        }
    
        #endregion
    }

其中需要用OnEnable和OnDisable来做初始化和清理工作，OnInspectorGUI方法可以类比monobehaviour中的OnGUI，做ui渲染和ui事件处理。

里面还注册了UnDo，好处是可以通过ctrl+z来进行撤销操作，这样才更完美更像一个完善的unity插件。

代码也没什么难度，我也做了下简单的注释，执行一下看看效果大部分人就都理解了。效果如下图

![inspector][]

![inspector][inspector 1]

## 各种上下文菜单 ##

### 组件菜单 ###

之前可以在monobehaviour中加入`[ContextMenu("Random value")]`来生成对应脚本组件面板的上下文菜单，那么如果要生成一个在transform组件上的菜单怎么办

[MenuItem("CONTEXT/Transform/RandomPosition")]
    static void ContextMenu_TransformRandomPosition()//随机改变transform组件的position
    {
        Debug.Log("ContextMenu_Transform");
        Transform[] transforms = Selection.GetTransforms(SelectionMode.TopLevel | SelectionMode.OnlyUserModifiable);
        foreach (Transform transform in transforms)
        {
            transform.localPosition = new Vector3(UnityEngine.Random.Range(-10, 10),
                UnityEngine.Random.Range(-10, 10),
                UnityEngine.Random.Range(-10, 10));
            Debug.Log(transform.localPosition);
        }
    }

效果如下图，如果策划或者美术需要对transform的position干这种随机的事，是不是就可以这么搞了？或者对collider、rigibody之类的组件加上一些属性模板的设置，会很方便吧

![TransformMenu][]

### 带勾选的菜单 ###

在editor中加个菜单item是件很容易的事情，那么如果这个菜单是可以勾选的呢？是不是可以解决一些开关的问题？

const string Menu_Checked = "Cloud/MenuChecked";//checked menu的名字
    const string Key_MenuChecked = "MenuChecked";//checked menu状态存储的key
    
    [MenuItem(Menu_Checked)]
    static void MenuChecked()
    {
        bool flag = Menu.GetChecked(Menu_Checked);
        if (flag)
        {
            Debug.Log("Key_MenuChecked to 0");
            PlayerPrefs.SetInt(Key_MenuChecked, 0);//通过存储0和1来判断是否check menu
        }
        else
        {
            Debug.Log("Key_MenuChecked to 1");
            PlayerPrefs.SetInt(Key_MenuChecked, 1);
        }
        Menu.SetChecked(Menu_Checked, !flag);
    }
    
    [MenuItem(Menu_Checked, true)]//判断menu是否check的函数
    public static bool IsMenuChecked()
    {
        Menu.SetChecked(Menu_Checked, PlayerPrefs.GetInt(Key_MenuChecked, 0) == 1);
        return true;
    }

效果如下图，其中需要一个菜单的valid函数来判断菜单是否在勾选状态，这里用了playprefs，在windows上就写到注册表里了

![checkedmenu][]

### project面板中的菜单 ###

这个菜单是加到了Assets下面，那么在project面板中右键也可以看到，这种菜单可以干什么呢，我也没想好，不过干些修改assetsimport属性或者修改一些资源等等还是挺好用的吧

[MenuItem("Assets/TestAssets")]
    static void MenuAssets()
    {
        if(Selection.activeObject == null)
        {
            Debug.Log("TestAssets choose null");
        }
        else
        {
            Debug.Log("TestAssets name = " + Selection.activeObject.name);
        }
    
    }

一般这种菜单都可以通过`Selection.activeObject/activeGameObject`等等来获取选中对象，当然也可以获取多选的多个对象，这个看下api就知道了

![AssetsMenu][]

![AssetsMenu][AssetsMenu 1]

### hierarchy面板菜单 ###

这个菜单还是比较实用的，相对来说也不太一样

[MenuItem("GameObject/Create Other/TestGameObject")]//将菜单放到GameObject菜单中，可以在hierarchy中看到
    static void MenuGameObject()
    {
        Debug.Log("TestGameObject");
    }

将菜单加到GameObject下面，就可以在hierarchy里右键看到了

![GameObjectMenu][]

那么基于这个菜单我们可以做个比较实用的功能，例如右键hierarchy中场景的一个GameObject并且对它进行SetActive为true or false的操作，代码如下：

//快捷键可以为%=ctrl/cmd #=shift &=alt LEFT/RIGHT/UP/DOWN F1-F12,HOME END PGUP PGDN _a~_z
    [MenuItem("GameObject/SetActive _a", false, 11)] //11及以后可以在Camera之后显示
    static void MenuGameObjectSetActive()//通过按a键来设置所选择GameObject的active状态
    {
        Debug.Log("MenuGameObjectSetActive");
        if(Selection.activeGameObject != null)
        {
            Undo.RecordObject(Selection.activeGameObject, "SetActive" + Selection.activeGameObject.activeSelf + " " + Selection.activeGameObject.name);
            Selection.activeGameObject.SetActive(!Selection.activeGameObject.activeSelf);//就算锁定了inpector,也是处理当前选中的
        }
        Debug.Log(Selection.activeObject.name);
    }
    
    [MenuItem("GameObject/SetActive", true, 11)]
    static bool CheckIsGameObject()//判断是否显示该菜单的校验方法，如果没选择GameObject为灰
    {
        UnityEngine.Object selectedObject = Selection.activeObject;
        if(selectedObject != null && selectedObject.GetType() == typeof(GameObject))
        {
            Debug.Log(selectedObject.name);
            return true;
        }
        return false;
    }

其中做校验的方法是为了在不选中GameObject的时候能够将菜单灰掉。另外这种菜单可以绑定一个快捷键，这个例子是绑定了a键，菜单中也可以看出来。

最终效果就成了：我选中一个GameObject，只要按下a键就可以SetActive(false)，再按下变成true，还是比较实用的吧，基于此可以做很多实用的东西。效果如下图

![SetActiveMenu][]

![SetActiveMenu][SetActiveMenu 1]

## 对话框 ##

对话框比较简单，就是一些内置的api，具体可以查看api，支持了例如简单和复杂对话框、打开保存文件对话框、进度条等等功能

`EditorUtility.DisplayCancelableProgressBar("ok", "done", 0.7f)`  
`EditorUtility.ClearProgressBar();`  
`EditorUtility.OpenFilePanel("open", "d:/", ".txt");`

![progress][]

![Dialog][]

## 新窗口 ##

如果要做的事情可能不是与某个GameObject相关，inspector不能满足要求，那么可以创建一个新的窗口，创建新的editor窗口需要继承EditorWindow，代码如下

[CustomEditor(typeof(CloudWindow))]
    public class CloudWindow : EditorWindow {
    
        #region 对话框
        //通过MenuItem按钮来创建这样的一个对话框  
        [MenuItem("Cloud/ShowEditorTestPanel")]
        public static void ConfigDialog()
        {
            EditorWindow.GetWindow(typeof(CloudWindow));
        }
    
        public UnityEngine.Object go = null;
        string goName= "default";
        float life = 100f;
        bool isAlive = true;
        bool toggleEnabled;
        void OnGUI()
        {
            //Label  
            GUILayout.Label("Label Test", EditorStyles.boldLabel);
            //通过EditorGUILayout.ObjectField可以接受Object类型的参数进行相关操作  
            go = EditorGUILayout.ObjectField(go, typeof(UnityEngine.Object), true);
            //Button  
            if (GUILayout.Button("Button Test"))
            {
                if (go == null)
                {
                    Debug.Log("go == null");
                }
                else
                {
                    Debug.Log(go.name);
                }
            }
            goName = EditorGUILayout.TextField("textfield", goName);
    
            toggleEnabled = EditorGUILayout.BeginToggleGroup("optional settings", toggleEnabled);
            if (toggleEnabled)
            {
                isAlive = EditorGUILayout.Toggle("isalive", isAlive);
                life = EditorGUILayout.Slider("life", life, 0, 100);
            }
            EditorGUILayout.EndToggleGroup();
        }
    
    
        #endregion
    
    }

好像代码也不复杂，也没什么难度就是常见的ui绘制，效果如下：

![newwindow][]

![newwindow][newwindow 1]

## 后续 ##

如果有更高的需求可能需要更深入的研究一下unity中editor的相关api和文档

unity还提供了可以在scene窗口中做一些操作，例如画一些辅助线、显示label、操作handler等，具体可以参考  
[http://blog.csdn.net/kun1234567/article/details/19421471][http_blog.csdn.net_kun1234567_article_details_19421471]

## 结语 ##

如果把这些代码执行一遍，改改调试一下，理解基本流程，那么已经可以写一些提高工作效率的unity插件了

> VR开发或者unity相关交流可以邮件madcloudsong@qq.com  
> 转载请注明原文链接  
> [http://blog.csdn.net/madcloudsong/article/details/54408103][http_blog.csdn.net_madcloudsong_article_details_54408103]

[unity]: /images/20220713/f9b930955ed4421d9c015f6956da407f.png
[serialize]: /images/20220713/7bce767113224b0e8a130fd8b5f305c1.png
[serializedObject]: /images/20220713/02119b0d27764342a3ae7666de2b1611.png
[contextmenu]: /images/20220713/cf804d4e9f8741d6ab62d63f243d3d3f.png
[inspector]: /images/20220713/d428b764e7ce4346ae38178b10b5a4db.png
[inspector 1]: /images/20220713/d513d09f1dd846b3b2943f72641fff2d.png
[TransformMenu]: /images/20220713/611eae325e6f44f1ac074a8f5dc39ff1.png
[checkedmenu]: /images/20220713/f299732859524333ac99a4d345309d8d.png
[AssetsMenu]: /images/20220713/a7ef8a51ac18405988120d51a28aeac1.png
[AssetsMenu 1]: /images/20220713/fed3e9baa2f54f9db7a3bc6c319c7174.png
[GameObjectMenu]: /images/20220713/8ac9cd2cb30a479c8bfcde21220460fa.png
[SetActiveMenu]: /images/20220713/180d55911a204e48972904480a12d71f.png
[SetActiveMenu 1]: /images/20220713/8715882b1b87441a8fce4845b2c85355.png
[progress]: /images/20220713/d19c04f6eaa64c7c943790263f34d661.png
[Dialog]: /images/20220713/f1765bdeabf44891a5b07f9a0dc25cad.png
[newwindow]: /images/20220713/f4213cd33da6439ca642518d02c21460.png
[newwindow 1]: /images/20220713/278be031edda4d6bb417c71f7a27e497.png
[http_blog.csdn.net_kun1234567_article_details_19421471]: http://blog.csdn.net/kun1234567/article/details/19421471
[http_blog.csdn.net_madcloudsong_article_details_54408103]: http://blog.csdn.net/madcloudsong/article/details/54408103