HandUI Class

Manager class for the HandUI

Inheritance Hierarchy

Namespace: ImmerseSDK.UI
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public class HandUI : SingletonBehaviour

The HandUI type exposes the following members.

Constructors

	Name	Description
	HandUI	Initializes a new instance of the HandUI class

Properties

	Name	Description
	HandUiType	Type of HandUI this is
	IsDetached	True if this menu has been detached
	IsHandUiEnabled	Dynamically enable/disable Handui. This is a global switch for the entire menu. It won't hide the watch, just disable activation of the menu
	IsVisible	True if HandUi is currently visible
	NumberOfNotifications	Number of notifications currently active

Methods

	Name	Description
	AddCommandsToPage	Adds commands to an existing page to the HandUI.
	AddCustomPage(String, Sprite, ListUICommand)	Adds a custom page to the HandUI.
	AddCustomPage(String, Sprite, String, ListUICommand)	Adds a custom page to the HandUI.
	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 HandUI.
	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 handUi 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 handUi 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.)