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

OVRSkeletonMetadata Class

A class for handling Skeleton metadata.
It generates and stores information about the source and target skeletons, such as joint pairs that are used during retargeting.
At runtime, the humanoid retargeter class uses these joint pair directions to orient target skeletons to match the source body tracking skeleton.

Properties

Maps from HumanBodyBones to associated BoneData.
Use this field to query the original transform, orientation, and correction (i.e. retargeting) quaternion associated with the HumanBodyBones.

Member Functions

Copy constructor that copies from another instance of OVRSkeletonMetadata to this instance.
Since each instance tracks data per HumanBodyBones and possibly modifies, that should be copied from the other OVRSkeletonMetadata instance.
Parameters
otherSkeletonMetaData
Other meta data to copy from.
Constructor that builds an instance from an Animator reference, along with an optional OVRHumanBodyBonesMappingsInterface argument.
Use this constructor for third-party characters imported as a Humanoid. remarks> Provide the OVRHumanBodyBonesMappingsInterface argument in order to influence the creation of each joint's bone pair.
Parameters
animator
Animator to build meta data from.
bodyBonesMappingInterface
Optional bone map interface.
Constructor that builds an instance from a OVRSkeleton reference, intended for upper body characters.
Use the OVRHumanBodyBonesMappingsInterface reference in order to the influence hte creation each joint's bone pair. Use the BoneId to HumanBodyBones mapping in order influence the mapping between the two, because the body tracking bones must be associated with Humanoid bones.
Parameters
skeleton
Skeleton to build meta data from.
useBindPose
Whether to use bind pose (T-pose) or not.
customBoneIdToHumanBodyBone
Custom bone ID to human body bone mapping.
bodyBonesMappingInterface
Body bones mapping interface.
Constructor that builds an instance from a OVRSkeleton reference, intended for upper or full body characters.
Use the OVRHumanBodyBonesMappingsInterface reference in order to the influence hte creation each joint's bone pair. Use the BoneId to HumanBodyBones mapping in order influence the mapping between the two, because the body tracking bones must be associated with Humanoid bones.
Parameters
skeleton
Skeleton to build meta data from.
useBindPose
Whether to use bind pose (T-pose) or not.
customBoneIdToHumanBodyBone
Custom bone ID to human body bone mapping.
useFullBody
Whether to use full body or not.
bodyBonesMappingInterface
Body bones mapping interface.
Builds the metadata necessary for retargeting to function properly.
While this function is called during the construction of the instance, it is necessary before the retargeter computes its offsets. Call this function during skeletal update events before computing retargeting offsets. Intended for upper body characters, and used by OVRUnityHumanoidSkeletonRetargeter.
Parameters
skeleton
The OVRSkeleton.
useBindPose
If true, use the bind pose.
customBoneIdToHumanBodyBone
Custom bone ID to human body bone mapping.
bodyBonesMappingInterface
Body bones mapping interface.
Builds the metadata necessary for retargeting to function properly.
While this function is called during the construction of the instance, it is necessary before the retargeter computes its offsets. Call this function during skeletal update events before computing retargeting offsets. Intended for full body characters, and used by OVRUnityHumanoidSkeletonRetargeter.
Parameters
skeleton
The OVRSkeleton.
useBindPose
If true, use the bind pose.
customBoneIdToHumanBodyBone
Custom bone ID to human body bone mapping.
bodyBonesMappingInterface
Body bones mapping interface.
Builds an orientation per each bone of a character, using each joint's start and end transform.
It handles edge cases related to degenerate joints that may or may not exist, and also handles the character's palms differently relative to standard bones.

See Also

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