Click or drag to resize

HandMenuSettings Class

Configures the functionality and look-and-feel of the Hand Menu
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.ScriptableObject
      ImmerseSDK.ControllersHandMenuSettings

Namespace:  ImmerseSDK.Controllers
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
Syntax
C#
public sealed class HandMenuSettings : UnityEngine.ScriptableObject

The HandMenuSettings type exposes the following members.

Constructors
  NameDescription
Public methodHandMenuSettings
Initializes a new instance of the HandMenuSettings class
Top
Properties
  NameDescription
Public propertyAreNotificationsEnabled
Are Notifications enabled for this app. If true, then Notifications will be accessible from the Hand menu.
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 propertyHandMenuType
Which type of hand menu should be used, or should the HandGui be disabled?
Public propertyHasNoNotificationsColor
Color for light to show there are no notifications
Public propertyHasNotificationsColor
Color for light to show there are notifications
Public propertyHeightAboveHeadForShowHandGui
Upper distance between the head and the wrist for checking it's ok to open the HandGui
Public propertyHeightBelowHeadForShowHandGui
Lower distance between the head and the wrist for checking it's ok to open the HandGui
Public propertyMaxTriggerValueForShowHandGui
Maximum amount of trigger press before HandGui can be shown
Public propertyMinTriggerValueForDetachHandGui
Minimum amount of trigger press before HandGui 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 propertyShowControllerInstructionsOnHandMenu
Should the controller instructions dialog be accessible from the Hand menu?
Public propertyShowToggleOutlineOnHandMenu
Should toggling the outline effect on objects be accessible from 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
See Also