Interface IMixedRealityInputSystem
Manager interface for a Input system in the Mixed Reality Toolkit All replacement systems for providing Input System functionality should derive from this interface
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealityInputSystem : IMixedRealityEventSystem, IMixedRealityService, IDisposable
Properties
DetectedControllers
List of IMixedRealityControllers currently detected by the input manager.
Declaration
HashSet<IMixedRealityController> DetectedControllers { get; }
Property Value
Type | Description |
---|---|
HashSet<IMixedRealityController> |
Remarks
This property is similar to DetectedInputSources, as this is a subset of those IMixedRealityInputSources in that list.
DetectedInputSources
List of the Interaction Input Sources as detected by the input manager like hands or motion controllers.
Declaration
HashSet<IMixedRealityInputSource> DetectedInputSources { get; }
Property Value
Type | Description |
---|---|
HashSet<IMixedRealityInputSource> |
EyeGazeProvider
The current Eye Gaze Provider that's been implemented by this Input System.
Declaration
IMixedRealityEyeGazeProvider EyeGazeProvider { get; }
Property Value
Type | Description |
---|---|
IMixedRealityEyeGazeProvider |
FocusProvider
The current Focus Provider that's been implemented by this Input System.
Declaration
IMixedRealityFocusProvider FocusProvider { get; }
Property Value
Type | Description |
---|---|
IMixedRealityFocusProvider |
GazeProvider
The current Gaze Provider that's been implemented by this Input System.
Declaration
IMixedRealityGazeProvider GazeProvider { get; }
Property Value
Type | Description |
---|---|
IMixedRealityGazeProvider |
InputSystemProfile
Typed representation of the ConfigurationProfile property.
Declaration
MixedRealityInputSystemProfile InputSystemProfile { get; }
Property Value
Type | Description |
---|---|
MixedRealityInputSystemProfile |
IsInputEnabled
Indicates if input is currently enabled or not.
Declaration
bool IsInputEnabled { get; }
Property Value
Type | Description |
---|---|
Boolean |
RaycastProvider
The current Raycast Provider that's been implemented by this Input System.
Declaration
IMixedRealityRaycastProvider RaycastProvider { get; }
Property Value
Type | Description |
---|---|
IMixedRealityRaycastProvider |
Methods
ClearFallbackInputStack()
Clear all fallback input handlers off the stack.
Declaration
void ClearFallbackInputStack()
ClearInputDisableStack()
Clear the input disable stack, which will immediately re-enable input.
Declaration
void ClearInputDisableStack()
ClearModalInputStack()
Clear all modal input handlers off the stack.
Declaration
void ClearModalInputStack()
GenerateNewSourceId()
Generates a new unique input source id.
Declaration
uint GenerateNewSourceId()
Returns
Type | Description |
---|---|
UInt32 | a new unique Id for the input source. |
Remarks
All Input Sources are required to call this method in their constructor or initialization.
PopFallbackInputHandler()
Remove the last game object from the fallback input stack.
Declaration
void PopFallbackInputHandler()
PopInputDisable()
Pop disabled input state. When the last disabled state is popped off the stack input will be re-enabled.
Declaration
void PopInputDisable()
PopModalInputHandler()
Remove the last game object from the modal input stack.
Declaration
void PopModalInputHandler()
PushFallbackInputHandler(GameObject)
Push a game object into the fallback input stack. Any input handlers on the game object are given input events when no modal or focused objects consume the event.
Declaration
void PushFallbackInputHandler(GameObject inputHandler)
Parameters
Type | Name | Description |
---|---|---|
GameObject | inputHandler | The input handler to push |
PushInputDisable()
Push a disabled input state onto the Input System. While input is disabled no events will be sent out and the cursor displays a waiting animation.
Declaration
void PushInputDisable()
PushModalInputHandler(GameObject)
Push a game object into the modal input stack. Any input handlers on the game object are given priority to input events before any focused objects.
Declaration
void PushModalInputHandler(GameObject inputHandler)
Parameters
Type | Name | Description |
---|---|---|
GameObject | inputHandler | The input handler to push |
RaiseDictationComplete(IMixedRealityInputSource, String, AudioClip)
Declaration
void RaiseDictationComplete(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
String | dictationResult | |
AudioClip | dictationAudioClip |
RaiseDictationError(IMixedRealityInputSource, String, AudioClip)
Declaration
void RaiseDictationError(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
String | dictationResult | |
AudioClip | dictationAudioClip |
RaiseDictationHypothesis(IMixedRealityInputSource, String, AudioClip)
Declaration
void RaiseDictationHypothesis(IMixedRealityInputSource source, string dictationHypothesis, AudioClip dictationAudioClip = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
String | dictationHypothesis | |
AudioClip | dictationAudioClip |
RaiseDictationResult(IMixedRealityInputSource, String, AudioClip)
Declaration
void RaiseDictationResult(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
String | dictationResult | |
AudioClip | dictationAudioClip |
RaiseFloatInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Single)
Raise Float Input Changed.
Declaration
void RaiseFloatInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, float inputValue)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction | |
Single | inputValue |
RaiseFocusChanged(IMixedRealityPointer, GameObject, GameObject)
Raise the focus changed event.
Declaration
void RaiseFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer that the focus change event is raised on. |
GameObject | oldFocusedObject | The old focused object. |
GameObject | newFocusedObject | The new focused object. |
RaiseFocusEnter(IMixedRealityPointer, GameObject)
Raise the focus enter event.
Declaration
void RaiseFocusEnter(IMixedRealityPointer pointer, GameObject focusedObject)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer that has focus. |
GameObject | focusedObject | The GameObject that the pointer has entered focus on. |
RaiseFocusExit(IMixedRealityPointer, GameObject)
Raise the focus exit event.
Declaration
void RaiseFocusExit(IMixedRealityPointer pointer, GameObject unfocusedObject)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer that has lost focus. |
GameObject | unfocusedObject | The GameObject that the pointer has exited focus on. |
RaiseGestureCanceled(IMixedRealityController, MixedRealityInputAction)
Raise the Gesture Canceled Event.
Declaration
void RaiseGestureCanceled(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action |
RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction)
Raise the Gesture Completed Event.
Declaration
void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action |
RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)
Raise the Gesture Completed Event.
Declaration
void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
MixedRealityPose | inputData |
RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Quaternion)
Raise the Gesture Completed Event.
Declaration
void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Quaternion | inputData |
RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector2)
Raise the Gesture Completed Event.
Declaration
void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Vector2 | inputData |
RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector3)
Raise the Gesture Completed Event.
Declaration
void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Vector3 | inputData |
RaiseGestureStarted(IMixedRealityController, MixedRealityInputAction)
Raise the Gesture Started Event.
Declaration
void RaiseGestureStarted(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action |
RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction)
Raise the Gesture Updated Event.
Declaration
void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action |
RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)
Raise the Gesture Updated Event.
Declaration
void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
MixedRealityPose | inputData |
RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Quaternion)
Raise the Gesture Updated Event.
Declaration
void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Quaternion | inputData |
RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector2)
Raise the Gesture Updated Event.
Declaration
void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Vector2 | inputData |
RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector3)
Raise the Gesture Updated Event.
Declaration
void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityController | controller | |
MixedRealityInputAction | action | |
Vector3 | inputData |
RaiseHandJointsUpdated(IMixedRealityInputSource, Handedness, IDictionary<TrackedHandJoint, MixedRealityPose>)
Notify system that articulated hand joint info has been updated
Declaration
void RaiseHandJointsUpdated(IMixedRealityInputSource source, Handedness handedness, IDictionary<TrackedHandJoint, MixedRealityPose> jointPoses)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
IDictionary<TrackedHandJoint, MixedRealityPose> | jointPoses |
RaiseHandMeshUpdated(IMixedRealityInputSource, Handedness, HandMeshInfo)
Notify system that articulated hand mesh has been updated
Declaration
void RaiseHandMeshUpdated(IMixedRealityInputSource source, Handedness handedness, HandMeshInfo handMeshInfo)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
HandMeshInfo | handMeshInfo |
RaiseOnInputDown(IMixedRealityInputSource, Handedness, MixedRealityInputAction)
Raise the input down event.
Declaration
void RaiseOnInputDown(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction |
RaiseOnInputUp(IMixedRealityInputSource, Handedness, MixedRealityInputAction)
Raise the input up event.
Declaration
void RaiseOnInputUp(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction |
RaiseOnTouchCompleted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)
Declaration
void RaiseOnTouchCompleted(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Handedness | handedness | |
Vector3 | touchPoint |
RaiseOnTouchStarted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)
Declaration
void RaiseOnTouchStarted(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Handedness | handedness | |
Vector3 | touchPoint |
RaiseOnTouchUpdated(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)
Declaration
void RaiseOnTouchUpdated(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Handedness | handedness | |
Vector3 | touchPoint |
RaisePointerClicked(IMixedRealityPointer, MixedRealityInputAction, Int32, Handedness, IMixedRealityInputSource)
Raise the pointer clicked event.
Declaration
void RaisePointerClicked(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, int count, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | |
MixedRealityInputAction | inputAction | |
Int32 | count | |
Handedness | handedness | |
IMixedRealityInputSource | inputSource |
RaisePointerDown(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)
Raise the pointer down event.
Declaration
void RaisePointerDown(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer where the event originates. |
MixedRealityInputAction | inputAction | |
Handedness | handedness | |
IMixedRealityInputSource | inputSource |
RaisePointerDragged(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)
Raise the pointer dragged event.
Declaration
void RaisePointerDragged(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer where the event originates. |
MixedRealityInputAction | inputAction | |
Handedness | handedness | |
IMixedRealityInputSource | inputSource |
RaisePointerUp(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)
Raise the pointer up event.
Declaration
void RaisePointerUp(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | |
MixedRealityInputAction | inputAction | |
Handedness | handedness | |
IMixedRealityInputSource | inputSource |
RaisePoseInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, MixedRealityPose)
Raise the 6 degrees of freedom input event.
Declaration
void RaisePoseInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, MixedRealityPose inputData)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction | |
MixedRealityPose | inputData |
RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector2)
Raise the 2 degrees of freedom input event.
Declaration
void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector2 position)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction | |
Vector2 | position |
RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector3)
Raise the 3 degrees of freedom input event.
Declaration
void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector3 position)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction | |
Vector3 | position |
RaisePreFocusChanged(IMixedRealityPointer, GameObject, GameObject)
Raise the pre-focus changed event.
Declaration
void RaisePreFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityPointer | pointer | The pointer that the focus change event is raised on. |
GameObject | oldFocusedObject | The old focused object. |
GameObject | newFocusedObject | The new focused object. |
Remarks
This event is useful for doing logic before the focus changed event.
RaiseRotationInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Quaternion)
Raise the 3 degrees of freedom input event.
Declaration
void RaiseRotationInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Quaternion rotation)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
Handedness | handedness | |
MixedRealityInputAction | inputAction | |
Quaternion | rotation |
RaiseSourceDetected(IMixedRealityInputSource, IMixedRealityController)
Raise the event that the Input Source was detected.
Declaration
void RaiseSourceDetected(IMixedRealityInputSource source, IMixedRealityController controller = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | The detected Input Source. |
IMixedRealityController | controller |
RaiseSourceLost(IMixedRealityInputSource, IMixedRealityController)
Raise the event that the Input Source was lost.
Declaration
void RaiseSourceLost(IMixedRealityInputSource source, IMixedRealityController controller = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | The lost Input Source. |
IMixedRealityController | controller |
RaiseSourcePoseChanged(IMixedRealityInputSource, IMixedRealityController, MixedRealityPose)
Raise the event that the Input Source position was changed.
Declaration
void RaiseSourcePoseChanged(IMixedRealityInputSource source, IMixedRealityController controller, MixedRealityPose position)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
MixedRealityPose | position |
RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector2)
Raise the event that the Input Source position was changed.
Declaration
void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector2 position)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Vector2 | position |
RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector3)
Raise the event that the Input Source position was changed.
Declaration
void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector3 position)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Vector3 | position |
RaiseSourceRotationChanged(IMixedRealityInputSource, IMixedRealityController, Quaternion)
Raise the event that the Input Source position was changed.
Declaration
void RaiseSourceRotationChanged(IMixedRealityInputSource source, IMixedRealityController controller, Quaternion rotation)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
Quaternion | rotation |
RaiseSourceTrackingStateChanged(IMixedRealityInputSource, IMixedRealityController, TrackingState)
Raise the event that the Input Source's tracking state has changed.
Declaration
void RaiseSourceTrackingStateChanged(IMixedRealityInputSource source, IMixedRealityController controller, TrackingState state)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
IMixedRealityController | controller | |
TrackingState | state |
RaiseSpeechCommandRecognized(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)
Declaration
void RaiseSpeechCommandRecognized(IMixedRealityInputSource source, RecognitionConfidenceLevel confidence, TimeSpan phraseDuration, DateTime phraseStartTime, SpeechCommands command)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | source | |
RecognitionConfidenceLevel | confidence | |
TimeSpan | phraseDuration | |
DateTime | phraseStartTime | |
SpeechCommands | command |
RequestNewGenericInputSource(String, IMixedRealityPointer[], InputSourceType)
Declaration
IMixedRealityInputSource RequestNewGenericInputSource(string name, IMixedRealityPointer[] pointers = null, InputSourceType sourceType = InputSourceType.Other)
Parameters
Type | Name | Description |
---|---|---|
String | name | |
IMixedRealityPointer[] | pointers | |
InputSourceType | sourceType |
Returns
Type | Description |
---|---|
IMixedRealityInputSource |
Events
InputDisabled
Event that's raised when the Input is disabled.
Declaration
event Action InputDisabled
Event Type
Type | Description |
---|---|
Action |
InputEnabled
Event that's raised when the Input is enabled.
Declaration
event Action InputEnabled
Event Type
Type | Description |
---|---|
Action |