https://github.com/nothke/dx-highlighter

A Deus Ex/System Shock inspired pulsing bounds item highlighter for Unity
https://github.com/nothke/dx-highlighter

Last synced: 1 day ago
JSON representation

A Deus Ex/System Shock inspired pulsing bounds item highlighter for Unity

• Host: GitHub
• URL: https://github.com/nothke/dx-highlighter
• Owner: nothke
• Created: 2021-01-11T21:40:52.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-23T23:34:36.000Z (about 3 years ago)
• Last Synced: 2024-08-02T05:14:01.722Z (3 months ago)
• Language: C#
• Homepage:
• Size: 3.59 MB
• Stars: 111
• Watchers: 6
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-unity3d - dx-highlighter - A Deus Ex/System Shock inspired pulsing bounds item highlighter for Unity (Open Source Repositories / Effect-Highlighter)

README

        
# dx-highlighter

A Deus Ex/System Shock inspired pulsing bounds item highlighter

![Tuc tuc tuc](Documentation~/Images/dx.gif)

### Installation

You can use this repo directly via the Unity package manager:

1. In Unity, go to Window > Package Manager

2. Click on the "+" sign in the upper left corner > Add package from git URL

3. Copy the address of this repository: https://github.com/nothke/dx-highlighter and hit Add

Alternatively, you can clone or download this repo and put it in the Packages folder in your Unity project.

### How to Use

1. Add dx_highlighter_canvas prefab to your scene;

2. Reference DXHighlighter, located on that canvas object, in your script;

3. When you want an entire GameObject highlighted, call `highlighter.Highlight(myObject);`. Alternatively, you can add individual Renderers with `highlighter.AddRenderer(myRenderer);`

4. To "unhighlight" everything, call `highlighter.ClearAll()`, or to manually remove renderers `highlighter.RemoveRenderer(myRenderer);`

The highlighter will calculate screen-space bounds of the object and store it in `highlighter.screenBounds`. You can use that value for adding additional features, like item title on screen.

If you want to use the highlighter but with your custom rendering, you can tick manual update in the DXHighlighter component, and then call `highlighter.CalculateBounds()`. You can then obtain resulting screen-space bounds via `highlighter.screenBounds`.

Note: The highlighter is using Unity UI, which is not amazing on performance (but you can use your own rendering method ^)