Click or drag to resize

InputModule Class

The base class for all concrete types that handle VR controller input mapping
Inheritance Hierarchy

Namespace:  ImmerseSDK.Controllers
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
Copy
[ScriptOrderAttribute(-30000)]
public abstract class InputModule : LoggingBehaviour, 
	ISerialisationDataProvider

The InputModule type exposes the following members.

Constructors
  NameDescription
Protected methodInputModule
Initializes a new instance of the InputModule class
Top
Properties
  NameDescription
Protected propertyIsCollaborateToolsEnabled
True if collaborate tools are enabled
Protected propertyIsCustomHandStateDefined
True if a custom hand state has been defined
Public propertyMinDeltaValueForOrb
Minimum delta value for orb
Public propertySelectionToolOrbDeadZoneAmount
Value for orb deadzone. This is a zone in the center that will be ignored
Top
Methods
  NameDescription
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.
Public methodGesturePoint
Indicates whether a pointing gesture should be entered on the hand associated with this controller
Public methodGestureUnPoint
Indicates whether a pointing gesture should be exited on the hand associated with this controller
Public methodHandGrab
Indicates whether input on this controller has caused a grabbing state to be entered on the associated hand
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)
Public methodHandRelease
Indicates whether input on this controller has caused a grabbing state to be exited on the associated hand
Public methodHandReleaseToolPickup
Indicates whether input on this controller has caused a grabbing state for ToolPickup classes to be exited on the associated hand
Public methodHasFrameBeenHandled
This in only used in testing by the sdk. Please do not call this method manually.
Public methodInitialize
Called during Avatar setup, when this component is added to the avatars hand / controller gameObjects
Public methodInputFrameHandled
This in only used in testing by the sdk. Please do not call this method manually.
Public methodResetState
Resets the internal state of this input module. This is called by the SDK whenever the hand enters the default state.
Public methodTeleportCancel
Indicates whether controller input has caused the teleport seek state to be cancelled
Public methodTeleportChoose
Indicates whether controller input has caused a teleport target to be chosen
Public methodTeleportSeek
Indicates whether controller input has caused the teleport seek state to be entered
Public methodUIPress
Indicates whether controller input should cause a Menu UI press event
Public methodUIRelease
Indicates whether controller input should cause a Menu UI release event
Public methodVibrate
Causes haptic feedback vibration on the controller to start this frame and continue for a specified amount of time
Public methodVibrateOverTime
Causes Vibration over time for when you need a longer vibration than the base
Top
Fields
  NameDescription
Protected field_serialisedInputData
Serialised data where first block is the boolean values, followed by the floats
Public fieldStatic memberDefaultDeadZoneValueForOrb
Default value for orb deadzone
Public fieldStatic memberDefaultHapticDurationInSeconds
Default time to vibrate for
Public fieldStatic memberDefaultMinDeltaValueForOrb
Default minimum delta value for orb
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