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

OVRUnityHumanoidSkeletonRetargeter Class

Extends OVRSkeleton

Constructors

OVRUnityHumanoidSkeletonRetargeter ()
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRUnityHumanoidSkeletonRetargeter()

Protected Fields

_adjustments : JointAdjustment[]
Signature 
JointAdjustment [] OVRUnityHumanoidSkeletonRetargeter._adjustments
_bodySectionsToAlign : OVRHumanBodyBonesMappings.BodySection[]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter._bodySectionsToAlign
_bodySectionToPosition : OVRHumanBodyBonesMappings.BodySection[]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter._bodySectionToPosition
_fullBodySectionsToAlign : OVRHumanBodyBonesMappings.BodySection[]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter._fullBodySectionsToAlign
_fullBodySectionToPosition : OVRHumanBodyBonesMappings.BodySection[]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter._fullBodySectionToPosition
_updateType : UpdateType
Controls if we run retargeting from FixedUpdate, Update, or both.
Signature 
UpdateType OVRUnityHumanoidSkeletonRetargeter._updateType

Protected Properties

Adjustments : JointAdjustment[]
[Get]
Signature 
JointAdjustment [] OVRUnityHumanoidSkeletonRetargeter.Adjustments
AnimatorTargetSkeleton : Animator
[Get]
Signature 
Animator OVRUnityHumanoidSkeletonRetargeter.AnimatorTargetSkeleton
BodySectionsToAlign : OVRHumanBodyBonesMappings.BodySection[]
[Get]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter.BodySectionsToAlign
BodySectionToPosition : OVRHumanBodyBonesMappings.BodySection[]
[Get]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter.BodySectionToPosition
CustomBoneIdToHumanBodyBone : Dictionary< BoneId, HumanBodyBones >
[Get]
Signature 
Dictionary<BoneId, HumanBodyBones> OVRUnityHumanoidSkeletonRetargeter.CustomBoneIdToHumanBodyBone
FullBodySectionsToAlign : OVRHumanBodyBonesMappings.BodySection[]
[Get]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter.FullBodySectionsToAlign
FullBodySectionToPosition : OVRHumanBodyBonesMappings.BodySection[]
[Get]
Signature 
OVRHumanBodyBonesMappings.BodySection [] OVRUnityHumanoidSkeletonRetargeter.FullBodySectionToPosition
SourceSkeletonData : OVRSkeletonMetadata
[Get]
Signature 
OVRSkeletonMetadata OVRUnityHumanoidSkeletonRetargeter.SourceSkeletonData
SourceSkeletonTPoseData : OVRSkeletonMetadata
[Get]
Signature 
OVRSkeletonMetadata OVRUnityHumanoidSkeletonRetargeter.SourceSkeletonTPoseData
TargetSkeletonData : OVRSkeletonMetadata
[Get]
Signature 
OVRSkeletonMetadata OVRUnityHumanoidSkeletonRetargeter.TargetSkeletonData
TargetTPoseRotations : Dictionary< HumanBodyBones, Quaternion >
[Get]
Signature 
Dictionary<HumanBodyBones, Quaternion> OVRUnityHumanoidSkeletonRetargeter.TargetTPoseRotations

Properties

BodyBoneMappingsInterface : OVRHumanBodyBonesMappingsInterface
[Get][Set]
Returns body bone mappings interface.
Signature 
OVRHumanBodyBonesMappingsInterface OVRUnityHumanoidSkeletonRetargeter.BodyBoneMappingsInterface

Protected Methods

FindAdjustment ( boneId )
Signature 
JointAdjustment OVRUnityHumanoidSkeletonRetargeter.FindAdjustment(HumanBodyBones boneId)
Parameters
boneId: HumanBodyBones
Returns
JointAdjustment
OnValidate ()
Signature 
virtual void OVRUnityHumanoidSkeletonRetargeter.OnValidate()
Returns
void
RecomputeSkeletalOffsetsIfNecessary ()
Signature 
void OVRUnityHumanoidSkeletonRetargeter.RecomputeSkeletalOffsetsIfNecessary()
Returns
void
ShouldRunUpdateThisFrame ()
Signature 
bool OVRUnityHumanoidSkeletonRetargeter.ShouldRunUpdateThisFrame()
Returns
bool
Start ()
Start this instance.
Initialize data structures.
Signature 
override void OVRUnityHumanoidSkeletonRetargeter.Start()
Returns
override void
Update ()
Signature 
override void OVRUnityHumanoidSkeletonRetargeter.Update()
Returns
override void

Protected Static Methods

IsBodySectionInArray ( bodySectionToCheck , sectionArrayToCheck )
Signature 
static bool OVRUnityHumanoidSkeletonRetargeter.IsBodySectionInArray(OVRHumanBodyBonesMappings.BodySection bodySectionToCheck, OVRHumanBodyBonesMappings.BodySection[] sectionArrayToCheck)
Parameters
bodySectionToCheck: OVRHumanBodyBonesMappings.BodySection
sectionArrayToCheck: OVRHumanBodyBonesMappings.BodySection[]
Returns
bool

Inner Classes

JointAdjustment Class

Fields

BoneIdOverrideValue : OVRHumanBodyBonesMappings.BodyTrackingBoneId
Signature 
OVRHumanBodyBonesMappings.BodyTrackingBoneId OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.BoneIdOverrideValue
DisablePositionTransform : bool
Allows disable position transform on joint.
Signature 
bool OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.DisablePositionTransform
DisableRotationTransform : bool
Allows disable rotational transform on joint.
Signature 
bool OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.DisableRotationTransform
FullBodyBoneIdOverrideValue : OVRHumanBodyBonesMappings.FullBodyTrackingBoneId
Allows mapping this human body bone to OVRSkeleton bone different from the standard.
An ignore value indicates to not override; remove means to exclude from retargeting. Cannot be changed at runtime.
Signature 
OVRHumanBodyBonesMappings.FullBodyTrackingBoneId OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.FullBodyBoneIdOverrideValue
Joint : HumanBodyBones
Joint to adjust.
Signature 
HumanBodyBones OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.Joint
PositionChange : Vector3
Position change to apply to the joint, post-retargeting.
Signature 
Vector3 OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.PositionChange
RotationChange : Quaternion
Rotation to apply to the joint, post-retargeting.
NOTE: deprecated, please use .
Signature 
Quaternion OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.RotationChange
RotationTweaks : Quaternion[]
Allows accumulating a series of rotations to be applied to a joint, post-retargeting.
Signature 
Quaternion [] OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.RotationTweaks

Properties

PrecomputedRotationTweaks : Quaternion
[Get]
Precomputed accumulated rotations.
Signature 
Quaternion OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.PrecomputedRotationTweaks

Methods

PrecomputeRotationTweaks ()
Signature 
void OVRUnityHumanoidSkeletonRetargeter.JointAdjustment.PrecomputeRotationTweaks()
Returns
void

OVRHumanBodyBonesMappings Class

Implements OVRHumanBodyBonesMappingsInterface
This class contains mappings between Unity Humanoid Rig bones and Oculus Body Tracking bones.

Static Fields

BoneIdToHumanBodyBone : readonly Dictionary< OVRSkeleton.BoneId, HumanBodyBones >
Signature 
readonly Dictionary<OVRSkeleton.BoneId, HumanBodyBones> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.BoneIdToHumanBodyBone
BoneIdToJointPair : readonly Dictionary< OVRSkeleton.BoneId, Tuple< OVRSkeleton.BoneId, OVRSkeleton.BoneId > >
Signature 
readonly Dictionary<OVRSkeleton.BoneId, Tuple<OVRSkeleton.BoneId, OVRSkeleton.BoneId> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.BoneIdToJointPair
BoneToBodySection : readonly Dictionary< HumanBodyBones, BodySection >
Paired human body bones with body sections.
Signature 
readonly Dictionary<HumanBodyBones, BodySection> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.BoneToBodySection
BoneToJointPair : readonly Dictionary< HumanBodyBones, Tuple< HumanBodyBones, HumanBodyBones > >
For each humanoid bone, create a pair that determines the pair of bones that create the joint pair.
Used to create the "axis" of the bone.
Signature 
readonly Dictionary<HumanBodyBones, Tuple<HumanBodyBones, HumanBodyBones> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.BoneToJointPair
FullBodyBoneIdToHumanBodyBone : readonly Dictionary< OVRSkeleton.BoneId, HumanBodyBones >
Paired OVRSkeleton bones with human body bones.
Signature 
readonly Dictionary<OVRSkeleton.BoneId, HumanBodyBones> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.FullBodyBoneIdToHumanBodyBone
FullBoneIdToJointPair : readonly Dictionary< OVRSkeleton.BoneId, Tuple< OVRSkeleton.BoneId, OVRSkeleton.BoneId > >
For each humanoid bone, create a pair that determines the pair of bones that create the joint pair.
Used to create the "axis" of the bone.
Signature 
readonly Dictionary<OVRSkeleton.BoneId, Tuple<OVRSkeleton.BoneId, OVRSkeleton.BoneId> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.FullBoneIdToJointPair

Properties

GetBoneIdToHumanBodyBone : Dictionary< OVRSkeleton.BoneId, HumanBodyBones >
[Get]
Returns half-body bone ID to HumanBodyBone map.
Signature 
Dictionary<OVRSkeleton.BoneId, HumanBodyBones> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetBoneIdToHumanBodyBone
GetBoneIdToJointPair : Dictionary< OVRSkeleton.BoneId, Tuple< OVRSkeleton.BoneId, OVRSkeleton.BoneId > >
[Get]
Returns BoneId to joint pair map, for half-body.
Signature 
Dictionary<OVRSkeleton.BoneId, Tuple<OVRSkeleton.BoneId, OVRSkeleton.BoneId> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetBoneIdToJointPair
GetBoneToBodySection : Dictionary< HumanBodyBones, BodySection >
[Get]
Returns HumanBodeBones to body section map.
Signature 
Dictionary<HumanBodyBones, BodySection> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetBoneToBodySection
GetBoneToJointPair : Dictionary< HumanBodyBones, Tuple< HumanBodyBones, HumanBodyBones > >
[Get]
Returns HumanBodyBones to joint pair map.
Signature 
Dictionary<HumanBodyBones, Tuple<HumanBodyBones, HumanBodyBones> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetBoneToJointPair
GetFullBodyBoneIdToHumanBodyBone : Dictionary< OVRSkeleton.BoneId, HumanBodyBones >
[Get]
Returns full-body bone ID to HumanBodyBone map.
Signature 
Dictionary<OVRSkeleton.BoneId, HumanBodyBones> OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetFullBodyBoneIdToHumanBodyBone
GetFullBodyBoneIdToJointPair : Dictionary< OVRSkeleton.BoneId, Tuple< OVRSkeleton.BoneId, OVRSkeleton.BoneId > >
[Get]
Returns BoneId to joint pair map, for full-body.
Signature 
Dictionary<OVRSkeleton.BoneId, Tuple<OVRSkeleton.BoneId, OVRSkeleton.BoneId> > OVRUnityHumanoidSkeletonRetargeter.OVRHumanBodyBonesMappings.GetFullBodyBoneIdToJointPair

Inner Enums

BodySection Enum
Corresponds to major sections of the body (left food, chest, etc).
Enumeration Constants
Member
LeftLeg
LeftFoot
RightLeg
RightFoot
LeftArm
LeftHand
RightArm
RightHand
Hips
Back
Neck
Head
FullBodyTrackingBoneId Enum
Body tracking bone IDs that should be exposed through the inspector.
BoneId has enum values that map to the same integers, which would not work with a serialized field that expects unique integers. FullBodyTrackingBoneId is an enum that restricts BoneId to the values that we care about.
Enumeration Constants
MemberValue
FullBody_Start
OVRPlugin.BoneId.FullBody_Start
FullBody_Root
OVRPlugin.BoneId.FullBody_Root
FullBody_Hips
OVRPlugin.BoneId.FullBody_Hips
FullBody_SpineLower
OVRPlugin.BoneId.FullBody_SpineLower
FullBody_SpineMiddle
OVRPlugin.BoneId.FullBody_SpineMiddle
FullBody_SpineUpper
OVRPlugin.BoneId.FullBody_SpineUpper
FullBody_Chest
OVRPlugin.BoneId.FullBody_Chest
FullBody_Neck
OVRPlugin.BoneId.FullBody_Neck
FullBody_Head
OVRPlugin.BoneId.FullBody_Head
FullBody_LeftShoulder
OVRPlugin.BoneId.FullBody_LeftShoulder
FullBody_LeftScapula
OVRPlugin.BoneId.FullBody_LeftScapula
FullBody_LeftArmUpper
OVRPlugin.BoneId.FullBody_LeftArmUpper
FullBody_LeftArmLower
OVRPlugin.BoneId.FullBody_LeftArmLower
FullBody_LeftHandWristTwist
OVRPlugin.BoneId.FullBody_LeftHandWristTwist
FullBody_RightShoulder
OVRPlugin.BoneId.FullBody_RightShoulder
FullBody_RightScapula
OVRPlugin.BoneId.FullBody_RightScapula
FullBody_RightArmUpper
OVRPlugin.BoneId.FullBody_RightArmUpper
FullBody_RightArmLower
OVRPlugin.BoneId.FullBody_RightArmLower
FullBody_RightHandWristTwist
OVRPlugin.BoneId.FullBody_RightHandWristTwist
FullBody_LeftHandPalm
OVRPlugin.BoneId.FullBody_LeftHandPalm
FullBody_LeftHandWrist
OVRPlugin.BoneId.FullBody_LeftHandWrist
FullBody_LeftHandThumbMetacarpal
OVRPlugin.BoneId.FullBody_LeftHandThumbMetacarpal
FullBody_LeftHandThumbProximal
OVRPlugin.BoneId.FullBody_LeftHandThumbProximal
FullBody_LeftHandThumbDistal
OVRPlugin.BoneId.FullBody_LeftHandThumbDistal
FullBody_LeftHandThumbTip
OVRPlugin.BoneId.FullBody_LeftHandThumbTip
FullBody_LeftHandIndexMetacarpal
OVRPlugin.BoneId.FullBody_LeftHandIndexMetacarpal
FullBody_LeftHandIndexProximal
OVRPlugin.BoneId.FullBody_LeftHandIndexProximal
FullBody_LeftHandIndexIntermediate
OVRPlugin.BoneId.FullBody_LeftHandIndexIntermediate
FullBody_LeftHandIndexDistal
OVRPlugin.BoneId.FullBody_LeftHandIndexDistal
FullBody_LeftHandIndexTip
OVRPlugin.BoneId.FullBody_LeftHandIndexTip
FullBody_LeftHandMiddleMetacarpal
OVRPlugin.BoneId.FullBody_LeftHandMiddleMetacarpal
FullBody_LeftHandMiddleProximal
OVRPlugin.BoneId.FullBody_LeftHandMiddleProximal
FullBody_LeftHandMiddleIntermediate
OVRPlugin.BoneId.FullBody_LeftHandMiddleIntermediate
FullBody_LeftHandMiddleDistal
OVRPlugin.BoneId.FullBody_LeftHandMiddleDistal
FullBody_LeftHandMiddleTip
OVRPlugin.BoneId.FullBody_LeftHandMiddleTip
FullBody_LeftHandRingMetacarpal
OVRPlugin.BoneId.FullBody_LeftHandRingMetacarpal
FullBody_LeftHandRingProximal
OVRPlugin.BoneId.FullBody_LeftHandRingProximal
FullBody_LeftHandRingIntermediate
OVRPlugin.BoneId.FullBody_LeftHandRingIntermediate
FullBody_LeftHandRingDistal
OVRPlugin.BoneId.FullBody_LeftHandRingDistal
FullBody_LeftHandRingTip
OVRPlugin.BoneId.FullBody_LeftHandRingTip
FullBody_LeftHandLittleMetacarpal
OVRPlugin.BoneId.FullBody_LeftHandLittleMetacarpal
FullBody_LeftHandLittleProximal
OVRPlugin.BoneId.FullBody_LeftHandLittleProximal
FullBody_LeftHandLittleIntermediate
OVRPlugin.BoneId.FullBody_LeftHandLittleIntermediate
FullBody_LeftHandLittleDistal
OVRPlugin.BoneId.FullBody_LeftHandLittleDistal
FullBody_LeftHandLittleTip
OVRPlugin.BoneId.FullBody_LeftHandLittleTip
FullBody_RightHandPalm
OVRPlugin.BoneId.FullBody_RightHandPalm
FullBody_RightHandWrist
OVRPlugin.BoneId.FullBody_RightHandWrist
FullBody_RightHandThumbMetacarpal
OVRPlugin.BoneId.FullBody_RightHandThumbMetacarpal
FullBody_RightHandThumbProximal
OVRPlugin.BoneId.FullBody_RightHandThumbProximal
FullBody_RightHandThumbDistal
OVRPlugin.BoneId.FullBody_RightHandThumbDistal
FullBody_RightHandThumbTip
OVRPlugin.BoneId.FullBody_RightHandThumbTip
FullBody_RightHandIndexMetacarpal
OVRPlugin.BoneId.FullBody_RightHandIndexMetacarpal
FullBody_RightHandIndexProximal
OVRPlugin.BoneId.FullBody_RightHandIndexProximal
FullBody_RightHandIndexIntermediate
OVRPlugin.BoneId.FullBody_RightHandIndexIntermediate
FullBody_RightHandIndexDistal
OVRPlugin.BoneId.FullBody_RightHandIndexDistal
FullBody_RightHandIndexTip
OVRPlugin.BoneId.FullBody_RightHandIndexTip
FullBody_RightHandMiddleMetacarpal
OVRPlugin.BoneId.FullBody_RightHandMiddleMetacarpal
FullBody_RightHandMiddleProximal
OVRPlugin.BoneId.FullBody_RightHandMiddleProximal
FullBody_RightHandMiddleIntermediate
OVRPlugin.BoneId.FullBody_RightHandMiddleIntermediate
FullBody_RightHandMiddleDistal
OVRPlugin.BoneId.FullBody_RightHandMiddleDistal
FullBody_RightHandMiddleTip
OVRPlugin.BoneId.FullBody_RightHandMiddleTip
FullBody_RightHandRingMetacarpal
OVRPlugin.BoneId.FullBody_RightHandRingMetacarpal
FullBody_RightHandRingProximal
OVRPlugin.BoneId.FullBody_RightHandRingProximal
FullBody_RightHandRingIntermediate
OVRPlugin.BoneId.FullBody_RightHandRingIntermediate
FullBody_RightHandRingDistal
OVRPlugin.BoneId.FullBody_RightHandRingDistal
FullBody_RightHandRingTip
OVRPlugin.BoneId.FullBody_RightHandRingTip
FullBody_RightHandLittleMetacarpal
OVRPlugin.BoneId.FullBody_RightHandLittleMetacarpal
FullBody_RightHandLittleProximal
OVRPlugin.BoneId.FullBody_RightHandLittleProximal
FullBody_RightHandLittleIntermediate
OVRPlugin.BoneId.FullBody_RightHandLittleIntermediate
FullBody_RightHandLittleDistal
OVRPlugin.BoneId.FullBody_RightHandLittleDistal
FullBody_RightHandLittleTip
OVRPlugin.BoneId.FullBody_RightHandLittleTip
FullBody_LeftUpperLeg
OVRPlugin.BoneId.FullBody_LeftUpperLeg
FullBody_LeftLowerLeg
OVRPlugin.BoneId.FullBody_LeftLowerLeg
FullBody_LeftFootAnkleTwist
OVRPlugin.BoneId.FullBody_LeftFootAnkleTwist
FullBody_LeftFootAnkle
OVRPlugin.BoneId.FullBody_LeftFootAnkle
FullBody_LeftFootSubtalar
OVRPlugin.BoneId.FullBody_LeftFootSubtalar
FullBody_LeftFootTransverse
OVRPlugin.BoneId.FullBody_LeftFootTransverse
FullBody_LeftFootBall
OVRPlugin.BoneId.FullBody_LeftFootBall
FullBody_RightUpperLeg
OVRPlugin.BoneId.FullBody_RightUpperLeg
FullBody_RightLowerLeg
OVRPlugin.BoneId.FullBody_RightLowerLeg
FullBody_RightFootAnkleTwist
OVRPlugin.BoneId.FullBody_RightFootAnkleTwist
FullBody_RightFootAnkle
OVRPlugin.BoneId.FullBody_RightFootAnkle
FullBody_RightFootSubtalar
OVRPlugin.BoneId.FullBody_RightFootSubtalar
FullBody_RightFootTransverse
OVRPlugin.BoneId.FullBody_RightFootTransverse
FullBody_RightFootBall
OVRPlugin.BoneId.FullBody_RightFootBall
FullBody_End
OVRPlugin.BoneId.FullBody_End
NoOverride
OVRPlugin.BoneId.FullBody_End + 1
Remove
OVRPlugin.BoneId.FullBody_End + 2
BodyTrackingBoneId Enum
Body tracking bone IDs that should be exposed through the inspector.
BoneId has enum values that map to the same integers, which would not work with a serialized field that expects unique integers. BodyTrackingBoneId is an enum that restricts BoneId to the values that we care about.
Enumeration Constants
MemberValue
Body_Start
OVRPlugin.BoneId.Body_Start
Body_Root
OVRPlugin.BoneId.Body_Root
Body_Hips
OVRPlugin.BoneId.Body_Hips
Body_SpineLower
OVRPlugin.BoneId.Body_SpineLower
Body_SpineMiddle
OVRPlugin.BoneId.Body_SpineMiddle
Body_SpineUpper
OVRPlugin.BoneId.Body_SpineUpper
Body_Chest
OVRPlugin.BoneId.Body_Chest
Body_Neck
OVRPlugin.BoneId.Body_Neck
Body_Head
OVRPlugin.BoneId.Body_Head
Body_LeftShoulder
OVRPlugin.BoneId.Body_LeftShoulder
Body_LeftScapula
OVRPlugin.BoneId.Body_LeftScapula
Body_LeftArmUpper
OVRPlugin.BoneId.Body_LeftArmUpper
Body_LeftArmLower
OVRPlugin.BoneId.Body_LeftArmLower
Body_LeftHandWristTwist
OVRPlugin.BoneId.Body_LeftHandWristTwist
Body_RightShoulder
OVRPlugin.BoneId.Body_RightShoulder
Body_RightScapula
OVRPlugin.BoneId.Body_RightScapula
Body_RightArmUpper
OVRPlugin.BoneId.Body_RightArmUpper
Body_RightArmLower
OVRPlugin.BoneId.Body_RightArmLower
Body_RightHandWristTwist
OVRPlugin.BoneId.Body_RightHandWristTwist
Body_LeftHandPalm
OVRPlugin.BoneId.Body_LeftHandPalm
Body_LeftHandWrist
OVRPlugin.BoneId.Body_LeftHandWrist
Body_LeftHandThumbMetacarpal
OVRPlugin.BoneId.Body_LeftHandThumbMetacarpal
Body_LeftHandThumbProximal
OVRPlugin.BoneId.Body_LeftHandThumbProximal
Body_LeftHandThumbDistal
OVRPlugin.BoneId.Body_LeftHandThumbDistal
Body_LeftHandThumbTip
OVRPlugin.BoneId.Body_LeftHandThumbTip
Body_LeftHandIndexMetacarpal
OVRPlugin.BoneId.Body_LeftHandIndexMetacarpal
Body_LeftHandIndexProximal
OVRPlugin.BoneId.Body_LeftHandIndexProximal
Body_LeftHandIndexIntermediate
OVRPlugin.BoneId.Body_LeftHandIndexIntermediate
Body_LeftHandIndexDistal
OVRPlugin.BoneId.Body_LeftHandIndexDistal
Body_LeftHandIndexTip
OVRPlugin.BoneId.Body_LeftHandIndexTip
Body_LeftHandMiddleMetacarpal
OVRPlugin.BoneId.Body_LeftHandMiddleMetacarpal
Body_LeftHandMiddleProximal
OVRPlugin.BoneId.Body_LeftHandMiddleProximal
Body_LeftHandMiddleIntermediate
OVRPlugin.BoneId.Body_LeftHandMiddleIntermediate
Body_LeftHandMiddleDistal
OVRPlugin.BoneId.Body_LeftHandMiddleDistal
Body_LeftHandMiddleTip
OVRPlugin.BoneId.Body_LeftHandMiddleTip
Body_LeftHandRingMetacarpal
OVRPlugin.BoneId.Body_LeftHandRingMetacarpal
Body_LeftHandRingProximal
OVRPlugin.BoneId.Body_LeftHandRingProximal
Body_LeftHandRingIntermediate
OVRPlugin.BoneId.Body_LeftHandRingIntermediate
Body_LeftHandRingDistal
OVRPlugin.BoneId.Body_LeftHandRingDistal
Body_LeftHandRingTip
OVRPlugin.BoneId.Body_LeftHandRingTip
Body_LeftHandLittleMetacarpal
OVRPlugin.BoneId.Body_LeftHandLittleMetacarpal
Body_LeftHandLittleProximal
OVRPlugin.BoneId.Body_LeftHandLittleProximal
Body_LeftHandLittleIntermediate
OVRPlugin.BoneId.Body_LeftHandLittleIntermediate
Body_LeftHandLittleDistal
OVRPlugin.BoneId.Body_LeftHandLittleDistal
Body_LeftHandLittleTip
OVRPlugin.BoneId.Body_LeftHandLittleTip
Body_RightHandPalm
OVRPlugin.BoneId.Body_RightHandPalm
Body_RightHandWrist
OVRPlugin.BoneId.Body_RightHandWrist
Body_RightHandThumbMetacarpal
OVRPlugin.BoneId.Body_RightHandThumbMetacarpal
Body_RightHandThumbProximal
OVRPlugin.BoneId.Body_RightHandThumbProximal
Body_RightHandThumbDistal
OVRPlugin.BoneId.Body_RightHandThumbDistal
Body_RightHandThumbTip
OVRPlugin.BoneId.Body_RightHandThumbTip
Body_RightHandIndexMetacarpal
OVRPlugin.BoneId.Body_RightHandIndexMetacarpal
Body_RightHandIndexProximal
OVRPlugin.BoneId.Body_RightHandIndexProximal
Body_RightHandIndexIntermediate
OVRPlugin.BoneId.Body_RightHandIndexIntermediate
Body_RightHandIndexDistal
OVRPlugin.BoneId.Body_RightHandIndexDistal
Body_RightHandIndexTip
OVRPlugin.BoneId.Body_RightHandIndexTip
Body_RightHandMiddleMetacarpal
OVRPlugin.BoneId.Body_RightHandMiddleMetacarpal
Body_RightHandMiddleProximal
OVRPlugin.BoneId.Body_RightHandMiddleProximal
Body_RightHandMiddleIntermediate
OVRPlugin.BoneId.Body_RightHandMiddleIntermediate
Body_RightHandMiddleDistal
OVRPlugin.BoneId.Body_RightHandMiddleDistal
Body_RightHandMiddleTip
OVRPlugin.BoneId.Body_RightHandMiddleTip
Body_RightHandRingMetacarpal
OVRPlugin.BoneId.Body_RightHandRingMetacarpal
Body_RightHandRingProximal
OVRPlugin.BoneId.Body_RightHandRingProximal
Body_RightHandRingIntermediate
OVRPlugin.BoneId.Body_RightHandRingIntermediate
Body_RightHandRingDistal
OVRPlugin.BoneId.Body_RightHandRingDistal
Body_RightHandRingTip
OVRPlugin.BoneId.Body_RightHandRingTip
Body_RightHandLittleMetacarpal
OVRPlugin.BoneId.Body_RightHandLittleMetacarpal
Body_RightHandLittleProximal
OVRPlugin.BoneId.Body_RightHandLittleProximal
Body_RightHandLittleIntermediate
OVRPlugin.BoneId.Body_RightHandLittleIntermediate
Body_RightHandLittleDistal
OVRPlugin.BoneId.Body_RightHandLittleDistal
Body_RightHandLittleTip
OVRPlugin.BoneId.Body_RightHandLittleTip
Body_End
OVRPlugin.BoneId.Body_End
NoOverride
OVRPlugin.BoneId.Body_End + 1
Remove
OVRPlugin.BoneId.Body_End + 2

OVRSkeletonMetadata Class

Skeleton meta data class, associated with each HumanyBodyBone enum.

Constructors

OVRSkeletonMetadata ( otherSkeletonMetaData )
Constructor that copies another meta data class.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.OVRSkeletonMetadata(OVRSkeletonMetadata otherSkeletonMetaData)
Parameters
otherSkeletonMetaData: OVRSkeletonMetadata  Other meta data to copy from.
OVRSkeletonMetadata ( animator , bodyBonesMappingInterface )
Main constructor.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.OVRSkeletonMetadata(Animator animator, OVRHumanBodyBonesMappingsInterface bodyBonesMappingInterface=null)
Parameters
animator: Animator  Animator to build meta data from.
bodyBonesMappingInterface: OVRHumanBodyBonesMappingsInterface  Optional bone map interface.
OVRSkeletonMetadata ( skeleton , useBindPose , customBoneIdToHumanBodyBone , bodyBonesMappingInterface )
Constructor for OVRSkeleton.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.OVRSkeletonMetadata(OVRSkeleton skeleton, bool useBindPose, Dictionary< BoneId, HumanBodyBones > customBoneIdToHumanBodyBone, OVRHumanBodyBonesMappingsInterface bodyBonesMappingInterface)
Parameters
skeleton: OVRSkeleton  Skeleton to build meta data from.
useBindPose: bool  Whether to use bind pose (T-pose) or not.
customBoneIdToHumanBodyBone: Dictionary< BoneId, HumanBodyBones >  Custom bone ID to human body bone mapping.
bodyBonesMappingInterface: OVRHumanBodyBonesMappingsInterface  Body bones mapping interface.
OVRSkeletonMetadata ( skeleton , useBindPose , customBoneIdToHumanBodyBone , useFullBody , bodyBonesMappingInterface )
Constructor for OVRSkeleton.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.OVRSkeletonMetadata(OVRSkeleton skeleton, bool useBindPose, Dictionary< BoneId, HumanBodyBones > customBoneIdToHumanBodyBone, bool useFullBody, OVRHumanBodyBonesMappingsInterface bodyBonesMappingInterface)
Parameters
skeleton: OVRSkeleton  Skeleton to build meta data from.
useBindPose: bool  Whether to use bind pose (T-pose) or not.
customBoneIdToHumanBodyBone: Dictionary< BoneId, HumanBodyBones >  Custom bone ID to human body bone mapping.
useFullBody: bool  Whether to use full body or not.
bodyBonesMappingInterface: OVRHumanBodyBonesMappingsInterface  Body bones mapping interface.

Properties

BodyToBoneData : Dictionary< HumanBodyBones, BoneData >
[Get]
Human body bone enum to bone data mapping.
Signature 
Dictionary<HumanBodyBones, BoneData> OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BodyToBoneData

Methods

BuildBoneDataSkeleton ( skeleton , useBindPose , customBoneIdToHumanBodyBone , bodyBonesMappingInterface )
Builds body to bone data with the OVRSkeleton.
Signature 
void OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BuildBoneDataSkeleton(OVRSkeleton skeleton, bool useBindPose, Dictionary< BoneId, HumanBodyBones > customBoneIdToHumanBodyBone, OVRHumanBodyBonesMappingsInterface bodyBonesMappingInterface)
Parameters
skeleton: OVRSkeleton  The OVRSkeleton.
useBindPose: bool  If true, use the bind pose.
customBoneIdToHumanBodyBone: Dictionary< BoneId, HumanBodyBones >  Custom bone ID to human body bone mapping.
bodyBonesMappingInterface: OVRHumanBodyBonesMappingsInterface  Body bones mapping interface.
Returns
void
BuildBoneDataSkeletonFullBody ( skeleton , useBindPose , customBoneIdToHumanBodyBone , bodyBonesMappingInterface )
Builds full body to bone data with the OVRSkeleton.
Signature 
void OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BuildBoneDataSkeletonFullBody(OVRSkeleton skeleton, bool useBindPose, Dictionary< BoneId, HumanBodyBones > customBoneIdToHumanBodyBone, OVRHumanBodyBonesMappingsInterface bodyBonesMappingInterface)
Parameters
skeleton: OVRSkeleton  The OVRSkeleton.
useBindPose: bool  If true, use the bind pose.
customBoneIdToHumanBodyBone: Dictionary< BoneId, HumanBodyBones >  Custom bone ID to human body bone mapping.
bodyBonesMappingInterface: OVRHumanBodyBonesMappingsInterface  Body bones mapping interface.
Returns
void
BuildCoordinateAxesForAllBones ()
Builds coordinate axes for all bones.
Signature 
void OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BuildCoordinateAxesForAllBones()
Returns
void

Inner Class

BoneData Class
Data associated per bone.
Constructors
BoneData ()
Default, no-argument constructor.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.BoneData()
BoneData ( otherBoneData )
Copy constructor.
Signature 
OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.BoneData(BoneData otherBoneData)
Parameters
otherBoneData: BoneData  Other bone data to copy from.
Fields
CorrectionQuaternion : Quaternion?
Offset quaternion, used for retargeting rotations.
Signature 
Quaternion? OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.CorrectionQuaternion
DegenerateJoint : bool
Some joints made have bad orientations due to faulty joint pairs.
Signature 
bool OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.DegenerateJoint
FromPosition : Vector3
From position for joint pair, for debugging.
Signature 
Vector3 OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.FromPosition
JointPairEnd : Transform
End of joint pair.
Signature 
Transform OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.JointPairEnd
JointPairOrientation : Quaternion
Orientation or rotation corresponding to joint pair.
If multiplied by forward, produces a coordinate axis.
Signature 
Quaternion OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.JointPairOrientation
JointPairStart : Transform
Start of joint pair (usually the original joint).
Signature 
Transform OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.JointPairStart
OriginalJoint : Transform
Transform associated with joint.
Signature 
Transform OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.OriginalJoint
ParentTransform : Transform
Parent transform of joint.
This is defined in a special way for OVRSkeleton, so we have to cache it ahead of time.
Signature 
Transform OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.ParentTransform
ToPosition : Vector3
To position for joint pair, for debugging.
Signature 
Vector3 OVRUnityHumanoidSkeletonRetargeter.OVRSkeletonMetadata.BoneData.ToPosition

Inner Enum

UpdateType Enum

Enumeration Constants

MemberValue
FixedUpdateOnly
0
UpdateOnly
FixedUpdateAndUpdate
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta