mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class GenericXRSDKController

    Inheritance
    Object
    GenericXRSDKController
    Namespace: Microsoft.MixedReality.Toolkit.XRSDK.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class GenericXRSDKController : BaseController

    Constructors

    GenericXRSDKController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[])

    Declaration
    public GenericXRSDKController(TrackingState trackingState, Handedness controllerHandedness, IMixedRealityInputSource inputSource = null, MixedRealityInteractionMapping[] interactions = null)
    Parameters
    Type Name Description
    TrackingState trackingState
    Handedness controllerHandedness
    IMixedRealityInputSource inputSource
    MixedRealityInteractionMapping[] interactions

    Fields

    CurrentControllerPose

    The current pose of this XR SDK controller.

    Declaration
    protected MixedRealityPose CurrentControllerPose
    Field Value
    Type Description
    MixedRealityPose

    CurrentControllerPosition

    The current position of this XR SDK controller.

    Declaration
    protected Vector3 CurrentControllerPosition
    Field Value
    Type Description
    Vector3

    CurrentControllerRotation

    The current rotation of this XR SDK controller.

    Declaration
    protected Quaternion CurrentControllerRotation
    Field Value
    Type Description
    Quaternion

    LastControllerPose

    The previous pose of this XR SDK controller.

    Declaration
    protected MixedRealityPose LastControllerPose
    Field Value
    Type Description
    MixedRealityPose

    Properties

    DefaultLeftHandedInteractions

    Declaration
    public override MixedRealityInteractionMapping[] DefaultLeftHandedInteractions { get; }
    Property Value
    Type Description
    MixedRealityInteractionMapping[]

    DefaultRightHandedInteractions

    Declaration
    public override MixedRealityInteractionMapping[] DefaultRightHandedInteractions { get; }
    Property Value
    Type Description
    MixedRealityInteractionMapping[]

    Methods

    UpdateButtonData(MixedRealityInteractionMapping, InputDevice)

    Update an interaction bool data type from a bool input

    Declaration
    protected virtual void UpdateButtonData(MixedRealityInteractionMapping interactionMapping, InputDevice inputDevice)
    Parameters
    Type Name Description
    MixedRealityInteractionMapping interactionMapping
    InputDevice inputDevice
    Remarks

    Raises an Input System "Input Down" event when the key is down, and raises an "Input Up" when it is released (e.g. a Button)

    UpdateController(InputDevice)

    Update the controller data from XR SDK.

    Declaration
    public virtual void UpdateController(InputDevice inputDevice)
    Parameters
    Type Name Description
    InputDevice inputDevice

    UpdateDualAxisData(MixedRealityInteractionMapping, InputDevice)

    Update the touchpad / thumbstick input from the device

    Declaration
    protected virtual void UpdateDualAxisData(MixedRealityInteractionMapping interactionMapping, InputDevice inputDevice)
    Parameters
    Type Name Description
    MixedRealityInteractionMapping interactionMapping
    InputDevice inputDevice

    UpdatePoseData(MixedRealityInteractionMapping, InputDevice)

    Update spatial grip data.

    Declaration
    protected virtual void UpdatePoseData(MixedRealityInteractionMapping interactionMapping, InputDevice inputDevice)
    Parameters
    Type Name Description
    MixedRealityInteractionMapping interactionMapping
    InputDevice inputDevice

    UpdateSingleAxisData(MixedRealityInteractionMapping, InputDevice)

    Update an interaction float data type from a SingleAxis (float) input

    Declaration
    protected virtual void UpdateSingleAxisData(MixedRealityInteractionMapping interactionMapping, InputDevice inputDevice)
    Parameters
    Type Name Description
    MixedRealityInteractionMapping interactionMapping
    InputDevice inputDevice
    Remarks

    Raises a FloatInputChanged event when the float data changes

    In This Article
    • Constructors
      • GenericXRSDKController(TrackingState, Handedness, IMixedRealityInputSource, MixedRealityInteractionMapping[])
    • Fields
      • CurrentControllerPose
      • CurrentControllerPosition
      • CurrentControllerRotation
      • LastControllerPose
    • Properties
      • DefaultLeftHandedInteractions
      • DefaultRightHandedInteractions
    • Methods
      • UpdateButtonData(MixedRealityInteractionMapping, InputDevice)
      • UpdateController(InputDevice)
      • UpdateDualAxisData(MixedRealityInteractionMapping, InputDevice)
      • UpdatePoseData(MixedRealityInteractionMapping, InputDevice)
      • UpdateSingleAxisData(MixedRealityInteractionMapping, InputDevice)
    Back to top Generated by DocFX