HandPose.TryGetJoints Method

Definition

Gets the pose of multiple hand joints, expressed in the specified coordinate system.

bool TryGetJoints(SpatialCoordinateSystem const& coordinateSystem, winrt::array_view <HandJointKind> const& joints, winrt::array_view <JointPose> & jointPoses);
public bool TryGetJoints(SpatialCoordinateSystem coordinateSystem, HandJointKind[] joints, JointPose[] jointPoses);
function tryGetJoints(coordinateSystem, joints, jointPoses)
Public Function TryGetJoints (coordinateSystem As SpatialCoordinateSystem, joints As HandJointKind(), jointPoses As JointPose()) As Boolean

Parameters

coordinateSystem
SpatialCoordinateSystem

The coordinate system in which to express the joint poses.

joints
HandJointKind[]

The array of hand joint kinds to locate.

jointPoses
JointPose[]

The array of poses to fill, one for each matching element in the joints array.

Returns

Boolean

bool

True if the hand can be located within the specified coordinate system; otherwise, false.

Remarks

The jointPoses array to be filled must match the length of the joints array.

The coordinate system is right-handed, with +y up, +x to the right, and -z forward.

All joints except for tip joints are interior to the hand. Finger joint poses represent the base of the named bone. Joints are oriented with forward (-z) pointing towards the tip of each finger, up (+y) pointing out of the back of the hand or finger, and right (+x) pointing perpendicular to forward and up.

This method will return false if the specified coordinate system cannot be located at the moment.

Applies to