Class BaseInputDeviceManager
Class providing a base implementation of the IMixedRealityInputDeviceManager interface.
Inheritance
Implements
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseInputDeviceManager : BaseDataProvider<IMixedRealityInputSystem>, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable
Constructors
BaseInputDeviceManager(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 BaseInputDeviceManager(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. |
BaseInputDeviceManager(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)
Constructor.
Declaration
protected BaseInputDeviceManager(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
EnablePointerCache
Control mechanism to enable/disable use of Pointer Cache in request/recycling of pointers by Input System
Declaration
public bool EnablePointerCache { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
InputSystemProfile
The input system configuration profile in use in the application.
Declaration
protected MixedRealityInputSystemProfile InputSystemProfile { get; }
Property Value
Type | Description |
---|---|
MixedRealityInputSystemProfile |
Methods
Destroy()
Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.
Declaration
public override void Destroy()
Overrides
GetActiveControllers()
Retrieve all controllers currently registered with this device at runtime (if direct access is required)
Declaration
public virtual IMixedRealityController[] GetActiveControllers()
Returns
Type | Description |
---|---|
IMixedRealityController[] |
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
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.
Declaration
protected virtual void RecyclePointers(IMixedRealityInputSource inputSource)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityInputSource | inputSource |
RequestPointers(SupportedControllerType, Handedness)
Request an array of pointers for the controller type.
Declaration
protected virtual IMixedRealityPointer[] RequestPointers(SupportedControllerType controllerType, Handedness controllingHand)
Parameters
Type | Name | Description |
---|---|---|
SupportedControllerType | controllerType | The controller type making the request for pointers. |
Handedness | controllingHand | The handedness of the controller making the request. |
Returns
Type | Description |
---|---|
IMixedRealityPointer[] |