更新日期:2025年1月23日。
Github源码:[点我获取源码]
Gitee源码:[点我获取源码]
索引
- 开发编辑器工具
- MouseRayTarget焦点视角
- Collider线框
- Assembly Viewer搜索程序集
- ILSpy反编译程序集
- 搜索GizmosElement类
- 找到Gizmos菜单
- 找到Gizmos窗口
- 分析AnnotationWindow类
- 开始编写工具
开发编辑器工具
本章我将借助Assembly Viewer
工具和ILSpy
工具,依靠反射开发一个Unity编辑器工具,此为快速开发编辑器工具的一个示例。
此工具的用途:一键隐藏/显示脚本的Gizmos
控件,还Scene
视图一个干净清爽。
MouseRayTarget焦点视角
最新的MouseRayTarget
组件新增了参数Look At Angle
,用于在自由视角模式下,摄像机焦点到此物体时所进入的视角参数:
该参数同时会借助Gizmos
控件功能,在Scene
视图模拟显示摄像机注视他时,可能处于的位置:
如果选中的物体多了(或者选中了根物体),这些Gizmos
控件就有点混乱了:
Collider线框
而且,MouseRayTarget
组件一般为了配合鼠标点击,都会同时挂载碰撞器Collider
组件,Collider
组件的线框也是干扰画面的最大元凶之一(在一些大场景里面尤其明显):
虽然我们可以在Scene
视图右上方的Gizmos菜单
里面找到并隐藏任意组件、脚本的Gizmos
,但这个过程略显繁琐:
我们所想的,是在需要时一键显示Gizmos
,不需要时一键隐藏Gizmos
,显示与隐藏的切换越快捷、简便
越好。
为此,我们准备此编辑器工具的开发。
Assembly Viewer搜索程序集
为了显示和隐藏Gizmos
,我们不可能自行开发此功能,所以只能借助上图位于Scene
视图的Gizmos菜单
。
打开Assembly Viewer程序集搜索工具:
Gizmos菜单
作为一个编辑器窗口,其必定位于UnityEditor
程序集中,所以我们直接在UnityEditor
程序集中搜索关键字Gizmos
:
经过一番搜索,最终在UnityEditor.SceneViewModule
中搜到了一个可疑目标:
SceneView
顾名思义即为Scene
视图,且这个GizmosElement
类继承至EditorToolbarDropdownToggle
,从名字上看很像是编辑器工具栏下拉菜单
,OK了,我们的切入点就选他了。
接下来我们点击Open in ILSpy
按钮,在ILSpy
中反编译这个程序集:
ILSpy反编译程序集
搜索GizmosElement类
反编译成功后,我们首先搜索切入点GizmosElement
类:
找到Gizmos菜单
反编译该类后,查看源码,第一眼就找到了我们想要的东西:
此工具栏提示,正好与编辑器中的对应,说明这个类正是Gizmos菜单
:
找到Gizmos窗口
点击Gizmos菜单
会打开Gizmos窗口
,所以我们看菜单的点击事件:
很明显,这句话便是打开Gizmos窗口
:
AnnotationWindow.ShowAtPosition(base.worldBound, false);
AnnotationWindow
便是我们要找的Gizmos窗口
。
分析AnnotationWindow类
通过分析AnnotationWindow
类,我们知道了一个GizmoInfo
对象,即对应了一个组件、脚本的Gizmos
状态。
其中的如下2个GizmoInfo
集合,正对应了AnnotationWindow
窗口中的组件(Builtin)和脚本(Script):
再进一步分析,其中的SetGizmoState
方法,即可设置一个GizmoInfo
对象的开启状态,也即是Gizmos
控件的开启状态:
开始编写工具
万事俱备只欠东风,接下来就是编码环节,熟悉反射的同学脑海中可能已经构建了一套完整的伪代码,事实上反射的代码也极其简单,所以我们就直接贴出源码了:
protected void ShowOrHideGizmos(string className, bool isBuiltin){//反射出AnnotationWindow类Type type = Type.GetType("UnityEditor.AnnotationWindow,UnityEditor");//根据是否为内置组件,反射出对应的GizmoInfo集合FieldInfo annotations = type.GetField(isBuiltin ? "m_BuiltinAnnotations" : "m_ScriptAnnotations", BindingFlags.Instance | BindingFlags.NonPublic);//反射出打开AnnotationWindow窗口的方法MethodInfo showAtPosition = type.GetMethod("ShowAtPosition", BindingFlags.Static | BindingFlags.NonPublic);//反射出设置Gizmos状态的方法MethodInfo setGizmoState = type.GetMethod("SetGizmoState", BindingFlags.Instance | BindingFlags.NonPublic);//第一步:先打开AnnotationWindow窗口(显示位置无所谓,我们立即会关闭他)showAtPosition.Invoke(null, new object[] { Rect.zero, false });EditorWindow window = EditorWindow.GetWindow(type);//第二步:反射出GizmoInfo集合的真实对象List<GizmoInfo> gizmoInfos = annotations.GetValue(window) as List<GizmoInfo>;//第三步:找到我们需要设置Gizmos状态的类的GizmoInfo对象GizmoInfo gizmoInfo = gizmoInfos.Find((g) => { return g.name == className; });//第三步:改变Gizmos激活状态(显示变隐藏,隐藏变显示)gizmoInfo.gizmoEnabled = !gizmoInfo.gizmoEnabled;//第四步:调用设置Gizmos状态的方法setGizmoState.Invoke(window, new object[] { gizmoInfo, true });//第五步:关闭窗口window.Close();}
如上方法我们将其放到MouseRayTargetBase
类中,然后在检视面板写一个按钮调用他即可:
[Button("Show/Hide This Gizmos", ButtonAttribute.EnableMode.Always)]protected void ShowOrHideThisGizmos(){ShowOrHideGizmos(GetType().Name, false);}
同时,控制Collider
组件的线框显示也丢在这里:
[Button("Show/Hide Collider Gizmos", ButtonAttribute.EnableMode.Always)]protected void ShowOrHideColliderGizmos(){Collider collider = GetComponent<Collider>();if (collider){ShowOrHideGizmos(collider.GetType().Name, true);}}
最后我们来看看效果: