InputActionHandler Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Input

Assembly:: Microsoft.MixedReality.Toolkit.SDK.dll

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.

Script used to handle input action events. Invokes Unity events when the configured input action starts or ends.

public ref class InputActionHandler : Microsoft::MixedReality::Toolkit::Input::BaseInputHandler, Microsoft::MixedReality::Toolkit::Input::IMixedRealityInputActionHandler, UnityEngine::EventSystems::IEventSystemHandler

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/InputActionHandler")]
public class InputActionHandler : Microsoft.MixedReality.Toolkit.Input.BaseInputHandler, Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputActionHandler, UnityEngine.EventSystems.IEventSystemHandler

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/InputActionHandler")>]
type InputActionHandler = class
    inherit BaseInputHandler
    interface IMixedRealityInputActionHandler
    interface IMixedRealityBaseInputHandler
    interface IEventSystemHandler

Public Class InputActionHandler
Inherits BaseInputHandler
Implements IEventSystemHandler, IMixedRealityInputActionHandler

Inheritance: UnityEngine.MonoBehaviour

InputSystemGlobalHandlerListener

BaseInputHandler
InputActionHandler

Attributes: UnityEngine.AddComponentMenuAttribute

Implements: IMixedRealityBaseInputHandler IMixedRealityInputActionHandler UnityEngine.EventSystems.IEventSystemHandler

Constructors

InputActionHandler()

Fields

OnInputActionEnded	Unity event raised on action end, e.g. button released or gesture completed. Includes the input event that triggered the action.
OnInputActionStarted	Unity event raised on action start, e.g. button pressed or gesture started. Includes the input event that triggered the action.

Properties

IsFocusRequired

Is Focus required to receive input events on this GameObject?

(Inherited from BaseInputHandler)

Methods

EnsureInputSystemValid()	A task that will only complete when the input system has in a valid state. (Inherited from InputSystemGlobalHandlerListener)
OnDisable()	(Inherited from BaseInputHandler)
OnEnable()	(Inherited from BaseInputHandler)
RegisterHandlers()	Overload this method to specify, which global events component wants to listen to. Use RegisterHandler API of InputSystem
Start()	(Inherited from BaseInputHandler)
UnregisterHandlers()	Overload this method to specify, which global events component should stop listening to. Use UnregisterHandler API of InputSystem
Update()	(Inherited from BaseInputHandler)

Explicit Interface Implementations

IMixedRealityInputActionHandler.OnActionEnded(BaseInputEventData)
IMixedRealityInputActionHandler.OnActionStarted(BaseInputEventData)

Applies to

Share via