We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class MouseDeviceManager

    Inheritance
    Object
    BaseService
    BaseDataProvider
    BaseInputDeviceManager
    MouseDeviceManager
    Implements
    IMixedRealityInputDeviceManager
    IMixedRealityDataProvider
    IMixedRealityService
    IDisposable
    IMixedRealityMouseDeviceManager
    IMixedRealityInputDeviceManager
    Inherited Members
    BaseInputDeviceManager.InputSystem
    BaseInputDeviceManager.InputSystemProfile
    BaseInputDeviceManager.GetActiveControllers()
    BaseInputDeviceManager.RequestPointers(SupportedControllerType, Handedness)
    BaseDataProvider.Registrar
    BaseDataProvider.Service
    BaseService.DefaultPriority
    BaseService.Name
    BaseService.Priority
    BaseService.ConfigurationProfile
    BaseService.Reset()
    BaseService.LateUpdate()
    BaseService.Destroy()
    BaseService.disposed
    BaseService.Dispose()
    BaseService.Dispose(Boolean)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Input.UnityInput
    Assembly: cs.temp.dll.dll
    Syntax
    public class MouseDeviceManager : BaseInputDeviceManager, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable, IMixedRealityMouseDeviceManager, IMixedRealityInputDeviceManager

    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

    Declaration
    public float CursorSpeed { get; set; }
    Property Value
    Type Description
    Single

    MouseInputProfile

    Declaration
    public MixedRealityMouseInputProfile MouseInputProfile { get; }
    Property Value
    Type Description
    MixedRealityMouseInputProfile

    WheelSpeed

    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
    BaseService.Disable()

    Enable()

    Optional Enable function to enable / re-enable the service.

    Declaration
    public override void Enable()
    Overrides
    BaseService.Enable()

    Initialize()

    Declaration
    public override void Initialize()
    Overrides
    BaseService.Initialize()

    Update()

    Optional Update function to perform per-frame updates of the service.

    Declaration
    public override void Update()
    Overrides
    BaseService.Update()

    Implements

    IMixedRealityInputDeviceManager
    IMixedRealityDataProvider
    IMixedRealityService
    IDisposable
    IMixedRealityMouseDeviceManager
    IMixedRealityInputDeviceManager
    Back to top Generated by DocFX