Class MixedRealityInputSystem

The Mixed Reality Toolkit's specific implementation of the IMixedRealityInputSystem

Inheritance

Object

BaseService

BaseEventSystem

BaseCoreSystem

BaseDataProviderAccessCoreSystem

MixedRealityInputSystem

Implements

IMixedRealityDataProviderAccess

IMixedRealityInputSystem

IMixedRealityEventSystem

IMixedRealityService

IDisposable

IMixedRealityCapabilityCheck

Inherited Members

BaseDataProviderAccessCoreSystem.Update()

BaseDataProviderAccessCoreSystem.LateUpdate()

BaseDataProviderAccessCoreSystem.GetDataProviders()

BaseDataProviderAccessCoreSystem.GetDataProvider(String)

BaseDataProviderAccessCoreSystem.RegisterDataProvider<T>(Type, SupportedPlatforms, Object[])

BaseDataProviderAccessCoreSystem.RegisterDataProvider<T>(T)

BaseDataProviderAccessCoreSystem.UnregisterDataProvider<T>(String)

BaseDataProviderAccessCoreSystem.UnregisterDataProvider<T>(T)

BaseCoreSystem.Registrar

BaseEventSystem.enableDanglingHandlerDiagnostics

BaseEventSystem.EventHandlersByType

BaseEventSystem.EventListeners

BaseEventSystem.RegisterHandler<T>(IEventSystemHandler)

BaseEventSystem.UnregisterHandler<T>(IEventSystemHandler)

BaseService.DefaultPriority

BaseService.ConfigurationProfile

BaseService.disposed

BaseService.Dispose()

BaseService.Dispose(Boolean)

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.Toolkit.Input

Assembly: cs.temp.dll.dll

Syntax

public class MixedRealityInputSystem : BaseDataProviderAccessCoreSystem, IMixedRealityDataProviderAccess, IMixedRealityInputSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityCapabilityCheck

Constructors

MixedRealityInputSystem(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile)

Constructor.

Declaration

public MixedRealityInputSystem(IMixedRealityServiceRegistrar registrar, MixedRealityInputSystemProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityInputSystemProfile	profile	The configuration profile for the service.

MixedRealityInputSystem(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile)

Constructor.

Declaration

public MixedRealityInputSystem(IMixedRealityServiceRegistrar registrar, MixedRealityInputSystemProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealityInputSystemProfile	profile	The configuration profile for the service.

MixedRealityInputSystem(MixedRealityInputSystemProfile)

Constructor.

Declaration

public MixedRealityInputSystem(MixedRealityInputSystemProfile profile)

Parameters

Type	Name	Description
MixedRealityInputSystemProfile	profile	The configuration profile for the service.

MixedRealityInputSystem(MixedRealityInputSystemProfile)

Constructor.

Declaration

public MixedRealityInputSystem(MixedRealityInputSystemProfile profile)

Parameters

Type	Name	Description
MixedRealityInputSystemProfile	profile	The configuration profile for the service.

Properties

DetectedControllers

Declaration

public HashSet<IMixedRealityController> DetectedControllers { get; }

Property Value

Type	Description
HashSet<IMixedRealityController>

DetectedControllers

Declaration

public HashSet<IMixedRealityController> DetectedControllers { get; }

Property Value

Type	Description
HashSet<IMixedRealityController>

DetectedInputSources

Declaration

public HashSet<IMixedRealityInputSource> DetectedInputSources { get; }

Property Value

Type	Description
HashSet<IMixedRealityInputSource>

DetectedInputSources

Declaration

public HashSet<IMixedRealityInputSource> DetectedInputSources { get; }

Property Value

Type	Description
HashSet<IMixedRealityInputSource>

EyeGazeProvider

Declaration

public IMixedRealityEyeGazeProvider EyeGazeProvider { get; }

Property Value

Type	Description
IMixedRealityEyeGazeProvider

EyeGazeProvider

Declaration

public IMixedRealityEyeGazeProvider EyeGazeProvider { get; }

Property Value

Type	Description
IMixedRealityEyeGazeProvider

FocusProvider

Declaration

public IMixedRealityFocusProvider FocusProvider { get; }

Property Value

Type	Description
IMixedRealityFocusProvider

FocusProvider

Declaration

public IMixedRealityFocusProvider FocusProvider { get; }

Property Value

Type	Description
IMixedRealityFocusProvider

GazeProvider

Declaration

public IMixedRealityGazeProvider GazeProvider { get; }

Property Value

Type	Description
IMixedRealityGazeProvider

GazeProvider

Declaration

public IMixedRealityGazeProvider GazeProvider { get; }

Property Value

Type	Description
IMixedRealityGazeProvider

InputSystemProfile

Declaration

public MixedRealityInputSystemProfile InputSystemProfile { get; }

Property Value

Type	Description
MixedRealityInputSystemProfile

InputSystemProfile

Declaration

public MixedRealityInputSystemProfile InputSystemProfile { get; }

Property Value

Type	Description
MixedRealityInputSystemProfile

IsInputEnabled

Declaration

public bool IsInputEnabled { get; }

Property Value

Type	Description
Boolean

IsInputEnabled

Declaration

public bool IsInputEnabled { get; }

Property Value

Type	Description
Boolean

Name

Declaration

public override string Name { get; protected set; }

Property Value

Type	Description
String

Overrides

BaseService.Name

Name

Declaration

public override string Name { get; protected set; }

Property Value

Type	Description
String

Overrides

BaseService.Name

Priority

Declaration

public override uint Priority { get; }

Property Value

Type	Description
UInt32

Overrides

BaseService.Priority

Remarks

Input system is critical, so should be processed before all other managers

Priority

Declaration

public override uint Priority { get; }

Property Value

Type	Description
UInt32

Overrides

BaseService.Priority

Remarks

Input system is critical, so should be processed before all other managers

RaycastProvider

Declaration

public IMixedRealityRaycastProvider RaycastProvider { get; }

Property Value

Type	Description
IMixedRealityRaycastProvider

RaycastProvider

Declaration

public IMixedRealityRaycastProvider RaycastProvider { get; }

Property Value

Type	Description
IMixedRealityRaycastProvider

Methods

CheckCapability(MixedRealityCapability)

Declaration

public bool CheckCapability(MixedRealityCapability capability)

Parameters

Type	Name	Description
MixedRealityCapability	capability

Returns

Type	Description
Boolean

CheckCapability(MixedRealityCapability)

Declaration

public bool CheckCapability(MixedRealityCapability capability)

Parameters

Type	Name	Description
MixedRealityCapability	capability

Returns

Type	Description
Boolean

ClearFallbackInputStack()

Clear all fallback input handlers off the stack.

Declaration

public void ClearFallbackInputStack()

ClearFallbackInputStack()

Clear all fallback input handlers off the stack.

Declaration

public void ClearFallbackInputStack()

ClearInputDisableStack()

Clear the input disable stack, which will immediately re-enable input.

Declaration

public void ClearInputDisableStack()

ClearInputDisableStack()

Clear the input disable stack, which will immediately re-enable input.

Declaration

public void ClearInputDisableStack()

ClearModalInputStack()

Clear all modal input handlers off the stack.

Declaration

public void ClearModalInputStack()

ClearModalInputStack()

Clear all modal input handlers off the stack.

Declaration

public void ClearModalInputStack()

Destroy()

Declaration

public override void Destroy()

Overrides

BaseEventSystem.Destroy()

Destroy()

Declaration

public override void Destroy()

Overrides

BaseEventSystem.Destroy()

Disable()

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Disable()

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Enable()

Declaration

public override void Enable()

Overrides

BaseDataProviderAccessCoreSystem.Enable()

Enable()

Declaration

public override void Enable()

Overrides

BaseDataProviderAccessCoreSystem.Enable()

GenerateNewSourceId()

Declaration

public uint GenerateNewSourceId()

Returns

Type	Description
UInt32

GenerateNewSourceId()

Declaration

public uint GenerateNewSourceId()

Returns

Type	Description
UInt32

GetDataProvider<T>(String)

Declaration

public override T GetDataProvider<T>(string name = null)

    where T : IMixedRealityDataProvider

Parameters

Type	Name	Description
String	name

Returns

Type	Description
T

Type Parameters

Name	Description
T

Overrides

BaseDataProviderAccessCoreSystem.GetDataProvider<T>(String)

GetDataProvider<T>(String)

Declaration

public override T GetDataProvider<T>(string name = null)

    where T : IMixedRealityDataProvider

Parameters

Type	Name	Description
String	name

Returns

Type	Description
T

Type Parameters

Name	Description
T

Overrides

BaseDataProviderAccessCoreSystem.GetDataProvider<T>(String)

GetDataProviders<T>()

Declaration

public override IReadOnlyList<T> GetDataProviders<T>()

    where T : IMixedRealityDataProvider

Returns

Type	Description
IReadOnlyList<T>

Type Parameters

Name	Description
T

Overrides

BaseDataProviderAccessCoreSystem.GetDataProviders<T>()

GetDataProviders<T>()

Declaration

public override IReadOnlyList<T> GetDataProviders<T>()

    where T : IMixedRealityDataProvider

Returns

Type	Description
IReadOnlyList<T>

Type Parameters

Name	Description
T

Overrides

BaseDataProviderAccessCoreSystem.GetDataProviders<T>()

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

Declaration

public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.EventFunction<T> eventHandler)

    where T : IEventSystemHandler

Parameters

Type	Name	Description
BaseEventData	eventData
ExecuteEvents.EventFunction<T>	eventHandler

Type Parameters

Name	Description
T

Overrides

Microsoft.MixedReality.Toolkit.BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

Declaration

public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.EventFunction<T> eventHandler)

    where T : IEventSystemHandler

Parameters

Type	Name	Description
BaseEventData	eventData
ExecuteEvents.EventFunction<T>	eventHandler

Type Parameters

Name	Description
T

Overrides

Microsoft.MixedReality.Toolkit.BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

PopFallbackInputHandler()

Remove the last game object from the fallback input stack.

Declaration

public void PopFallbackInputHandler()

PopFallbackInputHandler()

Remove the last game object from the fallback input stack.

Declaration

public void PopFallbackInputHandler()

PopInputDisable()

Pop disabled input state. When the last disabled state is popped off the stack input will be re-enabled.

Declaration

public void PopInputDisable()

PopInputDisable()

Pop disabled input state. When the last disabled state is popped off the stack input will be re-enabled.

Declaration

public void PopInputDisable()

PopModalInputHandler()

Remove the last game object from the modal input stack.

Declaration

public void PopModalInputHandler()

PopModalInputHandler()

Remove the last game object from the modal input stack.

Declaration

public 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

public void PushFallbackInputHandler(GameObject inputHandler)

Parameters

Type	Name	Description
GameObject	inputHandler	The input handler to push

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

public void PushFallbackInputHandler(GameObject inputHandler)

Parameters

Type	Name	Description
GameObject	inputHandler	The input handler to push

PushInputDisable()

Push a disabled input state onto the input manager. While input is disabled no events will be sent out and the cursor displays a waiting animation.

Declaration

public void PushInputDisable()

PushInputDisable()

Push a disabled input state onto the input manager. While input is disabled no events will be sent out and the cursor displays a waiting animation.

Declaration

public 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

public void PushModalInputHandler(GameObject inputHandler)

Parameters

Type	Name	Description
GameObject	inputHandler	The input handler to push

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

public void PushModalInputHandler(GameObject inputHandler)

Parameters

Type	Name	Description
GameObject	inputHandler	The input handler to push

RaiseDictationComplete(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationComplete(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseDictationComplete(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationComplete(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseDictationError(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationError(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseDictationError(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationError(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseDictationHypothesis(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationHypothesis(IMixedRealityInputSource source, string dictationHypothesis, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationHypothesis
AudioClip	dictationAudioClip

RaiseDictationHypothesis(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationHypothesis(IMixedRealityInputSource source, string dictationHypothesis, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationHypothesis
AudioClip	dictationAudioClip

RaiseDictationResult(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationResult(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseDictationResult(IMixedRealityInputSource, String, AudioClip)

Declaration

public void RaiseDictationResult(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
String	dictationResult
AudioClip	dictationAudioClip

RaiseFloatInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Single)

Declaration

public void RaiseFloatInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, float inputValue)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
Single	inputValue

RaiseFloatInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Single)

Declaration

public 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)

Declaration

public void RaiseFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	oldFocusedObject
GameObject	newFocusedObject

RaiseFocusChanged(IMixedRealityPointer, GameObject, GameObject)

Declaration

public void RaiseFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	oldFocusedObject
GameObject	newFocusedObject

RaiseFocusEnter(IMixedRealityPointer, GameObject)

Declaration

public void RaiseFocusEnter(IMixedRealityPointer pointer, GameObject focusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	focusedObject

RaiseFocusEnter(IMixedRealityPointer, GameObject)

Declaration

public void RaiseFocusEnter(IMixedRealityPointer pointer, GameObject focusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	focusedObject

RaiseFocusExit(IMixedRealityPointer, GameObject)

Declaration

public void RaiseFocusExit(IMixedRealityPointer pointer, GameObject unfocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	unfocusedObject

RaiseFocusExit(IMixedRealityPointer, GameObject)

Declaration

public void RaiseFocusExit(IMixedRealityPointer pointer, GameObject unfocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	unfocusedObject

RaiseGestureCanceled(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureCanceled(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureCanceled(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureCanceled(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
MixedRealityPose	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
MixedRealityPose	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Quaternion)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Quaternion	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Quaternion)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Quaternion	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector2)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector2	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector2)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector2	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector3)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector3	inputData

RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector3)

Declaration

public void RaiseGestureCompleted(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector3	inputData

RaiseGestureStarted(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureStarted(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureStarted(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureStarted(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
MixedRealityPose	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, MixedRealityPose)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, MixedRealityPose inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
MixedRealityPose	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Quaternion)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Quaternion	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Quaternion)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Quaternion inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Quaternion	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector2)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector2	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector2)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector2 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector2	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector3)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector3	inputData

RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector3)

Declaration

public void RaiseGestureUpdated(IMixedRealityController controller, MixedRealityInputAction action, Vector3 inputData)

Parameters

Type	Name	Description
IMixedRealityController	controller
MixedRealityInputAction	action
Vector3	inputData

RaiseHandJointsUpdated(IMixedRealityInputSource, Handedness, IDictionary<TrackedHandJoint, MixedRealityPose>)

Declaration

public void RaiseHandJointsUpdated(IMixedRealityInputSource source, Handedness handedness, IDictionary<TrackedHandJoint, MixedRealityPose> jointPoses)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
IDictionary<TrackedHandJoint, MixedRealityPose>	jointPoses

RaiseHandJointsUpdated(IMixedRealityInputSource, Handedness, IDictionary<TrackedHandJoint, MixedRealityPose>)

Declaration

public 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)

Declaration

public void RaiseHandMeshUpdated(IMixedRealityInputSource source, Handedness handedness, HandMeshInfo handMeshInfo)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
HandMeshInfo	handMeshInfo

RaiseHandMeshUpdated(IMixedRealityInputSource, Handedness, HandMeshInfo)

Declaration

public void RaiseHandMeshUpdated(IMixedRealityInputSource source, Handedness handedness, HandMeshInfo handMeshInfo)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
HandMeshInfo	handMeshInfo

RaiseOnInputDown(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Declaration

public void RaiseOnInputDown(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction

RaiseOnInputDown(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Declaration

public void RaiseOnInputDown(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction

RaiseOnInputUp(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Declaration

public void RaiseOnInputUp(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction

RaiseOnInputUp(IMixedRealityInputSource, Handedness, MixedRealityInputAction)

Declaration

public void RaiseOnInputUp(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction

RaiseOnTouchCompleted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)

Declaration

public void RaiseOnTouchCompleted(IMixedRealityInputSource source, IMixedRealityController controller, Handedness handedness, Vector3 touchPoint)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Handedness	handedness
Vector3	touchPoint

RaiseOnTouchCompleted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3)

Declaration

public 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

public void RaiseOnTouchStarted(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

public 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

public void RaiseOnTouchUpdated(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

public 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)

Declaration

public 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

RaisePointerClicked(IMixedRealityPointer, MixedRealityInputAction, Int32, Handedness, IMixedRealityInputSource)

Declaration

public 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)

Declaration

public void RaisePointerDown(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
MixedRealityInputAction	inputAction
Handedness	handedness
IMixedRealityInputSource	inputSource

RaisePointerDown(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Declaration

public void RaisePointerDown(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
MixedRealityInputAction	inputAction
Handedness	handedness
IMixedRealityInputSource	inputSource

RaisePointerDragged(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Declaration

public void RaisePointerDragged(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
MixedRealityInputAction	inputAction
Handedness	handedness
IMixedRealityInputSource	inputSource

RaisePointerDragged(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Declaration

public void RaisePointerDragged(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
MixedRealityInputAction	inputAction
Handedness	handedness
IMixedRealityInputSource	inputSource

RaisePointerUp(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Declaration

public void RaisePointerUp(IMixedRealityPointer pointer, MixedRealityInputAction inputAction, Handedness handedness = null, IMixedRealityInputSource inputSource = null)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
MixedRealityInputAction	inputAction
Handedness	handedness
IMixedRealityInputSource	inputSource

RaisePointerUp(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource)

Declaration

public 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)

Declaration

public void RaisePoseInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, MixedRealityPose inputData)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
MixedRealityPose	inputData

RaisePoseInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, MixedRealityPose)

Declaration

public 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)

Declaration

public void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector2 inputPosition)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
Vector2	inputPosition

RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector2)

Declaration

public void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector2 inputPosition)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
Vector2	inputPosition

RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector3)

Declaration

public void RaisePositionInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Vector3 position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
Vector3	position

RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector3)

Declaration

public 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)

Declaration

public void RaisePreFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	oldFocusedObject
GameObject	newFocusedObject

RaisePreFocusChanged(IMixedRealityPointer, GameObject, GameObject)

Declaration

public void RaisePreFocusChanged(IMixedRealityPointer pointer, GameObject oldFocusedObject, GameObject newFocusedObject)

Parameters

Type	Name	Description
IMixedRealityPointer	pointer
GameObject	oldFocusedObject
GameObject	newFocusedObject

RaiseRotationInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Quaternion)

Declaration

public void RaiseRotationInputChanged(IMixedRealityInputSource source, Handedness handedness, MixedRealityInputAction inputAction, Quaternion rotation)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
Handedness	handedness
MixedRealityInputAction	inputAction
Quaternion	rotation

RaiseRotationInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Quaternion)

Declaration

public 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)

Declaration

public void RaiseSourceDetected(IMixedRealityInputSource source, IMixedRealityController controller = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller

RaiseSourceDetected(IMixedRealityInputSource, IMixedRealityController)

Declaration

public void RaiseSourceDetected(IMixedRealityInputSource source, IMixedRealityController controller = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller

RaiseSourceLost(IMixedRealityInputSource, IMixedRealityController)

Declaration

public void RaiseSourceLost(IMixedRealityInputSource source, IMixedRealityController controller = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller

RaiseSourceLost(IMixedRealityInputSource, IMixedRealityController)

Declaration

public void RaiseSourceLost(IMixedRealityInputSource source, IMixedRealityController controller = null)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller

RaiseSourcePoseChanged(IMixedRealityInputSource, IMixedRealityController, MixedRealityPose)

Declaration

public void RaiseSourcePoseChanged(IMixedRealityInputSource source, IMixedRealityController controller, MixedRealityPose position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
MixedRealityPose	position

RaiseSourcePoseChanged(IMixedRealityInputSource, IMixedRealityController, MixedRealityPose)

Declaration

public void RaiseSourcePoseChanged(IMixedRealityInputSource source, IMixedRealityController controller, MixedRealityPose position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
MixedRealityPose	position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector2)

Declaration

public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector2 position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Vector2	position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector2)

Declaration

public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector2 position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Vector2	position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector3)

Declaration

public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector3 position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Vector3	position

RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector3)

Declaration

public void RaiseSourcePositionChanged(IMixedRealityInputSource source, IMixedRealityController controller, Vector3 position)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Vector3	position

RaiseSourceRotationChanged(IMixedRealityInputSource, IMixedRealityController, Quaternion)

Declaration

public void RaiseSourceRotationChanged(IMixedRealityInputSource source, IMixedRealityController controller, Quaternion rotation)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Quaternion	rotation

RaiseSourceRotationChanged(IMixedRealityInputSource, IMixedRealityController, Quaternion)

Declaration

public void RaiseSourceRotationChanged(IMixedRealityInputSource source, IMixedRealityController controller, Quaternion rotation)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
Quaternion	rotation

RaiseSourceTrackingStateChanged(IMixedRealityInputSource, IMixedRealityController, TrackingState)

Declaration

public void RaiseSourceTrackingStateChanged(IMixedRealityInputSource source, IMixedRealityController controller, TrackingState state)

Parameters

Type	Name	Description
IMixedRealityInputSource	source
IMixedRealityController	controller
TrackingState	state

RaiseSourceTrackingStateChanged(IMixedRealityInputSource, IMixedRealityController, TrackingState)

Declaration

public 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

public 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

RaiseSpeechCommandRecognized(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands)

Declaration

public 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

Register(GameObject)

Register a GameObject to listen to events that will receive all input events, regardless of which other GameObjects might have handled the event beforehand.

Declaration

public override void Register(GameObject listener)

Parameters

Type	Name	Description
GameObject	listener	Listener to add.

Overrides

BaseEventSystem.Register(GameObject)

Remarks

Useful for listening to events when the GameObject is currently not being raycasted against by the FocusProvider.

Register(GameObject)

Register a GameObject to listen to events that will receive all input events, regardless of which other GameObjects might have handled the event beforehand.

Declaration

public override void Register(GameObject listener)

Parameters

Type	Name	Description
GameObject	listener	Listener to add.

Overrides

BaseEventSystem.Register(GameObject)

Remarks

Useful for listening to events when the GameObject is currently not being raycasted against by the FocusProvider.

RequestNewGenericInputSource(String, IMixedRealityPointer[], InputSourceType)

Declaration

public IMixedRealityInputSource RequestNewGenericInputSource(string name, IMixedRealityPointer[] pointers = null, InputSourceType sourceType = null)

Parameters

Type	Name	Description
String	name
IMixedRealityPointer[]	pointers
InputSourceType	sourceType

Returns

Type	Description
IMixedRealityInputSource

RequestNewGenericInputSource(String, IMixedRealityPointer[], InputSourceType)

Declaration

public IMixedRealityInputSource RequestNewGenericInputSource(string name, IMixedRealityPointer[] pointers = null, InputSourceType sourceType = null)

Parameters

Type	Name	Description
String	name
IMixedRealityPointer[]	pointers
InputSourceType	sourceType

Returns

Type	Description
IMixedRealityInputSource

Reset()

Declaration

public override void Reset()

Overrides

BaseDataProviderAccessCoreSystem.Reset()

Reset()

Declaration

public override void Reset()

Overrides

BaseDataProviderAccessCoreSystem.Reset()

Unregister(GameObject)

Unregister a GameObject from listening to input events.

Declaration

public override void Unregister(GameObject listener)

Parameters

Type	Name	Description
GameObject	listener

Overrides

BaseEventSystem.Unregister(GameObject)

Unregister(GameObject)

Unregister a GameObject from listening to input events.

Declaration

public override void Unregister(GameObject listener)

Parameters

Type	Name	Description
GameObject	listener

Overrides

BaseEventSystem.Unregister(GameObject)

Events

InputDisabled

Declaration

public event BaseEventSystem.Action InputDisabled

Event Type

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

InputDisabled

Declaration

public event BaseEventSystem.Action InputDisabled

Event Type

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

InputEnabled

Declaration

public event BaseEventSystem.Action InputEnabled

Event Type

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

InputEnabled

Declaration

public event BaseEventSystem.Action InputEnabled

Event Type

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action

Implements

IMixedRealityDataProviderAccess

IMixedRealityInputSystem

IMixedRealityEventSystem

IMixedRealityService

IDisposable

IMixedRealityCapabilityCheck