Class BaseInputSimulationService

Base class for services that create simulated input devices.

Inheritance
Object
BaseService
BaseDataProvider<IMixedRealityInputSystem>
BaseInputDeviceManager
BaseInputSimulationService
InputPlaybackService
InputSimulationService
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseInputSimulationService : BaseInputDeviceManager, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable

Constructors

BaseInputSimulationService(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.")]
protected BaseInputSimulationService(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.

BaseInputSimulationService(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.")]
protected BaseInputSimulationService(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.

BaseInputSimulationService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration
protected BaseInputSimulationService(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.

BaseInputSimulationService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration
protected BaseInputSimulationService(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.

Methods

GetActiveControllers()

Declaration
public override IMixedRealityController[] GetActiveControllers()
Returns
Type Description
IMixedRealityController[]
Overrides

GetActiveControllers()

Declaration
public override IMixedRealityController[] GetActiveControllers()
Returns
Type Description
IMixedRealityController[]
Overrides

GetHandDevice(Handedness)

Declaration
public SimulatedHand GetHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness
Returns
Type Description
SimulatedHand

GetHandDevice(Handedness)

Declaration
public SimulatedHand GetHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness
Returns
Type Description
SimulatedHand

GetOrAddHandDevice(Handedness, HandSimulationMode)

Declaration
protected SimulatedHand GetOrAddHandDevice(Handedness handedness, HandSimulationMode simulationMode)
Parameters
Type Name Description
Handedness handedness
HandSimulationMode simulationMode
Returns
Type Description
SimulatedHand

GetOrAddHandDevice(Handedness, HandSimulationMode)

Declaration
protected SimulatedHand GetOrAddHandDevice(Handedness handedness, HandSimulationMode simulationMode)
Parameters
Type Name Description
Handedness handedness
HandSimulationMode simulationMode
Returns
Type Description
SimulatedHand

RemoveAllHandDevices()

Declaration
protected void RemoveAllHandDevices()

RemoveAllHandDevices()

Declaration
protected void RemoveAllHandDevices()

RemoveHandDevice(Handedness)

Declaration
protected void RemoveHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness

RemoveHandDevice(Handedness)

Declaration
protected void RemoveHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness

UpdateHandDevice(HandSimulationMode, Handedness, SimulatedHandData)

Declaration
protected void UpdateHandDevice(HandSimulationMode simulationMode, Handedness handedness, SimulatedHandData handData)
Parameters
Type Name Description
HandSimulationMode simulationMode
Handedness handedness
SimulatedHandData handData

UpdateHandDevice(HandSimulationMode, Handedness, SimulatedHandData)

Declaration
protected void UpdateHandDevice(HandSimulationMode simulationMode, Handedness handedness, SimulatedHandData handData)
Parameters
Type Name Description
HandSimulationMode simulationMode
Handedness handedness
SimulatedHandData handData

Implements

IDisposable