Click or drag to resize

UnityXRVRInputModule Class

Generic input module that uses Unity Native VR integration
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.ControllersInputModule
              ImmerseSDK.Platforms.UnityXRUnityXRVRInputModule

Namespace:  ImmerseSDK.Platforms.UnityXR
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
Syntax
C#
public class UnityXRVRInputModule : InputModule

The UnityXRVRInputModule type exposes the following members.

Constructors
  NameDescription
Public methodUnityXRVRInputModule
Initializes a new instance of the UnityXRVRInputModule class
Top
Methods
  NameDescription
Protected methodAwake
Unity component method
Public methodCustomHandStateToggle
When true the following will happen: - If in the default (or other exitable) hand state, then the first available custom hand state will be shown. - If already in a custom hand state, then the next available custom hand state will be shown. - If no further custom hand states are available, then the previous built in state will be returned to.
(Overrides InputModuleCustomHandStateToggle.)
Public methodGesturePoint
Indicates whether a pointing gesture should be entered on the hand associated with this controller
(Overrides InputModuleGesturePoint(Boolean).)
Public methodGestureUnPoint
Indicates whether a pointing gesture should be exited on the hand associated with this controller
(Overrides InputModuleGestureUnPoint(Boolean).)
Public methodHandGrab
Indicates whether input on this controller has caused a grabbing state to be entered on the associated hand
(Overrides InputModuleHandGrab.)
Public methodHandGripAmount
Indicates the amount of grip the hand associated with this controller has from inputs in the current frame. Returns a float value between 0 (no grip) and 1 (fully gripped)
(Overrides InputModuleHandGripAmount.)
Public methodHandRelease
Indicates whether input on this controller has caused a grabbing state to be exited on the associated hand
(Overrides InputModuleHandRelease.)
Public methodHandReleaseToolPickup
Indicates whether input on this controller has caused a grabbing state for ToolPickup classes to be exited on the associated hand
(Overrides InputModuleHandReleaseToolPickup.)
Public methodIsVibrating
Public methodTeleportCancel
Indicates whether controller input has caused the teleport seek state to be cancelled
(Overrides InputModuleTeleportCancel.)
Public methodTeleportChoose
Indicates whether controller input has caused a teleport target to be chosen
(Overrides InputModuleTeleportChoose.)
Public methodTeleportSeek
Indicates whether controller input has caused the teleport seek state to be entered
(Overrides InputModuleTeleportSeek.)
Public methodToString
Helps in debugging and console output. Prints out the device index.
(Overrides UnityEngine.Object.ToString.)
Public methodUIPress
Indicates whether controller input should cause a Menu UI press event
(Overrides InputModuleUIPress.)
Public methodUIRelease
Indicates whether controller input should cause a Menu UI release event
(Overrides InputModuleUIRelease.)
Protected methodUpdate
Unity component method
Public methodVibrate
Causes haptic feedback vibration on the controller to start this frame and continue for a specified amount of time
(Overrides InputModuleVibrate(Single).)
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