Class InputSimulationService

Service that provides simulated mixed reality input information based on mouse and keyboard input in editor

Inheritance
Object
BaseService
BaseDataProvider<IMixedRealityInputSystem>
BaseInputDeviceManager
BaseInputSimulationService
InputSimulationService
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class InputSimulationService : BaseInputSimulationService, 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

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
public Vector3 HandPositionLeft { get; set; }
Property Value
Type Description
Vector3

HandPositionRight

Position of the right hand in view space.

Declaration
public Vector3 HandPositionRight { get; set; }
Property Value
Type Description
Vector3

HandRotationLeft

Rotation euler angles of the left hand in view space.

Declaration
public Vector3 HandRotationLeft { get; set; }
Property Value
Type Description
Vector3

HandRotationRight

Rotation euler angles of the right hand in view space.

Declaration
public Vector3 HandRotationRight { get; set; }
Property Value
Type Description
Vector3

HandSimulationMode

Simulated hand behavior.

Declaration
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

IsAlwaysVisibleHandLeft

The left hand is always tracking.

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

IsAlwaysVisibleHandRight

The right hand is always tracking.

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

IsSimulatingHandLeft

The left hand is controlled by user input.

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

IsSimulatingHandRight

The right hand is controlled by user input.

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

SimulateEyePosition

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

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

UserInputEnabled

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

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

Disable()

Optional Disable function to pause the service.

Declaration
public override void Disable()
Overrides

Enable()

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

Declaration
public override void Enable()
Overrides

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

LateUpdate()

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

Declaration
public override void LateUpdate()
Overrides

ResetHandLeft()

Reset the left hand.

Declaration
public void ResetHandLeft()

ResetHandRight()

Reset the right hand.

Declaration
public void ResetHandRight()

Update()

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

Declaration
public override void Update()
Overrides

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

IDisposable