1 Overview 概述

高亮系统允许你简单在Unity项目中将整体外部轮廓效果添加给物体。允许你设置任何物体高亮，可以跨平台使用，Image Effect也支持。

1.1 Package overview 包概述

当插件导入后，在Plugins\HighlightingSystem文件夹中你可以发现所有高亮系统工作需要的脚本和Shader。这个文件夹的脚本都是在HighlightingSystem 命名空间。

在HighlightingSystemDemo 文件夹中，你可以找到案例场景和脚本来决定在你的项目中如何集成和使用高亮系统。你可以在任何时间自由地删除这个文件夹。这个文件夹的所有脚本在HighlightingSystem.Demo命名空间中。

2 整合到项目中

2.1 基本集成

1. 导入高亮系统插件
2. 将HighlightingRenderer组件添加到摄像机中。此组件的顺序（在此相机上的其他图像效果中）定义何时将突出显示缓冲区应用于渲染帧。

3.将Highlighter组件添加到你想高亮的游戏物体中。

4. 设置Highlighter组件为你需要的。可以根据Highlighter API来获取每个操作的意思。

5.HighlightingRender组件的面板设置改变高亮的显示。请注意高亮预设存储在组件中或者在预制体中，你可以在运行过程中使用HighlightingRendererAPI。

2.2 Hover highlight 选择高亮

1.给摄像机添加RaycastController组件
2.给摄像机添加HighlighterHover或者任何其他的游戏物体。

3. 将HighlightHover添加给OnHover消息接收框。 选择HighlighterHover>OnHover方法。
   4.在HighlighterHover组件中设置需要的颜色

也可以在HighlighterInteractionDemo类源文件中获取关于Highlighter更多的交互。

2.3 Quick tips 快速贴士

• Tween 比Constant有更高的优先级，所以可以在Highlighter中同时设置二者。你将不会看到任何效果从Constant Highlighting属性（你可在Highlighter.UpdateHighlighting()方法代码中通过简单的重排序来改变优先级）

• 你可以在脚本中使用API来直接控制Highlighter。例如：

using UnityEngine; 
using HighlightingSystem; 
 
public class Example : MonoBehaviour {  
// Assign Highlighter component to this field in Inspector  
public Highlighter highlighter; 
 
 void Awake() 
 {    
      highligter.ConstantOn(Color.red);  
} 

• 不要忘了添加using HighlightingSystem;

• 如果你不想使用HighlighterHover——去手动调节一个单帧调用Hover(Color.red) 在目标Highlighter中（在HighlighterHover.cs和HighlighterInteractionDemo.cs中为例）

• 如果您想从头实现完全自定义的突出显示逻辑，请从HighlighterCore派生类。

• 配置highlightingrender组件时，增加模糊迭代将有助于提高轮廓辉光质量，但为了获得更好的性能，请尽量将此值保持在尽可能低的水平。

• 可以突出显示从Unity的渲染器类派生的任何渲染器组件。默认情况下-启用以下渲染器的突出显示：网格渲染器、蒙皮网格渲染器、精灵渲染器、粒子系统渲染器。可以根据需要在defaultrenderfilter（）方法源中全局优化类型列表，或者实现自定义renderfilter。

• 在移动平台上，不要忘记在Unity Player设置的分辨率和表示部分下设置使用32位显示buer复选框。

• 高亮显示系统带有几个内置的颜色渐变（位于HighlightingSystemDemo/Editor/HighlightingSystem.Gradients Library le中）。要使用它们，可以在此处切换到此库：

3 API 应用程序接口

3.1 Highlighter

在HighlighterSystem中的类继承自HighlighterCore
描述：
用于要使其变为可高亮的对象的主要组件。提供三种不同的突出显示模式（按降序排列）：

1. Hover
   只为单个帧突出显示对象，因此可以在鼠标光标下为对象触发每个帧。
   2.Tween
   有助于注意特定的对象（例如游戏教程项）。
   3.Constant
   用于打开/关闭对象上的持续突出显示（例如，突出显示屏幕上的所有可选取项）。
   4.Occluder
   实际上不是突出显示模式，但只有在没有其他模式处于活动状态时，突出显示才会变成遮光器。

如果在荧光笔模式上启用了多个突出显示模式，则具有更高优先级的模式将生效。

using UnityEngine; 
using HighlightingSystem; 
 
public class Example : MonoBehaviour {   
private Highlighter highlighter;      
void Awake()   {     
    highlighter = gameObject.AddComponent<Highlighter>(); 
    highlighter.ConstantOn(Color.red);  
 } 
}

3.2 HighlighterBlocker

HighlightingSystem中的类/从MonoBehavior继承
说明：
带有此组件（或其任何子组件）的GameObject上的渲染器永远不会突出显示。

3.3 HiglighterCore

HighlightingSystem中的类/继承自：MonoBehavior
说明：
所有Highlighter的基类。如果您不想使用提供的高亮显示组件，而是想实现自定义的高亮显示逻辑，那么继承这个类，并重写updateHighlighting（）方法，在该方法中您应该更新模式和颜色属性。有关示例，请参见荧光笔类源。请注意，为了安全（为了避免异常），这个类从所有继承者隐藏MonoBehavior的aweak（）、onenable（）、ondisable（）、ondestory（）方法，因此您应该相应地重写awakesafe（）、onenablesafe（）、ondisablesafe（）、ondestroysafe（）方法。
代表：
bool renderfilter（渲染器渲染器，list<int>子网格索引）
用于Globalrenderfilter和renderfilter的委托，在每次setDirty（）调用更新应突出显示的renders后将触发该委托。
在您自己实现此委托时-返回“真”以突出显示作为参数传递的渲染器，返回“所有子网格索引”列表以及应突出显示的子网格索引列表（或-1以突出显示所有索引）。子网格索引对应于渲染器组件的材质列表中的材质索引。

...
...