API reference
API reference
Select your platform
No SDKs available
No versions available

HandPose Class

Data for the pose of a hand for grabbing an object.
It contains not only the position of the hand and the fingers but other relevant data to the pose, such as which fingers are locked.
Even though this class is Serializable, it is not a Component. The HandPoseEditor class should be used (in conjunction with the HandGrabInteractableEditor class) to edit the values in the inspector. HandPose data can only be used in conjunction with interactors associated with posable hands, such as HandGrabInteractor.

Properties

The Input.Handedness of the hand represented by the contained pose data.
The collection of joints and their rotations in this hand.
This data follows the conventions from FingersMetadata.HAND_JOINT_IDS.
Indicates which fingers can be locked, constrained, or free in this hand pose.
Fingers in this data are represented at their index in the HandFinger enum.

Member Functions

Empty constructor for HandPose.
This constructor is automatically invoked by Unity when instantiating deserialized poses and contains features for exposing those poses to Editor tools.
A basic handedness-setting constructor for HandPoses.
This is a convenience method equivalent to invoking HandPose.HandPose, then setting handedness as the Handedness of the newly-created instance.
Parameters
handedness
The handedness to be set on the new instance.
A basic copy constructor for HandPoses.
This is a convenience method equivalent to invoking HandPose.HandPose, then passing other and false to CopyFrom(HandPose, bool) on the newly-created instance.
Parameters
other
The HandPose from which the new instance should copy its data.
Copies the values over to the hand pose without requiring any new allocations.
This is safe thanks to the flat and predictable way data is stored in JointRotations, FingersFreedom etc. within HandPose instances.
Parameters
from
The hand pose to copy the values from.
mirrorHandedness
Invert the received handedness.

Static Member Functions

Interpolates between two HandPoses, if they have the same Handedness and joints.
Parameters
from
Base HandPose to interpolate from.
to
Target HandPose to interpolate to.
t
Interpolation factor, 0 for the base, 1 for the target.
result
A HandPose positioned/rotated between the base and target.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta