MixedRealityInputSystem Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The Mixed Reality Toolkit's specific implementation of the IMixedRealityInputSystem
public ref class MixedRealityInputSystem : Microsoft::MixedReality::Toolkit::BaseDataProviderAccessCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityCapabilityCheck, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputSystem[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/overview")]
public class MixedRealityInputSystem : Microsoft.MixedReality.Toolkit.BaseDataProviderAccessCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityCapabilityCheck, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/input/overview")>]
type MixedRealityInputSystem = class
inherit BaseDataProviderAccessCoreSystem
interface IMixedRealityInputSystem
interface IMixedRealityEventSystem
interface IMixedRealityService
interface IDisposable
interface IMixedRealityCapabilityCheckPublic Class MixedRealityInputSystem
Inherits BaseDataProviderAccessCoreSystem
Implements IDisposable, IMixedRealityCapabilityCheck, IMixedRealityInputSystem- Inheritance
-
MixedRealityInputSystem
- Attributes
-
UnityEngine.HelpURLAttribute
- Implements
Constructors
| MixedRealityInputSystem(IMixedRealityServiceRegistrar, MixedRealityInputSystemProfile) |
Obsolete.
Constructor. |
| MixedRealityInputSystem(MixedRealityInputSystemProfile) |
Constructor. |
Fields
| DefaultPriority | (Inherited from BaseService) |
| disposed |
Value indicating if the object has completed disposal. (Inherited from BaseService) |
Properties
| ConfigurationProfile |
The configuration profile for the service. (Inherited from BaseService) |
| DetectedControllers |
List of IMixedRealityControllers currently detected by the input manager. |
| DetectedInputSources |
List of the Interaction Input Sources as detected by the input manager like hands or motion controllers. |
| EventHandlersByType |
List of all event handlers grouped by type that are registered to this Event System. (Inherited from BaseEventSystem) |
| EventListeners |
List of event listeners that are registered to this Event System. (Inherited from BaseEventSystem) |
| EyeGazeProvider |
The current Eye Gaze Provider that's been implemented by this Input System. |
| FocusProvider |
The current Focus Provider that's been implemented by this Input System. |
| GazeProvider |
The current Gaze Provider that's been implemented by this Input System. |
| InputSystemProfile |
Typed representation of the ConfigurationProfile property. |
| IsEnabled |
Indicates whether or not the service is currently enabled. (Inherited from BaseService) |
| IsInitialized |
Indicates whether or not the service has been initialized. (Inherited from BaseService) |
| IsInputEnabled |
Indicates if input is currently enabled or not. |
| IsMarkedDestroyed |
Indicates whether or not the Destroy method been called on this service. (Inherited from BaseService) |
| Name |
Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. |
| Priority |
Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. |
| RaycastProvider |
The current Raycast Provider that's been implemented by this Input System. |
| Registrar |
Obsolete.
The service registrar instance that registered this service. (Inherited from BaseCoreSystem) |
Methods
| CheckCapability(MixedRealityCapability) |
Checks to see if one or more registered data providers supports the requested capability on the current platform. |
| ClearFallbackInputStack() |
Clear all fallback input handlers off the stack. |
| ClearInputDisableStack() |
Clear the input disable stack, which will immediately re-enable input. |
| ClearModalInputStack() |
Clear all modal input handlers off the stack. |
| Destroy() | |
| Disable() |
Optional Disable function to pause the service. |
| Dispose() |
Cleanup resources used by this object. (Inherited from BaseService) |
| Dispose(Boolean) |
Cleanup resources used by the object (Inherited from BaseService) |
| Enable() |
Optional Enable function to enable / re-enable the service. |
| GenerateNewSourceId() |
Generates a new unique input source id. |
| GetDataProvider(String) |
Get the data provider that is registered under the specified name. (Inherited from BaseDataProviderAccessCoreSystem) |
| GetDataProvider<T>(String) |
Get the data provider that is registered under the specified name (optional) and matching the specified type. |
| GetDataProviders() |
Gets the collection of registered data providers. (Inherited from BaseDataProviderAccessCoreSystem) |
| GetDataProviders<T>() |
Get the collection of registered observers of the specified type. |
| HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>) |
The main function for handling and forwarding all events to their intended recipients. |
| Initialize() |
The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit. |
| LateUpdate() | |
| LateUpdate() | (Inherited from BaseDataProviderAccessCoreSystem) |
| PopFallbackInputHandler() |
Remove the last game object from the fallback input stack. |
| PopInputDisable() |
Pop disabled input state. When the last disabled state is popped off the stack input will be re-enabled. |
| PopModalInputHandler() |
Remove the last game object from the modal input stack. |
| 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. |
| 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. |
| 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. |
| RaiseDictationComplete(IMixedRealityInputSource, String, AudioClip) | System.Object.RaiseDictationComplete(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,System.String,UnityEngine.AudioClip) |
| RaiseDictationError(IMixedRealityInputSource, String, AudioClip) | System.Object.RaiseDictationError(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,System.String,UnityEngine.AudioClip) |
| RaiseDictationHypothesis(IMixedRealityInputSource, String, AudioClip) | System.Object.RaiseDictationHypothesis(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,System.String,UnityEngine.AudioClip) |
| RaiseDictationResult(IMixedRealityInputSource, String, AudioClip) | System.Object.RaiseDictationResult(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,System.String,UnityEngine.AudioClip) |
| RaiseFloatInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Single) |
Raise Float Input Changed. |
| RaiseFocusChanged(IMixedRealityPointer, GameObject, GameObject) |
Raise the focus changed event. |
| RaiseFocusEnter(IMixedRealityPointer, GameObject) |
Raise the focus enter event. |
| RaiseFocusExit(IMixedRealityPointer, GameObject) |
Raise the focus exit event. |
| RaiseGestureCanceled(IMixedRealityController, MixedRealityInputAction) |
Raise the Gesture Canceled Event. |
| RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, MixedRealityPose) |
Raise the Gesture Completed Event. |
| RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Quaternion) |
Raise the Gesture Completed Event. |
| RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector2) |
Raise the Gesture Completed Event. |
| RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction, Vector3) |
Raise the Gesture Completed Event. |
| RaiseGestureCompleted(IMixedRealityController, MixedRealityInputAction) |
Raise the Gesture Completed Event. |
| RaiseGestureStarted(IMixedRealityController, MixedRealityInputAction) |
Raise the Gesture Started Event. |
| RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, MixedRealityPose) |
Raise the Gesture Updated Event. |
| RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Quaternion) |
Raise the Gesture Updated Event. |
| RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector2) |
Raise the Gesture Updated Event. |
| RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction, Vector3) |
Raise the Gesture Updated Event. |
| RaiseGestureUpdated(IMixedRealityController, MixedRealityInputAction) |
Raise the Gesture Updated Event. |
| RaiseHandJointsUpdated(IMixedRealityInputSource, Handedness, IDictionary<TrackedHandJoint,MixedRealityPose>) | |
| RaiseHandMeshUpdated(IMixedRealityInputSource, Handedness, HandMeshInfo) | |
| RaiseOnInputDown(IMixedRealityInputSource, Handedness, MixedRealityInputAction) |
Raise the input down event. |
| RaiseOnInputUp(IMixedRealityInputSource, Handedness, MixedRealityInputAction) |
Raise the input up event. |
| RaiseOnTouchCompleted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3) | System.Object.RaiseOnTouchCompleted(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,Microsoft.MixedReality.Toolkit.Input.IMixedRealityController,Microsoft.MixedReality.Toolkit.Utilities.Handedness,UnityEngine.Vector3) |
| RaiseOnTouchStarted(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3) | System.Object.RaiseOnTouchStarted(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,Microsoft.MixedReality.Toolkit.Input.IMixedRealityController,Microsoft.MixedReality.Toolkit.Utilities.Handedness,UnityEngine.Vector3) |
| RaiseOnTouchUpdated(IMixedRealityInputSource, IMixedRealityController, Handedness, Vector3) | System.Object.RaiseOnTouchUpdated(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,Microsoft.MixedReality.Toolkit.Input.IMixedRealityController,Microsoft.MixedReality.Toolkit.Utilities.Handedness,UnityEngine.Vector3) |
| RaisePointerClicked(IMixedRealityPointer, MixedRealityInputAction, Int32, Handedness, IMixedRealityInputSource) | |
| RaisePointerDown(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource) |
Raise the pointer down event. |
| RaisePointerDragged(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource) |
Raise the pointer dragged event. |
| RaisePointerUp(IMixedRealityPointer, MixedRealityInputAction, Handedness, IMixedRealityInputSource) |
Raise the pointer up event. |
| RaisePoseInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, MixedRealityPose) |
Raise the 6 degrees of freedom input event. |
| RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector2) |
Raise the 2 degrees of freedom input event. |
| RaisePositionInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Vector3) |
Raise the 3 degrees of freedom input event. |
| RaisePreFocusChanged(IMixedRealityPointer, GameObject, GameObject) |
Raise the pre-focus changed event. |
| RaiseRotationInputChanged(IMixedRealityInputSource, Handedness, MixedRealityInputAction, Quaternion) |
Raise the 3 degrees of freedom input event. |
| RaiseSourceDetected(IMixedRealityInputSource, IMixedRealityController) |
Raise the event that the Input Source was detected. |
| RaiseSourceLost(IMixedRealityInputSource, IMixedRealityController) |
Raise the event that the Input Source was lost. |
| RaiseSourcePoseChanged(IMixedRealityInputSource, IMixedRealityController, MixedRealityPose) |
Raise the event that the Input Source position was changed. |
| RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector2) |
Raise the event that the Input Source position was changed. |
| RaiseSourcePositionChanged(IMixedRealityInputSource, IMixedRealityController, Vector3) |
Raise the event that the Input Source position was changed. |
| RaiseSourceRotationChanged(IMixedRealityInputSource, IMixedRealityController, Quaternion) |
Raise the event that the Input Source position was changed. |
| RaiseSourceTrackingStateChanged(IMixedRealityInputSource, IMixedRealityController, TrackingState) |
Raise the event that the Input Source's tracking state has changed. |
| RaiseSpeechCommandRecognized(IMixedRealityInputSource, RecognitionConfidenceLevel, TimeSpan, DateTime, SpeechCommands) | System.Object.RaiseSpeechCommandRecognized(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSource,Microsoft.MixedReality.Toolkit.Utilities.RecognitionConfidenceLevel,System.TimeSpan,System.DateTime,Microsoft.MixedReality.Toolkit.Input.SpeechCommands) |
| 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. |
| RegisterDataProvider<T>(T) |
Registers a service of the specified type. (Inherited from BaseDataProviderAccessCoreSystem) |
| RegisterDataProvider<T>(Type, String, SupportedPlatforms, Object[]) |
Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem) |
| RegisterDataProvider<T>(Type, SupportedPlatforms, Object[]) |
Obsolete.
Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem) |
| RegisterHandler<T>(IEventSystemHandler) |
Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem) |
| RequestNewGenericInputSource(String, IMixedRealityPointer[], InputSourceType) | System.Object.RequestNewGenericInputSource(System.String,Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointer[],Microsoft.MixedReality.Toolkit.Input.InputSourceType) |
| RequestNewGlobalInputSource(String, IMixedRealityFocusProvider, InputSourceType) | System.Object.RequestNewGlobalInputSource(System.String,Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusProvider,Microsoft.MixedReality.Toolkit.Input.InputSourceType) |
| Reset() |
Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. |
| Unregister(GameObject) |
Unregister a GameObject from listening to input events. |
| UnregisterDataProvider<T>(String) |
Unregisters a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem) |
| UnregisterDataProvider<T>(T) |
Unregisters a data provider. (Inherited from BaseDataProviderAccessCoreSystem) |
| UnregisterHandler<T>(IEventSystemHandler) |
Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem) |
| Update() | (Inherited from BaseDataProviderAccessCoreSystem) |
Events
| InputDisabled |
Event that's raised when the Input is disabled. |
| InputEnabled |
Event that's raised when the Input is enabled. |