Class HotspotUIServices
Hotspot UI Services
Namespace: Unity.Industrial.Forma.Editor.UI.Components
Syntax
[MovedFrom(true, "UnityEditor.Industrial.Configuring.UI", "Unity.Industrial.Configurator.Editor", null)]
public class HotspotUIServicesMethods
ActivateHotspotAnnotation(Hotspot, Boolean)
Activate hotspot annotation
Declaration
public static void ActivateHotspotAnnotation(Hotspot hotspot, bool activation)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | Hotspot |
| Boolean | activation | activation |
ConvertType(HotspotItem, StagingOwnerType)
Convert hotspot owner type
Declaration
public static void ConvertType(HotspotItem hotspotItem, StagingOwnerType type)Parameters
| Type | Name | Description |
|---|---|---|
| HotspotItem | hotspotItem | hotspot |
| StagingOwnerType | type | staging owner type |
DeleteHotspotItem(HotspotItem)
Delete HotspotItem
Declaration
public static void DeleteHotspotItem(HotspotItem hotspotItem)Parameters
| Type | Name | Description |
|---|---|---|
| HotspotItem | hotspotItem | HotspotItem |
GetAllHotspotItems()
Get all hotspot items
Declaration
public static List<HotspotItem> GetAllHotspotItems()Returns
| Type | Description |
|---|---|
| List<HotspotItem> | HotspotItem List |
Group(Hotspot, HotspotGroup)
Group hotspot
Declaration
public static void Group(Hotspot hotspot, HotspotGroup hotspotGroup)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | hotspot |
| HotspotGroup | hotspotGroup | hotspot group |
SetEmptyHotspotView(Hotspot)
Set empty hotspot view
Declaration
public static void SetEmptyHotspotView(Hotspot hotspot)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | Hotspot |
SetHotspotAnnotation(Hotspot, Boolean, String)
Set hotspot annotation (activation, text)
Declaration
public static void SetHotspotAnnotation(Hotspot hotspot, bool activate, string text = "")Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | Hotspot |
| Boolean | activate | activate |
| String | text | text |
SetHotspotViewMesh(Hotspot, Mesh)
Set hotspot mesh on mesh hotspot view
Declaration
public static void SetHotspotViewMesh(Hotspot hotspot, Mesh mesh)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | Hotspot |
| Mesh | mesh | mesh |
SetHotspotViewSprite(Hotspot, Sprite)
Set hotspot sprite on canvas hotspot view
Declaration
public static void SetHotspotViewSprite(Hotspot hotspot, Sprite sprite)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | Hotspot |
| Sprite | sprite | sprite |
Ungroup(Hotspot)
Ungroup hotspot
Declaration
public static void Ungroup(Hotspot hotspot)Parameters
| Type | Name | Description |
|---|---|---|
| Hotspot | hotspot | hotspot |
Ungroup(HotspotGroup)
Remove all hotspots of hotspot group
Declaration
public static void Ungroup(HotspotGroup hotspotGroup)Parameters
| Type | Name | Description |
|---|---|---|
| HotspotGroup | hotspotGroup | hotspot group |