 | HandMenuSettingsConfig Class |
Use this component on a gameobject under the App object's hierarchy to configure the default settings for the Hand Menu
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.ConfigConfigComponent
ImmerseSDK.ConfigHandMenuSettingsConfig
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.ConfigConfigComponent
ImmerseSDK.ConfigHandMenuSettingsConfig
Namespace: ImmerseSDK.Config
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
SyntaxC#
public class HandMenuSettingsConfig : ConfigComponent, IHandMenuSettingsConfig, IConfigProperty
The HandMenuSettingsConfig type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HandMenuSettingsConfig | Initializes a new instance of the HandMenuSettingsConfig class |
Properties| Name | Description | |
|---|---|---|
 | CancelWaitTimeInSeconds |
Wait time, in seconds, for cancelling the hide of the menu. If you accidentally hide the menu, this is
the time given to immediately show it again before requiring the normal wait time again (and progress indicator)
|
| HasNoNotificationsColor |
Color for light to show there are no notifications
|
| HasNotificationsColor |
Color for light to show there are notifications
|
| HeightAboveHeadForShowHandUi |
Upper distance between the head and the wrist for checking it's ok to open the HandUI
|
| HeightBelowHeadForShowHandUi |
Lower distance between the head and the wrist for checking it's ok to open the HandUI
|
| MaxTriggerValueForShowHandUi |
Maximum amount of trigger press before HandUI can be shown
|
| MinTriggerValueForDetachHandUi |
Minimum amount of trigger press before HandUI will be detached
|
| NotificationBlinkTimeInSeconds |
Blink time in seconds for when a new notification has arrived
|
| NotificationClip |
AudioClip to play when notifications are pending
|
| NumberOfTimesToBlinkOnNewNotification |
Number of times to blink when a new notification is received. If this is < 0 then we will continue to blink until the menu is opened.
|
| PlayNotificationSound |
Should a sound be played when a new notification is waiting
|
| PlayWaitTimeProgressSound |
Should a sound be played when trying to show the hand menu?
|
| ShowWaitTimeInSeconds |
Wait time, in seconds, before showing the menu. This is the time used to show a progress bar of sorts
|
| SphereDisplayTimeInSeconds |
Time in seconds to display a sphere when watch button is pressed
|
| WaitTimeProgressClip |
AudioClip to play when showing wait time progress
|
Fields| Name | Description | |
|---|---|---|
 | _cancelWaitTimeInSeconds |
Wait time, in seconds, for cancelling the hide of the menu. If you accidentally hide the menu, this is
the time given to immediately show it again before requiring the normal wait time again (and progress indicator)
|
| _hasNoNotificationsColor |
Color for light to show there are no notifications
|
| _hasNotificationsColor |
Color for light to show there are notifications
|
| _heightAboveHeadForShowHandUi |
Upper distance between the head and the wrist for checking it's ok to open the HandUI
|
| _heightBelowHeadForShowHandUi |
Lower distance between the head and the wrist for checking it's ok to open the HandUI
|
| _maxTriggerValueForShowHandUi |
Maximum amount of trigger press before HandUI will be detached
|
| _minTriggerValueForDetachHandUi |
Minimum amount of trigger press before HandUI will be detached
|
| _notificationBlinkTimeInSeconds |
Blink time in seconds for when a new notification has arrived
|
| _notificationClip |
AudioClip to play when notifications are pending
|
| _numberOfTimesToBlinkOnNewNotification |
Number of times to blink when a new notification is received
|
| _playNotificationSound |
Should a sound be played when a new notification is waiting
|
| _playWaitTimeProgressSound |
Should a sound be played when trying to show the hand menu?
|
| _showWaitTimeInSeconds |
Wait time, in seconds, before showing the menu. This is the time used to show a progress bar of sorts
|
| _sphereDisplayTimeInSeconds |
Time in seconds to display a sphere when watch button is pressed
|
| _waitTimeProgressClip |
AudioClip to play when showing wait time progress
|
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