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

HandPuppet Class

This class is a visual representation of a rigged hand (typically a skin-mesh renderer) that can move its position/rotation and the rotations of the joints that compose it.
Oculus::Interaction::HandGrab::Visuals::HandPuppet extends MonoBehaviour.

Overview

Properties

List< HandJointMap >
General getter for the joints of the hand.
float
Scale[Get]
Current scale of the represented hand.
JointCollection

Public Member Functions

void
SetJointRotations
( in Quaternion[] jointRotations )
Rotates all the joints in this puppet to the desired pose.
void
SetRootPose
( in Pose rootPose )
Rotates and Translate the hand Wrist so it aligns with the given pose.
void
CopyCachedJoints
( ref HandPose result )
Copies the rotations of all the joints available in the puppet as they are visually presented.

Details

Detailed Description

It also can offset the rotations of the individual joints, adapting the provided data to any rig.

Properties

List<HandJointMap> Oculus.Interaction.HandGrab.Visuals.HandPuppet.JointMaps
General getter for the joints of the hand.
float Oculus.Interaction.HandGrab.Visuals.HandPuppet.Scale
Current scale of the represented hand.
JointCollection Oculus.Interaction.HandGrab.Visuals.HandPuppet.JointsCache
No description available.

Member Functions

void Oculus.Interaction.HandGrab.Visuals.HandPuppet.SetJointRotations
( in Quaternion[] jointRotations )
Rotates all the joints in this puppet to the desired pose.
Parameters
jointRotations
Array of rotations to use for the fingers. It must follow the FingersMetaData.HAND_JOINT_IDS order.
void Oculus.Interaction.HandGrab.Visuals.HandPuppet.SetRootPose
( in Pose rootPose )
Rotates and Translate the hand Wrist so it aligns with the given pose.
It can apply an offset for when using controllers.
Parameters
rootPose
The Wrist Pose to set this puppet to.
void Oculus.Interaction.HandGrab.Visuals.HandPuppet.CopyCachedJoints
( ref HandPose result )
Copies the rotations of all the joints available in the puppet as they are visually presented.
Note that any missing joints are skipped.
Parameters
result
Structure to copy the joints to
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)
© 2026 Meta