Meta Developers

Hand Class

Extends DataModifier< HandDataAsset >, IHand

Properties

Handedness Handedness[Get]

ITrackingToWorldTransformer TrackingToWorldTransformer[Get]

HandSkeleton HandSkeleton[Get]

bool IsConnected[Get]

bool IsHighConfidence[Get]

The hand is connected and tracked, and the root pose's tracking data is marked as high confidence.

If this is true, then it implies that IsConnected and IsRootPoseValid are also true, so they don't need to be checked in addition to this.

bool IsDominantHand[Get]

float Scale[Get]

bool IsPointerPoseValid[Get]

Will return true if a pointer pose is available, that can be retrieved via GetPointerPose

bool IsTrackedDataValid[Get]

True if the hand is currently tracked, thus tracking poses are available for the hand root and finger joints.

This property does not indicate pointing pose validity, which has its own property: IsPointerPoseValid.

Events

Action WhenHandUpdated

Protected Functions

override void Apply

( HandDataAsset data )

Member Functions

override void MarkInputDataRequiresUpdate ( )

bool GetFingerIsPinching

( HandFinger finger )

bool GetIndexFingerIsPinching ( )

bool GetPointerPose

( out Pose pose )

Attempts to calculate the pose that can be used as a root for raycasting, in world space Returns false if there is no valid tracking data.

bool GetJointPose

( HandJointId handJointId,

out Pose pose )

Attempts to calculate the pose of the requested hand joint, in world space.

Returns false if the skeleton is not yet initialized, or there is no valid tracking data.

bool GetJointPoseLocal

( HandJointId handJointId,

out Pose pose )

Attempts to calculate the pose of the requested hand joint, in local space.

Returns false if the skeleton is not yet initialized, or there is no valid tracking data.

bool GetJointPosesLocal

( out ReadOnlyHandJointPoses localJointPoses )

Returns an array containing the local pose of each joint.

The poses do not have the root pose applied, nor the hand scale. It is in the same coordinate system as the hand skeleton.

Parameters

localJointPoses

The array with the local joint poses. It will be empty if no poses where found

Returns

True if the poses collection was correctly populated. False otherwise.

bool GetJointPoseFromWrist

( HandJointId handJointId,

out Pose pose )

Attempts to calculate the pose of the requested hand joint relative to the wrist.

Returns false if the skeleton is not yet initialized, or there is no valid tracking data.

bool GetJointPosesFromWrist

( out ReadOnlyHandJointPoses jointPosesFromWrist )

Returns an array containing the pose of each joint relative to the wrist.

The poses do not have the root pose applied, nor the hand scale. It is in the same coordinate system as the hand skeleton.

Parameters

jointPosesFromWrist

The array with the joint poses from the wrist. It will be empty if no poses where found

Returns

True if the poses collection was correctly populated. False otherwise.

bool GetPalmPoseLocal

( out Pose pose )

Obtains palm pose in local space.

Parameters

pose

The pose to populate

Returns

True if pose was obtained.

bool GetFingerIsHighConfidence

( HandFinger finger )

float GetFingerPinchStrength

( HandFinger finger )

bool GetRootPose

( out Pose pose )

Gets the root pose of the wrist, in world space.

Will return true if a pose was available; false otherwise. Confidence level of the pose is exposed via IsHighConfidence.

void InjectAllHand

( UpdateModeFlags updateMode,

IDataSource updateAfter,

DataModifier< HandDataAsset > modifyDataFromSource,

bool applyModifier )

Did you find this page helpful?