Class ArticulatedHandDefinition

Defines the interactions and data that an articulated hand can provide.

Inheritance

Object

BaseInputSourceDefinition

ArticulatedHandDefinition

Implements

IMixedRealityInputSourceDefinition

Inherited Members

BaseInputSourceDefinition.Handedness

BaseInputSourceDefinition.DefaultLeftHandedMappings

BaseInputSourceDefinition.DefaultRightHandedMappings

BaseInputSourceDefinition.GetDefaultMappings(Handedness)

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 class ArticulatedHandDefinition : BaseInputSourceDefinition, IMixedRealityInputSourceDefinition

Constructors

ArticulatedHandDefinition(IMixedRealityInputSource, Handedness)

Constructor.

Declaration

public ArticulatedHandDefinition(IMixedRealityInputSource source, Handedness handedness)

Parameters

Type	Name	Description
IMixedRealityInputSource	source	The input source backing this definition instance. Used for raising events.
Handedness	handedness	The handedness that this definition instance represents.

Properties

DefaultInteractions

The articulated hands default interactions.

Declaration

[Obsolete("Call GetDefaultMappings(Handedness) instead.")]
public MixedRealityInteractionMapping[] DefaultInteractions { get; }

Property Value

Type	Description
MixedRealityInteractionMapping[]

Remarks

A single interaction mapping works for both left and right articulated hands.

DefaultMappings

The articulated hands default interactions.

Declaration

protected override MixedRealityInputActionMapping[] DefaultMappings { get; }

Property Value

Type	Description
MixedRealityInputActionMapping[]

Overrides

BaseInputSourceDefinition.DefaultMappings

Remarks

A single interaction mapping works for both left and right articulated hands.

EnterPinchDistance

The distance between the index finger tip and the thumb tip required to enter the pinch/air tap selection gesture. The pinch gesture enter will be registered for all values less than the EnterPinchDistance. The default EnterPinchDistance value is 0.02 and must be between 0.015 and 0.1.

Declaration

public float EnterPinchDistance { get; set; }

Property Value

Type	Description
Single

ExitPinchDistance

The distance between the index finger tip and the thumb tip required to exit the pinch/air tap gesture. The pinch gesture exit will be registered for all values greater than the ExitPinchDistance. The default ExitPinchDistance value is 0.05 and must be between 0.015 and 0.1.

Declaration

public float ExitPinchDistance { get; set; }

Property Value

Type	Description
Single

InputSource

The input source backing this definition instance.

Declaration

protected IMixedRealityInputSource InputSource { get; }

Property Value

Type	Description
IMixedRealityInputSource

IsInPointingPose

Calculates whether the current pose allows for pointing/distant interactions.

Declaration

public bool IsInPointingPose { get; }

Property Value

Type	Description
Boolean

IsInTeleportPose

Calculates whether the current pose is the one to start a teleport action

Declaration

protected bool IsInTeleportPose { get; }

Property Value

Type	Description
Boolean

IsPinching

Calculates whether the current the current joint pose is selecting (air tap gesture).

Declaration

public bool IsPinching { get; }

Property Value

Type	Description
Boolean

Methods

UpdateCurrentIndexPose(MixedRealityInteractionMapping)

Updates the MixedRealityInteractionMapping with the latest index pose and fires a corresponding pose event.

Declaration

public void UpdateCurrentIndexPose(MixedRealityInteractionMapping interactionMapping)

Parameters

Type	Name	Description
MixedRealityInteractionMapping	interactionMapping	The index finger's interaction mapping.

UpdateCurrentTeleportPose(MixedRealityInteractionMapping)

Declaration

public void UpdateCurrentTeleportPose(MixedRealityInteractionMapping interactionMapping)

Parameters

Type	Name	Description
MixedRealityInteractionMapping	interactionMapping

UpdateHandJoints(Dictionary<TrackedHandJoint, MixedRealityPose>)

Updates the current hand joints with new data.

Declaration

public void UpdateHandJoints(Dictionary<TrackedHandJoint, MixedRealityPose> jointPoses)

Parameters

Type	Name	Description
Dictionary<TrackedHandJoint, MixedRealityPose>	jointPoses	The new joint poses.

Implements

IMixedRealityInputSourceDefinition