Unity3d Editor 编辑器扩展功能详解（5）Handles

Ilingis · 发表于 2022-5-27 19:34

前言：

全系列目录 Unity3d Editor 编辑器扩展功能详解（1）目录索引
上一章节：Unity3d Editor 编辑器扩展功能详解（4）Gizmos
下一章节：Unity3d Editor 编辑器扩展功能详解（6）Editor常用辅助类（上）
我们已经初识了Gizmos的3D图形绘制功能，这节继续介绍Handles。
一、 Handles基础介绍

Handles
Custom 3D GUI controls and drawing in the Scene view.
Handles are the 3D controls that Unity uses to manipulate items in the Scene view. There are a number of built-in Handle GUIs, such as the familiar tools to position, scale and rotate an object via the Transform component. However, it is also possible to define your own Handle GUIs to use with custom component editors. Such GUIs can be a very useful way to edit procedurally-generated Scene content, &#34;invisible&#34; items and groups of related objects, such as waypoints and location markers.
在Sceneview（场景视图中）自定义3D GUI 控制器与绘制的类
Handles是Unity在场景视图中，用于操控物体的3D控制器，已内置许多操作GUI，比如我们熟悉的基于Transform对位置、缩放、旋转坐标的操作工具。当然，我们使用自定义的Editor，定义自己的Handle GUI操作显示也是可能的。这种GUIs将会非常有用于程序化生成的场景内容、“不可见”的子对象与组。比如路径点与坐标标记点。

一言以蔽之，许多需要在场景中程序化生成的数据，使用Handles类能轻松地显示控制柄来进行编辑，典型使用就是“地编”。
二、 Handles使用方式

1. 基于Editor类的OnSceneGUI

在继承自Editor的类中，可以定义【OnSceneGUI()】
这样当此Edtior在活跃状态时（比如一个Inspector面板展开），在【OnSceneGUI()】方法内的内容将根据SceneView的刷新而调用，触发对应逻辑。
比如进行基本定义：
------HandlesMono .cs------
using UnityEngine;
public class HandlesMono : MonoBehaviour
{

}

------HandlesMonoEditor.cs------
using UnityEngine;
using UnityEditor;
[CustomEditor(typeof(HandlesMono))]
public class HandlesMonoEditor : Editor
{
private void OnSceneGUI()
{
      Debug.Log(&#34;在Editor OnSceneGUI中调用....&#34;);
}
}
在【Hierarchy】中新建空对象，挂载脚本，点击对象在【Inspector】中显示【HandlesMono】信息，就可以看见信息打印：

随着SceneView的刷新进行打印

场景结构

当然，如果在【Hierarchy】中不选择对应物体，则【HandlesMono】不在检视器中显示，意味着【HandlesMono】 Disable掉了，将不会调用【OnSceneGUI】，读者可自行尝试。
（Tips：如果想要它一直调用，但是又需要选择其他对象怎么办呢？可以点击【Inspector】右侧的【锁】按钮，加锁之后只会显示当前的【Inspector】信息，不会随着选择而更改。）
2. 基于EditorWindow的手动注册

有些时候，我们更想在一个Window中进行数据编辑与操作，但是EditorWindow可没有OnSceneGUI，怎么办呢？这时候，需要手动对SceneView的刷新事件进行注册了。
比如：
using UnityEngine;
using UnityEditor;
public class HandlesWindow : EditorWindow
{
public static HandlesWindow m_mainWindow;

[MenuItem(&#34;MyWindows/HandlesWindow&#34;)]
public static void OpenWindow() //打开窗口
{
      m_mainWindow = EditorWindow.GetWindow<HandlesWindow>();
      m_mainWindow.Show();
}
private void OnEnable()
{
      SceneView.duringSceneGui += OnSceneGUI; //对SceneView的刷新事件进行注册
}
private void OnDisable()
{
      SceneView.duringSceneGui -= OnSceneGUI; //对SceneView的刷新事件取消注册
}
private void OnSceneGUI(SceneView sceneView) //自定义刷新事件的委托方法
{
      Debug.Log(&#34;在 Window OnSceneGUI中调用....&#34;); //具体逻辑
}
}

打开窗口

可以看见打印信息

注：下文实例代码都是在EditorWindow中编写调用。
三、 Handles基本绘制方法

1. Label（文本）

关键字：  Handles.Label
样例：

示例代码：
private Vector3 labelPos = Vector3.zero;
private string labelText = &#34;这是在Handles中绘制的文本信息！！！&#34;;
...
//Window GUI 绘制（使用EditorGUILayout）
...
Handles.Label(labelPos, labelText); // 绘制Label
注：EditorWindow的绘制只是为了显示信息方便，Editor绘制方式见：Unity Editor 编辑器扩展功能详解（3）
2. Line/Dotted Line（线段/虚线）

关键字： Handles.DrawLine，Handles.DrawDottedLine
样例：

示例代码：
//1.from 2.to 3.thickness（厚度）决定线段厚度
Handles.DrawLine(Vector3.zero, new Vector3(-1, 1, 1), 2f);
//1.from 2.to 3.ScreenSpaceSize（屏幕空间大小）决定虚线长度
Handles.DrawDottedLine(Vector3.zero, Vector3.one, 2f);
3. Arc/Disc（弧线/圆环）

关键字：Handles.DrawWireArc，Handles.DrawSolidDisc
样例：

示例代码：
Handles.color = new Color(1, 0, 0, 0.3f); //提前使用Color进行颜色设置，便于观察
Handles.DrawWireArc(Vector3.zero, Vector3.up, Vector3.right, 90, 2); //绘制线框弧线
Handles.DrawSolidArc(Vector3.zero, Vector3.up, Vector3.back, 90, 2); // 绘制填充弧线

Handles.color = new Color(0, 1, 0, 0.3f);
Handles.DrawSolidDisc(new Vector3(0, 0, 5), Vector3.up, 5); //绘制填充圆环
Handles.DrawWireDisc(new Vector3(0, 0, -5), Vector3.up, 5); //绘制线框圆环
4. Rectangle（矩形）

关键字：Handles.DrawSolidRectangleWithOutline
样例：

感觉没啥用，好像只能是xy面绘制

示例代码：
Handles.DrawSolidRectangleWithOutline(new Rect(0, 0, 1, 1), Color.green, Color.red);
5. GUI

关键字：Handles.BeginGUI()，Handles.EndGUI()
样例：

示例代码：
Handles.BeginGUI();
GUILayout.Label(&#34;我是SceneView中的Label&#34;);
if (GUILayout.Button(&#34;我是SceneView中的Button&#34;))
{
Debug.Log(&#34;芜湖&#34;);
}
Handles.EndGUI();
四、控制柄

实际上，Handles核心功能是他的Handle（控制）类，比如：Handles.PositionHandle就是一个类似于Position移动的方法。经典使用例就是在一个List<Vector3>列表中，选择某个列表元素显示他的Position控制柄，然后进行移动。
又或者类似这种：

拖拽控制柄，圆环随之而动

private Vector3 root = Vector3.zero;
...
Handles.DrawSolidDisc(root, Vector3.up, 1); //画个圆，假设这是目标对象
root = Handles.PositionHandle(root, Quaternion.identity); //控制柄
但是笔者现阶段使用的较少，不是很熟悉，就不作解释了。
详情可见：Unity的Handles类_林新发的博客-CSDN博客_unity里handle
或者看看官方API文档。
或者是Unity 编辑器扩展五 Handles 扩展Scene视图
笔者摸了。_(:з」∠)_
五、小结

实际上，OnGUIScene + Handles还有一种应用就是“地形笔刷”，就像Terrain笔刷那样在SceneView里面刷刷刷调整高度、生成植被，这种功能我们也是能自己写一套的，核心是编辑模式下的Event事件。
具体的可见：Unity - Scripting API: Event
有空再写，大概（

		自动登录	找回密码
密码			立即注册

Unity3d Editor 编辑器扩展功能详解（5）Handles

本帖子中包含更多资源