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

HandPuppet Class

Extends MonoBehaviour
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.
It also can offset the rotations of the individual joints, adapting the provided data to any rig.

Properties

JointMaps : List< HandJointMap >
[Get]
General getter for the joints of the hand.
Signature
List<HandJointMap> Oculus.Interaction.HandGrab.Visuals.HandPuppet.JointMaps
Scale : float
[Get][Set]
Current scale of the represented hand.
Signature
float Oculus.Interaction.HandGrab.Visuals.HandPuppet.Scale

Methods

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