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(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()

Retrieve all controllers currently registered with this device at runtime (if direct access is required)

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

GetControllerDevice(Handedness)

Declaration
public BaseController GetControllerDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness
Returns
Type Description
BaseController

GetHandDevice(Handedness)

Declaration
[Obsolete("Use GetControllerDevice instead.")]
public SimulatedHand GetHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness
Returns
Type Description
SimulatedHand

GetOrAddControllerDevice(Handedness, ControllerSimulationMode)

Declaration
protected BaseController GetOrAddControllerDevice(Handedness handedness, ControllerSimulationMode simulationMode)
Parameters
Type Name Description
Handedness handedness
ControllerSimulationMode simulationMode
Returns
Type Description
BaseController

GetOrAddHandDevice(Handedness, ControllerSimulationMode)

Declaration
[Obsolete("Use GetOrAddControllerDevice instead.")]
protected SimulatedHand GetOrAddHandDevice(Handedness handedness, ControllerSimulationMode simulationMode)
Parameters
Type Name Description
Handedness handedness
ControllerSimulationMode simulationMode
Returns
Type Description
SimulatedHand

RemoveAllControllerDevices()

Declaration
protected void RemoveAllControllerDevices()

RemoveAllHandDevices()

Declaration
[Obsolete("Use RemoveAllControllerDevices instead.")]
protected void RemoveAllHandDevices()

RemoveControllerDevice(Handedness)

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

RemoveHandDevice(Handedness)

Declaration
[Obsolete("Use RemoveControllerDevice instead.")]
protected void RemoveHandDevice(Handedness handedness)
Parameters
Type Name Description
Handedness handedness

UpdateControllerDevice(ControllerSimulationMode, Handedness, Object)

Declaration
protected void UpdateControllerDevice(ControllerSimulationMode simulationMode, Handedness handedness, object controllerData)
Parameters
Type Name Description
ControllerSimulationMode simulationMode
Handedness handedness
Object controllerData

UpdateHandDevice(ControllerSimulationMode, Handedness, SimulatedHandData)

Declaration
[Obsolete("Use UpdateControllerDevice instead.")]
protected void UpdateHandDevice(ControllerSimulationMode simulationMode, Handedness handedness, SimulatedHandData handData)
Parameters
Type Name Description
ControllerSimulationMode simulationMode
Handedness handedness
SimulatedHandData handData

Implements