Click or drag to resize

HandMenuSettingsConfig Class

Use this component on a gameobject under the App object's hierarchy to configure the default settings for the Hand Menu
Inheritance Hierarchy
SystemObject
  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)
Syntax
C#
public class HandMenuSettingsConfig : ConfigComponent, 
	IHandMenuSettingsConfig, IConfigProperty

The HandMenuSettingsConfig type exposes the following members.

Constructors
  NameDescription
Public methodHandMenuSettingsConfig
Initializes a new instance of the HandMenuSettingsConfig class
Top
Properties
  NameDescription
Public propertyCancelWaitTimeInSeconds
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)
Public propertyHasNoNotificationsColor
Color for light to show there are no notifications
Public propertyHasNotificationsColor
Color for light to show there are notifications
Public propertyHeightAboveHeadForShowHandUi
Upper distance between the head and the wrist for checking it's ok to open the HandUI
Public propertyHeightBelowHeadForShowHandUi
Lower distance between the head and the wrist for checking it's ok to open the HandUI
Public propertyMaxTriggerValueForShowHandUi
Maximum amount of trigger press before HandUI can be shown
Public propertyMinTriggerValueForDetachHandUi
Minimum amount of trigger press before HandUI will be detached
Public propertyNotificationBlinkTimeInSeconds
Blink time in seconds for when a new notification has arrived
Public propertyNotificationClip
AudioClip to play when notifications are pending
Public propertyNumberOfTimesToBlinkOnNewNotification
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.
Public propertyPlayNotificationSound
Should a sound be played when a new notification is waiting
Public propertyPlayWaitTimeProgressSound
Should a sound be played when trying to show the hand menu?
Public propertyShowWaitTimeInSeconds
Wait time, in seconds, before showing the menu. This is the time used to show a progress bar of sorts
Public propertySphereDisplayTimeInSeconds
Time in seconds to display a sphere when watch button is pressed
Public propertyWaitTimeProgressClip
AudioClip to play when showing wait time progress
Top
Fields
  NameDescription
Private field_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)
Private field_hasNoNotificationsColor
Color for light to show there are no notifications
Private field_hasNotificationsColor
Color for light to show there are notifications
Private field_heightAboveHeadForShowHandUi
Upper distance between the head and the wrist for checking it's ok to open the HandUI
Private field_heightBelowHeadForShowHandUi
Lower distance between the head and the wrist for checking it's ok to open the HandUI
Private field_maxTriggerValueForShowHandUi
Maximum amount of trigger press before HandUI will be detached
Private field_minTriggerValueForDetachHandUi
Minimum amount of trigger press before HandUI will be detached
Private field_notificationBlinkTimeInSeconds
Blink time in seconds for when a new notification has arrived
Private field_notificationClip
AudioClip to play when notifications are pending
Private field_numberOfTimesToBlinkOnNewNotification
Number of times to blink when a new notification is received
Private field_playNotificationSound
Should a sound be played when a new notification is waiting
Private field_playWaitTimeProgressSound
Should a sound be played when trying to show the hand menu?
Private field_showWaitTimeInSeconds
Wait time, in seconds, before showing the menu. This is the time used to show a progress bar of sorts
Private field_sphereDisplayTimeInSeconds
Time in seconds to display a sphere when watch button is pressed
Private field_waitTimeProgressClip
AudioClip to play when showing wait time progress
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also