public class InputSimulationService : BaseInputSimulationService, IMixedRealityServiceState, IInputSimulationService, IMixedRealityEyeGazeDataProvider, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable, IMixedRealityCapabilityCheck

Constructors

InputSimulationService(IMixedRealityServiceRegistrar, IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
public InputSimulationService(IMixedRealityServiceRegistrar registrar, IMixedRealityInputSystem inputSystem, string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the data provider.
IMixedRealityInputSystem	inputSystem	The IMixedRealityInputSystem instance that receives data from this provider.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

InputSimulationService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public InputSimulationService(IMixedRealityInputSystem inputSystem, string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
IMixedRealityInputSystem	inputSystem	The IMixedRealityInputSystem instance that receives data from this provider.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

Properties

ControllerPositionLeft

Position of the left controller in view space.

Declaration

public Vector3 ControllerPositionLeft { get; set; }

Property Value

Type	Description
Vector3

ControllerPositionRight

Position of the right controller in view space.

Declaration

public Vector3 ControllerPositionRight { get; set; }

Property Value

Type	Description
Vector3

ControllerRotationLeft

Rotation euler angles of the left controller in view space.

Declaration

public Vector3 ControllerRotationLeft { get; set; }

Property Value

Type	Description
Vector3

ControllerRotationRight

Rotation euler angles of the right controller in view space.

Declaration

public Vector3 ControllerRotationRight { get; set; }

Property Value

Type	Description
Vector3

ControllerSimulationMode

Simulated controller behavior.

Declaration

public ControllerSimulationMode ControllerSimulationMode { get; set; }

Property Value

Type	Description
ControllerSimulationMode

EyeGazeSimulationMode

Simulated eye gaze behavior.

Declaration

public EyeGazeSimulationMode EyeGazeSimulationMode { get; set; }

Property Value

Type	Description
EyeGazeSimulationMode

HandDataLeft

Pose data for the left hand.

Declaration

public SimulatedHandData HandDataLeft { get; }

Property Value

Type	Description
SimulatedHandData

HandDataRight

Pose data for the right hand.

Declaration

public SimulatedHandData HandDataRight { get; }

Property Value

Type	Description
SimulatedHandData

HandPositionLeft

Position of the left hand in view space.

Declaration

[Obsolete("Use ControllerPositionLeft instead.")]
public Vector3 HandPositionLeft { get; set; }

Property Value

Type	Description
Vector3

HandPositionRight

Position of the right hand in view space.

Declaration

[Obsolete("Use ControllerPositionRight instead.")]
public Vector3 HandPositionRight { get; set; }

Property Value

Type	Description
Vector3

HandRotationLeft

Rotation euler angles of the left hand in view space.

Declaration

[Obsolete("Use ControllerRotationLeft instead.")]
public Vector3 HandRotationLeft { get; set; }

Property Value

Type	Description
Vector3

HandRotationRight

Rotation euler angles of the right hand in view space.

Declaration

[Obsolete("Use ControllerRotationRight instead.")]
public Vector3 HandRotationRight { get; set; }

Property Value

Type	Description
Vector3

HandSimulationMode

Simulated hand behavior.

Declaration

[Obsolete("Use ControllerSimulationMode instead.")]
public HandSimulationMode HandSimulationMode { get; set; }

Property Value

Type	Description
HandSimulationMode

InputSimulationProfile

Typed representation of the ConfigurationProfile property.

Declaration

public MixedRealityInputSimulationProfile InputSimulationProfile { get; set; }

Property Value

Type	Description
MixedRealityInputSimulationProfile

IsAlwaysVisibleControllerLeft

The left controller is always tracking.

Declaration

public bool IsAlwaysVisibleControllerLeft { get; set; }

Property Value

Type	Description
Boolean

IsAlwaysVisibleControllerRight

The right controller is always tracking.

Declaration

public bool IsAlwaysVisibleControllerRight { get; set; }

Property Value

Type	Description
Boolean

IsAlwaysVisibleHandLeft

The left hand is always tracking.

Declaration

[Obsolete("Use IsAlwaysVisibleControllerLeft instead.")]
public bool IsAlwaysVisibleHandLeft { get; set; }

Property Value

Type	Description
Boolean

IsAlwaysVisibleHandRight

The right hand is always tracking.

Declaration

[Obsolete("Use IsAlwaysVisibleControllerRight instead.")]
public bool IsAlwaysVisibleHandRight { get; set; }

Property Value

Type	Description
Boolean

IsSimulatingControllerLeft

The left controller is controlled by user input.

Declaration

public bool IsSimulatingControllerLeft { get; }

Property Value

Type	Description
Boolean

IsSimulatingControllerRight

The right controller is controlled by user input.

Declaration

public bool IsSimulatingControllerRight { get; }

Property Value

Type	Description
Boolean

IsSimulatingHandLeft

The left hand is controlled by user input.

Declaration

[Obsolete("Use IsSimulatingControllerLeft instead.")]
public bool IsSimulatingHandLeft { get; }

Property Value

Type	Description
Boolean

IsSimulatingHandRight

The right hand is controlled by user input.

Declaration

[Obsolete("Use IsSimulatingControllerRight instead.")]
public bool IsSimulatingHandRight { get; }

Property Value

Type	Description
Boolean

MotionControllerDataLeft

Pose data for the left motion controller.

Declaration

public SimulatedMotionControllerData MotionControllerDataLeft { get; }

Property Value

Type	Description
SimulatedMotionControllerData

MotionControllerDataRight

Pose data for the right motion controller.

Declaration

public SimulatedMotionControllerData MotionControllerDataRight { get; }

Property Value

Type	Description
SimulatedMotionControllerData

SimulateEyePosition

If true then camera forward direction is used to simulate eye tracking data.

Declaration

[Obsolete("Check the EyeGazeSimulationMode instead")]
public bool SimulateEyePosition { get; set; }

Property Value

Type	Description
Boolean

UserInputEnabled

If true then keyboard and mouse input are used to simulate controllers.

Declaration

public bool UserInputEnabled { get; set; }

Property Value

Type	Description
Boolean

Methods

CheckCapability(MixedRealityCapability)

Checks to see if one or more registered data providers supports the requested capability on the current platform.

Declaration

public bool CheckCapability(MixedRealityCapability capability)

Parameters

Type	Name	Description
MixedRealityCapability	capability	The capability to check.

Returns

Type	Description
Boolean	True if the capability is supported, false otherwise.

Destroy()

Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

Declaration

public override void Destroy()

Overrides

BaseInputDeviceManager.Destroy()

Disable()

Optional Disable function to pause the service.

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Enable()

Optional Enable function to enable / re-enable the service.

Declaration

public override void Enable()

Overrides

BaseService.Enable()

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.

Declaration

public override void Initialize()

Overrides

BaseInputDeviceManager.Initialize()

LateUpdate()

Optional LateUpdate function to that is called after Update has been called on all services.

Declaration

public override void LateUpdate()

Overrides

BaseService.LateUpdate()

ResetControllerLeft()

Reset the left controller.

Declaration

public void ResetControllerLeft()

ResetControllerRight()

Reset the right controller.

Declaration

public void ResetControllerRight()

ResetHandLeft()

Reset the left hand.

Declaration

[Obsolete("Use ResetControllerLeft instead.")]
public void ResetHandLeft()

ResetHandRight()

Reset the right hand.

Declaration

[Obsolete("Use ResetControllerRight instead.")]
public void ResetHandRight()

Update()

Optional Update function to perform per-frame updates of the service.

Declaration

public override void Update()

Overrides

BaseService.Update()

Explicit Interface Implementations

IMixedRealityEyeGazeDataProvider.SaccadeProvider

Declaration

IMixedRealityEyeSaccadeProvider IMixedRealityEyeGazeDataProvider.SaccadeProvider { get; }

Returns

Type	Description
IMixedRealityEyeSaccadeProvider

IMixedRealityEyeGazeDataProvider.SmoothEyeTracking

Declaration

bool IMixedRealityEyeGazeDataProvider.SmoothEyeTracking { get; set; }

Returns

Type	Description
Boolean

Implements

IMixedRealityServiceState

IInputSimulationService

IMixedRealityEyeGazeDataProvider

IMixedRealityInputDeviceManager

IMixedRealityDataProvider

IMixedRealityService

System.IDisposable

IMixedRealityCapabilityCheck