MicrosoftArticulatedHand Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.XRSDK.OpenXR

Assembly:: Microsoft.MixedReality.Toolkit.Providers.OpenXR.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Open XR + XR SDK implementation of XR_MSFT_hand_interaction and XR_EXT_hand_tracking.

public ref class MicrosoftArticulatedHand : Microsoft::MixedReality::Toolkit::XRSDK::Input::GenericXRSDKController, Microsoft::MixedReality::Toolkit::Input::IMixedRealityHand

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.ArticulatedHand, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)]
public class MicrosoftArticulatedHand : Microsoft.MixedReality.Toolkit.XRSDK.Input.GenericXRSDKController, Microsoft.MixedReality.Toolkit.Input.IMixedRealityHand

[Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.ArticulatedHand, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class MicrosoftArticulatedHand : Microsoft.MixedReality.Toolkit.XRSDK.Input.GenericXRSDKController, Microsoft.MixedReality.Toolkit.Input.IMixedRealityHand

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.ArticulatedHand, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0)>]
type MicrosoftArticulatedHand = class
    inherit GenericXRSDKController
    interface IMixedRealityHand
    interface IMixedRealityController

[<Microsoft.MixedReality.Toolkit.Input.MixedRealityController(Microsoft.MixedReality.Toolkit.Input.SupportedControllerType.ArticulatedHand, new Microsoft.MixedReality.Toolkit.Utilities.Handedness[] { Microsoft.MixedReality.Toolkit.Utilities.Handedness.Left, Microsoft.MixedReality.Toolkit.Utilities.Handedness.Right }, "", (Microsoft.MixedReality.Toolkit.Input.MixedRealityControllerConfigurationFlags) 0, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type MicrosoftArticulatedHand = class
    inherit GenericXRSDKController
    interface IMixedRealityHand
    interface IMixedRealityController

Public Class MicrosoftArticulatedHand
Inherits GenericXRSDKController
Implements IMixedRealityHand

Inheritance: Object

BaseController

GenericXRSDKController
MicrosoftArticulatedHand

Attributes: MixedRealityControllerAttribute

Implements: IMixedRealityController IMixedRealityHand

Constructors

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

Constructor.

Fields

CurrentControllerPose	The current pose of this XR SDK controller. (Inherited from GenericXRSDKController)
CurrentControllerPosition	The current position of this XR SDK controller. (Inherited from GenericXRSDKController)
CurrentControllerRotation	The current rotation of this XR SDK controller. (Inherited from GenericXRSDKController)
handDefinition
LastControllerPose	The previous pose of this XR SDK controller. (Inherited from GenericXRSDKController)
unityJointPoses

Properties

AngularVelocity	(Inherited from BaseController)
ControllerHandedness	The designated hand that the Input Source is managing, as defined by the SDK / Unity. (Inherited from BaseController)
DefaultInteractions	The default interactions for this controller.
DefaultInteractions	The default interactions for this controller. (Inherited from BaseController)
DefaultLeftHandedInteractions	The default left-handed interactions for this controller. (Inherited from GenericXRSDKController)
DefaultRightHandedInteractions	The default right-handed interactions for this controller. (Inherited from GenericXRSDKController)
Definition	Represents the archetypal definition of what this controller supports and can perform. (Inherited from BaseController)
Enabled	Is the controller enabled? (Inherited from BaseController)
InputSource	The registered Input Source for this controller (Inherited from BaseController)
Interactions	Mapping definition for this controller, linking the Physical inputs to logical Input System Actions (Inherited from BaseController)
IsGrabbing
IsInPointingPose	Some controllers such as articulated should only be able to invoke pointing/distant interactions in certain poses.
IsPinching
IsPositionApproximate	Indicates the accuracy of the position data being reported. (Inherited from BaseController)
IsPositionAvailable	Indicates that this controller is currently providing position data. (Inherited from BaseController)
IsRotationAvailable	Indicates that this controller is currently providing rotation data. (Inherited from BaseController)
TrackingState	Outputs the current state of the Input Source, whether it is tracked or not. As defined by the SDK / Unity. (Inherited from BaseController)
Velocity	(Inherited from BaseController)
Visualizer	(Inherited from BaseController)

Methods

AssignControllerMappings(MixedRealityInteractionMapping[])	Load the Interaction mappings for this controller from the configured Controller Mapping profile (Inherited from BaseController)
SetupConfiguration(Type)	Obsolete. Sets up the configuration based on the Mixed Reality Controller Mapping Profile. (Inherited from BaseController)
SetupConfiguration(Type, InputSourceType)	Obsolete. Sets up the configuration based on the Mixed Reality Controller Mapping Profile. (Inherited from BaseController)
SetupDefaultInteractions()	Assign the default interactions based on this controller's handedness, if necessary. (Inherited from BaseController)
SetupDefaultInteractions(Handedness)	Obsolete. Assign the default interactions based on controller handedness, if necessary. (Inherited from BaseController)
StartHapticImpulse(Single, Single)	Start haptic feedback by the input device. (Inherited from GenericXRSDKController)
StopHapticFeedback()	Terminates haptic feedback by the input device. (Inherited from GenericXRSDKController)
TryAddControllerModelToSceneHierarchy(GameObject)	(Inherited from BaseController)
TryGetJoint(TrackedHandJoint, MixedRealityPose)	Get the current pose of a hand joint.
TryRenderControllerModel(Type, InputSourceType)	Try to render a controller model for this controller from the visualization profile. (Inherited from BaseController)
UpdateButtonData(MixedRealityInteractionMapping, InputDevice)	Update an interaction bool data type from a bool input
UpdateController(InputDevice)	The OpenXR plug-in uses extensions to expose all possible data, which might be surfaced through multiple input devices. This method is overridden to account for multiple input devices.
UpdateDualAxisData(MixedRealityInteractionMapping, InputDevice)	Update the touchpad / thumbstick input from the device (Inherited from GenericXRSDKController)
UpdatePoseData(MixedRealityInteractionMapping, InputDevice)	Update spatial grip data.
UpdateSingleAxisData(MixedRealityInteractionMapping, InputDevice)	Update an interaction float data type from a SingleAxis (float) input
UpdateSixDofData(InputDevice)	(Inherited from GenericXRSDKController)
UpdateSourceData(InputDevice)	Update the source input from the device. (Inherited from GenericXRSDKController)
UpdateVelocity(InputDevice)	(Inherited from GenericXRSDKController)

Applies to