Highlighter

Properties

public HighlighterSettings Settings - Use it to tweak the settings of the highlighter.

public FindRenderers findRenderers - Choose where the script should look for renderers.

public List<HighlighterRenderer> Renderers - List containing all HighlighterRenderer objects that will be used to draw highlights.

public int ID - The ID of the highlighter.

Functions

public void Setup() - Finds the working Id for the highlighter.

public void GetRenderers() - Finds renderers of the object based on the findRenderers value.

public void GetRenderersInChildren() - Finds renderers in the object and in its children.

public void GetRenderersInComponents() - Finds renderers in the object's components.

public void HighlighterValidate() - Needs to be called after you add new renderers or enable a new feature in highlighter.

public void RefreshRenderers() - (Only in Built-In) Call when you added renderer to your scene that you want to use as a depth mask.

Note:

After changing Renderers property (e.g. Renderers.Add() or using GetRenderers() functions, and after enabling a new feature of highlighter (UseOuterGlow, UseInnerGlow, UseMeshOutline, UseOverlay) you need to call the following function:

highlighter.HighlighterValidate()

To avoid a one-frame flicker of the highlight and ensure the highlight will start working right away.