HandPose.TryGetJoint Method

Definition

Gets the pose of a hand joint, expressed in the specified coordinate system.

bool TryGetJoint(SpatialCoordinateSystem const& coordinateSystem, HandJointKind const& joint, [Out] JointPose & jointPose);
public bool TryGetJoint(SpatialCoordinateSystem coordinateSystem, HandJointKind joint, out JointPose jointPose);
Public Function TryGetJoint (coordinateSystem As SpatialCoordinateSystem, joint As HandJointKind, ByRef jointPose As JointPose) As Boolean

Parameters

coordinateSystem
SpatialCoordinateSystem

The coordinate system in which to express the joint pose.

joint
HandJointKind

The hand joint kind to locate.

jointPose
JointPose

The pose to fill for the specified joint.

Returns

Boolean

bool

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

Remarks

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