mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class XRSDKDeviceManager

    Manages XR SDK devices.

    Inheritance
    Object
    XRSDKDeviceManager
    Implements
    IMixedRealityCapabilityCheck
    Namespace: Microsoft.MixedReality.Toolkit.XRSDK.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class XRSDKDeviceManager : BaseInputDeviceManager, IMixedRealityCapabilityCheck

    Constructors

    XRSDKDeviceManager(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

    Constructor.

    Declaration
    public XRSDKDeviceManager(IMixedRealityInputSystem inputSystem, string name = null, uint priority = default(uint), 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.

    Fields

    ActiveControllers

    Declaration
    protected static readonly Dictionary<InputDevice, GenericXRSDKController> ActiveControllers
    Field Value
    Type Description
    Dictionary<InputDevice, GenericXRSDKController>

    Methods

    CheckCapability(MixedRealityCapability)

    Declaration
    public virtual bool CheckCapability(MixedRealityCapability capability)
    Parameters
    Type Name Description
    MixedRealityCapability capability
    Returns
    Type Description
    Boolean

    GetControllerType(SupportedControllerType)

    Gets the concrete type of the detected controller, based on the SupportedControllerType and defined per-platform.

    Declaration
    protected virtual Type GetControllerType(SupportedControllerType supportedControllerType)
    Parameters
    Type Name Description
    SupportedControllerType supportedControllerType

    The current controller type.

    Returns
    Type Description
    Type

    The concrete type of the currently detected controller.

    GetCurrentControllerType(InputDevice)

    Gets the current controller type for the InputDevice name provided.

    Declaration
    protected virtual SupportedControllerType GetCurrentControllerType(InputDevice inputDevice)
    Parameters
    Type Name Description
    InputDevice inputDevice

    The InputDevice from XR SDK.

    Returns
    Type Description
    SupportedControllerType

    The supported controller type.

    GetInputSourceType(SupportedControllerType)

    Returns the InputSourceType of the currently detected controller, based on the SupportedControllerType.

    Declaration
    protected virtual InputSourceType GetInputSourceType(SupportedControllerType supportedControllerType)
    Parameters
    Type Name Description
    SupportedControllerType supportedControllerType

    The current controller type.

    Returns
    Type Description
    InputSourceType

    The enum value of the currently detected controller's InputSource type.

    GetOrAddController(InputDevice)

    Gets or adds a controller using the InputDevice name provided.

    Declaration
    protected virtual GenericXRSDKController GetOrAddController(InputDevice inputDevice)
    Parameters
    Type Name Description
    InputDevice inputDevice

    The InputDevice from XR SDK.

    Returns
    Type Description
    GenericXRSDKController

    The controller reference.

    RemoveController(InputDevice)

    Gets the current controller type for the InputDevice name provided.

    Declaration
    protected virtual void RemoveController(InputDevice inputDevice)
    Parameters
    Type Name Description
    InputDevice inputDevice

    The InputDevice from XR SDK.

    Update()

    Declaration
    public override void Update()

    Implements

    IMixedRealityCapabilityCheck
    In This Article
    • Constructors
      • XRSDKDeviceManager(IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)
    • Fields
      • ActiveControllers
    • Methods
      • CheckCapability(MixedRealityCapability)
      • GetControllerType(SupportedControllerType)
      • GetCurrentControllerType(InputDevice)
      • GetInputSourceType(SupportedControllerType)
      • GetOrAddController(InputDevice)
      • RemoveController(InputDevice)
      • Update()
    • Implements
    Back to top Generated by DocFX