 | HandGui Class |
Manager class for the HandGui
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.UIHandGui
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.UIHandGui
Namespace: ImmerseSDK.UI
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
public class HandGui : SingletonBehaviour
The HandGui type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | HandGuiType |
Type of HandGui this is
|
| IsDetached |
True if this menu has been detached
|
| IsHandGuiEnabled |
Dynamically enable/disable HandGui. This is a global switch for the entire menu. It won't hide the watch, just disable activation of the menu
|
| IsVisible |
True if HandGui is currently visible
|
| NumberOfNotifications |
Number of notifications currently active
|
| NumberOfPages |
The number of pages currently on the hand menu
|
Methods| Name | Description | |
|---|---|---|
 | AddCommandsToPage |
Adds commands to an existing page to the HandGui.
|
| AddCustomPage(String, Sprite, ListUICommand) |
Adds a custom page to the HandGui.
|
| AddCustomPage(String, Sprite, String, HandGuiPage) |
Adds a custom page to the HandGui from a prefab
|
| AddCustomPage(String, Sprite, String, ListUICommand) |
Adds a custom page to the HandGui.
|
| AddNotification |
Adds a new notification
|
| CoroutineInitialise |
Override this to perform initialisation tasks
This coroutine is started in Awake().
To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.) |
| EnableCommandOnPage |
Enables/Disables a command on the page.
|
| HasCustomPage |
Returns true if the custom page exists, otherwise false
|
 | OnAwake |
Override this method to call code in the Awake() method (after singleton registration, but before coroutine)
(Overrides SingletonBehaviourOnAwake.) |
| RemoveCommandsFromPage |
Removes commands from an existing page to the HandGui.
|
| RemoveNotification |
Remove a previously added notification
|
| RemovePage |
Removes a page with the given ID
|
| SetPageAvailable |
If the page is available, it can be selected from the top shelf. If not, it is hidden from the top shelf.
|
| UpdateCommandColorOnPage |
Applies a color to a command on the page. Pass in null to revert back to original default color.
|
Events| Name | Description | |
|---|---|---|
 | OnDetached |
Fired whenever the handGui is detached
|
| OnNotificationAdded |
Fired whenever a notification are added
|
| OnNotificationRemoved |
Fired whenever a notification are removed
|
| OnNotificationsUpdated |
Fired whenever notifications are changed (added or removed)
|
| OnVisibilityChanged |
Fired whenever the handGui is shown/hidden
|
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also