Class MixedRealityInputModule

Inheritance
Object
MixedRealityInputModule
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityInputModule : StandaloneInputModule, IMixedRealityPointerHandler, IMixedRealitySourceStateHandler, IEventSystemHandler

Fields

pointerDataToRemove

List of pointers that need one last frame of updates to remove

Declaration
protected readonly List<MixedRealityInputModule.PointerData> pointerDataToRemove
Field Value
Type Description
List<MixedRealityInputModule.PointerData>

pointerDataToUpdate

Mapping from pointer id to event data and click state

Declaration
protected readonly Dictionary<int, MixedRealityInputModule.PointerData> pointerDataToUpdate
Field Value
Type Description
Dictionary<Int32, MixedRealityInputModule.PointerData>

Properties

ActiveMixedRealityPointers

Declaration
public IEnumerable<IMixedRealityPointer> ActiveMixedRealityPointers { get; }
Property Value
Type Description
IEnumerable<IMixedRealityPointer>

ManualInitializationRequired

Whether the input module is auto initialized by event system or requires a manual call to Initialize()

Declaration
public bool ManualInitializationRequired { get; }
Property Value
Type Description
Boolean

ProcessPaused

Whether the input module should pause processing temporarily

Declaration
public bool ProcessPaused { get; set; }
Property Value
Type Description
Boolean

RaycastCamera

Declaration
public Camera RaycastCamera { get; }
Property Value
Type Description
Camera

Methods

ActivateModule()

Declaration
public override void ActivateModule()

DeactivateModule()

Declaration
public override void DeactivateModule()

GetMousePointerEventData(Int32)

Adds MRTK pointer support as mouse input for Unity UI.

Declaration
protected override MouseState GetMousePointerEventData(int pointerId)
Parameters
Type Name Description
Int32 pointerId
Returns
Type Description
MouseState

Initialize()

Initialize the input module.

Declaration
public void Initialize()

IsModuleSupported()

Declaration
public override bool IsModuleSupported()
Returns
Type Description
Boolean

Process()

Process the active pointers from MixedRealityInputManager and all other Unity input.

Declaration
public override void Process()

ResetMousePointerEventData(MixedRealityInputModule.PointerData)

Declaration
protected void ResetMousePointerEventData(MixedRealityInputModule.PointerData pointerData)
Parameters
Type Name Description
MixedRealityInputModule.PointerData pointerData

StateForPointer(MixedRealityInputModule.PointerData)

Declaration
protected PointerEventData.FramePressState StateForPointer(MixedRealityInputModule.PointerData pointerData)
Parameters
Type Name Description
MixedRealityInputModule.PointerData pointerData
Returns
Type Description
PointerEventData.FramePressState

Suspend()

Suspend the input module when a runtime profile change is about to happen.

Declaration
public void Suspend()

UpdateMousePointerEventData(MixedRealityInputModule.PointerData)

Declaration
protected void UpdateMousePointerEventData(MixedRealityInputModule.PointerData pointerData)
Parameters
Type Name Description
MixedRealityInputModule.PointerData pointerData

Explicit Interface Implementations

IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData)

Declaration
void IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData eventData)
Parameters
Type Name Description
MixedRealityPointerEventData eventData

IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData)

Declaration
void IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData eventData)
Parameters
Type Name Description
MixedRealityPointerEventData eventData

IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData)

Declaration
void IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData eventData)
Parameters
Type Name Description
MixedRealityPointerEventData eventData

IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData)

Declaration
void IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData eventData)
Parameters
Type Name Description
MixedRealityPointerEventData eventData

IMixedRealitySourceStateHandler.OnSourceDetected(SourceStateEventData)

Declaration
void IMixedRealitySourceStateHandler.OnSourceDetected(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

IMixedRealitySourceStateHandler.OnSourceLost(SourceStateEventData)

Declaration
void IMixedRealitySourceStateHandler.OnSourceLost(SourceStateEventData eventData)
Parameters
Type Name Description
SourceStateEventData eventData

Implements

IEventSystemHandler