Class MouseDeviceManager
Inheritance
Implements
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input.UnityInput
Assembly: cs.temp.dll.dll
Syntax
[MixedRealityDataProvider(typeof(IMixedRealityInputSystem), null, "Unity Mouse Device Manager", "Profiles/DefaultMixedRealityMouseInputProfile.asset", "MixedRealityToolkit.SDK", true)]
public class MouseDeviceManager : BaseInputDeviceManager, IMixedRealityMouseDeviceManager, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable
Constructors
MouseDeviceManager(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 MouseDeviceManager(IMixedRealityServiceRegistrar registrar, IMixedRealityInputSystem inputSystem, string name = null, uint priority = 10U, BaseMixedRealityProfile profile = null)
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. |
MouseDeviceManager(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)
Constructor.
Declaration
public MouseDeviceManager(IMixedRealityInputSystem inputSystem, string name = null, uint priority = 10U, BaseMixedRealityProfile profile = null)
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
Controller
Current Mouse Controller.
Declaration
public MouseController Controller { get; }
Property Value
Type | Description |
---|---|
MouseController |
CursorSpeed
Gets or sets a multiplier value used to adjust the speed of the mouse cursor.
Declaration
public float CursorSpeed { get; set; }
Property Value
Type | Description |
---|---|
Single |
MouseInputProfile
Typed representation of the ConfigurationProfile property.
Declaration
public MixedRealityMouseInputProfile MouseInputProfile { get; }
Property Value
Type | Description |
---|---|
MixedRealityMouseInputProfile |
WheelSpeed
Gets or sets a multiplier value used to adjust the speed of the mouse wheel.
Declaration
public float WheelSpeed { get; set; }
Property Value
Type | Description |
---|---|
Single |
Methods
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
Update()
Optional Update function to perform per-frame updates of the service.
Declaration
public override void Update()