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 BaseInputSimulationService

    Base class for services that create simulated input devices.

    Inheritance
    Object
    BaseService
    BaseDataProvider
    BaseInputDeviceManager
    BaseInputSimulationService
    InputPlaybackService
    InputSimulationService
    Implements
    IMixedRealityInputDeviceManager
    IMixedRealityDataProvider
    IMixedRealityService
    IDisposable
    Inherited Members
    BaseInputDeviceManager.InputSystem
    BaseInputDeviceManager.InputSystemProfile
    BaseInputDeviceManager.RequestPointers(SupportedControllerType, Handedness)
    BaseDataProvider.Registrar
    BaseDataProvider.Service
    BaseService.DefaultPriority
    BaseService.Name
    BaseService.Priority
    BaseService.ConfigurationProfile
    BaseService.Initialize()
    BaseService.Reset()
    BaseService.Enable()
    BaseService.Update()
    BaseService.LateUpdate()
    BaseService.Disable()
    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
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class BaseInputSimulationService : BaseInputDeviceManager, IMixedRealityInputDeviceManager, IMixedRealityDataProvider, IMixedRealityService, IDisposable

    Constructors

    BaseInputSimulationService(IMixedRealityServiceRegistrar, IMixedRealityInputSystem, String, UInt32, BaseMixedRealityProfile)

    Declaration
    public BaseInputSimulationService(IMixedRealityServiceRegistrar registrar, IMixedRealityInputSystem inputSystem, string name, uint priority, BaseMixedRealityProfile profile)
    Parameters
    Type Name Description
    IMixedRealityServiceRegistrar registrar
    IMixedRealityInputSystem inputSystem
    String name
    UInt32 priority
    BaseMixedRealityProfile profile

    Methods

    GetActiveControllers()

    Retrieve all controllers currently registered with this device at runtime (if direct access is required)

    Declaration
    public override IMixedRealityController[] GetActiveControllers()
    Returns
    Type Description
    IMixedRealityController[]
    Overrides
    BaseInputDeviceManager.GetActiveControllers()

    GetHandDevice(Handedness)

    Declaration
    public SimulatedHand GetHandDevice(Handedness handedness)
    Parameters
    Type Name Description
    Handedness handedness
    Returns
    Type Description
    SimulatedHand

    GetOrAddHandDevice(Handedness, HandSimulationMode)

    Declaration
    protected SimulatedHand GetOrAddHandDevice(Handedness handedness, HandSimulationMode simulationMode)
    Parameters
    Type Name Description
    Handedness handedness
    HandSimulationMode simulationMode
    Returns
    Type Description
    SimulatedHand

    RemoveAllHandDevices()

    Declaration
    protected void RemoveAllHandDevices()

    RemoveHandDevice(Handedness)

    Declaration
    protected void RemoveHandDevice(Handedness handedness)
    Parameters
    Type Name Description
    Handedness handedness

    UpdateHandDevice(HandSimulationMode, Handedness, SimulatedHandData)

    Declaration
    protected void UpdateHandDevice(HandSimulationMode simulationMode, Handedness handedness, SimulatedHandData handData)
    Parameters
    Type Name Description
    HandSimulationMode simulationMode
    Handedness handedness
    SimulatedHandData handData

    Implements

    IMixedRealityInputDeviceManager
    IMixedRealityDataProvider
    IMixedRealityService
    System.IDisposable
    Back to top Generated by DocFX