BaseInputSimulationService Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Input

Assembly:

Microsoft.MixedReality.Toolkit.Services.InputSimulation.dll

Base class for services that create simulated input devices.

public ref class BaseInputSimulationService abstract : Microsoft::MixedReality::Toolkit::Input::BaseInputDeviceManager

public abstract class BaseInputSimulationService : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager

type BaseInputSimulationService = class
    inherit BaseInputDeviceManager

Public MustInherit Class BaseInputSimulationService
Inherits BaseInputDeviceManager

Inheritance

Object

BaseService

BaseDataProvider<IMixedRealityInputSystem>

BaseInputDeviceManager

BaseInputSimulationService

Derived

Microsoft.MixedReality.Toolkit.Input.InputPlaybackService

Microsoft.MixedReality.Toolkit.Input.InputSimulationService

Constructors

BaseInputSimulationService(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)	Constructor.
BaseInputSimulationService(IMixedRealityServiceRegistrar, IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)	Obsolete. Constructor.

Fields

DefaultPriority	(Inherited from BaseService)
disposed	Value indicating if the object has completed disposal. (Inherited from BaseService)

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from BaseService)
EnablePointerCache	Control mechanism to enable/disable use of Pointer Cache in request/recycling of pointers by Input System (Inherited from BaseInputDeviceManager)
InputSystemProfile	The input system configuration profile in use in the application. (Inherited from BaseInputDeviceManager)
IsEnabled	Indicates whether or not the service is currently enabled. (Inherited from BaseService)
IsInitialized	Indicates whether or not the service has been initialized. (Inherited from BaseService)
IsMarkedDestroyed	Indicates whether or not the Destroy method been called on this service. (Inherited from BaseService)
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from BaseService)
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from BaseService)
Registrar	Obsolete. The service registrar instance that registered this service. (Inherited from BaseDataProvider<T>)
Service	The service instance to which this provider is providing data. (Inherited from BaseDataProvider<T>)

Methods

Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from BaseInputDeviceManager)
Disable()	Optional Disable function to pause the service. (Inherited from BaseService)
Dispose()	Cleanup resources used by this object. (Inherited from BaseService)
Dispose(Boolean)	Cleanup resources used by the object (Inherited from BaseService)
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from BaseService)
GetActiveControllers()	Retrieve all controllers currently registered with this device at runtime (if direct access is required)
GetControllerDevice(Handedness)
GetHandDevice(Handedness)
GetOrAddControllerDevice(Handedness, ControllerSimulationMode)
GetOrAddHandDevice(Handedness, ControllerSimulationMode)
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. (Inherited from BaseInputDeviceManager)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from BaseService)
RecyclePointers(IMixedRealityInputSource)	Recycle all pointers associated with the provided IMixedRealityInputSource. This involves reseting the pointer, disabling the pointer GameObject, and possibly caching it for re-use. (Inherited from BaseInputDeviceManager)
RemoveAllControllerDevices()
RemoveAllHandDevices()
RemoveControllerDevice(Handedness)
RemoveHandDevice(Handedness)
RequestPointers(SupportedControllerType, Handedness)	Request an array of pointers for the controller type. (Inherited from BaseInputDeviceManager)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from BaseService)
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from BaseService)
UpdateControllerDevice(ControllerSimulationMode, Handedness, Object)
UpdateHandDevice(ControllerSimulationMode, Handedness, SimulatedHandData)