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.

Search Results for

    Show / Hide Table of Contents

    Class BaseInputSourceDefinition

    Defines the base interactions and data that an controller can provide.

    Inheritance
    Object
    BaseInputSourceDefinition
    ArticulatedHandDefinition
    GenericOpenVRControllerDefinition
    HPMotionControllerDefinition
    MouseControllerDefinition
    OculusRemoteControllerDefinition
    OculusTouchControllerDefinition
    SimpleHandDefinition
    TouchScreenDefinition
    ViveKnucklesControllerDefinition
    ViveWandControllerDefinition
    WindowsMixedRealityControllerDefinition
    XboxControllerDefinition
    Implements
    IMixedRealityInputSourceDefinition
    Inherited Members
    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 BaseInputSourceDefinition : IMixedRealityInputSourceDefinition

    Constructors

    BaseInputSourceDefinition(Handedness)

    Constructor.

    Declaration
    public BaseInputSourceDefinition(Handedness handedness)
    Parameters
    Type Name Description
    Handedness handedness

    The handedness that this definition instance represents.

    Properties

    DefaultLeftHandedMappings

    The collection of interactions supported by a left-handed instance of this controller.

    Declaration
    protected virtual MixedRealityInputActionMapping[] DefaultLeftHandedMappings { get; }
    Property Value
    Type Description
    MixedRealityInputActionMapping[]
    Remarks

    Optional. Override DefaultInteractions if both handed controllers have identical interactions.

    DefaultMappings

    The collection of interactions supported by this controller.

    Declaration
    protected virtual MixedRealityInputActionMapping[] DefaultMappings { get; }
    Property Value
    Type Description
    MixedRealityInputActionMapping[]
    Remarks

    Optional. Override the specifically-handed properties if each controller has different interactions.

    DefaultRightHandedMappings

    The collection of interactions supported by a right-handed instance of this controller.

    Declaration
    protected virtual MixedRealityInputActionMapping[] DefaultRightHandedMappings { get; }
    Property Value
    Type Description
    MixedRealityInputActionMapping[]
    Remarks

    Optional. Override DefaultInteractions if both handed controllers have identical interactions.

    Handedness

    The Handedness (ex: Left, Right, None) of this controller.

    Declaration
    public Handedness Handedness { get; }
    Property Value
    Type Description
    Handedness

    Methods

    GetDefaultMappings(Handedness)

    Provides the default interactions for this source type with a specific handedness.

    Declaration
    public IReadOnlyList<MixedRealityInputActionMapping> GetDefaultMappings(Handedness handedness)
    Parameters
    Type Name Description
    Handedness handedness

    The handedness the mappings should be provided for.

    Returns
    Type Description
    IReadOnlyList<MixedRealityInputActionMapping>

    The default interactions for this source with a specific handedness.

    Implements

    IMixedRealityInputSourceDefinition
    In This Article
    Back to top Generated by DocFX