MouseDeviceManager Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public ref class MouseDeviceManager : Microsoft::MixedReality::Toolkit::Input::BaseInputDeviceManager, IDisposable, Microsoft::MixedReality::Toolkit::Input::IMixedRealityMouseDeviceManager
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Unity Mouse Device Manager", "Profiles/DefaultMixedRealityMouseInputProfile.asset", "MixedRealityToolkit.SDK", true)]
public class MouseDeviceManager : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityMouseDeviceManager
[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Unity Mouse Device Manager", "Profiles/DefaultMixedRealityMouseInputProfile.asset", "MixedRealityToolkit.SDK", true, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class MouseDeviceManager : Microsoft.MixedReality.Toolkit.Input.BaseInputDeviceManager, IDisposable, Microsoft.MixedReality.Toolkit.Input.IMixedRealityMouseDeviceManager
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Unity Mouse Device Manager", "Profiles/DefaultMixedRealityMouseInputProfile.asset", "MixedRealityToolkit.SDK", true)>]
type MouseDeviceManager = class
inherit BaseInputDeviceManager
interface IMixedRealityMouseDeviceManager
interface IMixedRealityInputDeviceManager
interface IMixedRealityDataProvider
interface IMixedRealityService
interface IDisposable
[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.Input.IMixedRealityInputSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.LinuxStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Lumin | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.MacStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Web | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsEditor | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsStandalone | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.WindowsUniversal, "Unity Mouse Device Manager", "Profiles/DefaultMixedRealityMouseInputProfile.asset", "MixedRealityToolkit.SDK", true, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type MouseDeviceManager = class
inherit BaseInputDeviceManager
interface IMixedRealityMouseDeviceManager
interface IMixedRealityInputDeviceManager
interface IMixedRealityDataProvider
interface IMixedRealityService
interface IDisposable
Public Class MouseDeviceManager
Inherits BaseInputDeviceManager
Implements IDisposable, IMixedRealityMouseDeviceManager
- Inheritance
-
MouseDeviceManager
- Attributes
- Implements
Constructors
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) |
Controller |
Current Mouse Controller. |
CursorSpeed |
Gets or sets a multiplier value used to adjust the speed of the mouse cursor. |
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) |
MouseInputProfile |
Typed representation of the ConfigurationProfile property. |
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>) |
WheelSpeed |
Gets or sets a multiplier value used to adjust the speed of the mouse wheel. |
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. |
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. |
GetActiveControllers() |
Retrieve all controllers currently registered with this device at runtime (if direct access is required) (Inherited from BaseInputDeviceManager) |
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. |
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) |
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. |