feat(Runtime): Deformation constraint supports OVRSkeleton

Summary: This changes allows deformation constraint to be used with `OVRSkeleton`, as opposed to characters that only use `OVRCustomSkeleton`.

Reviewed By: andkim-meta

Differential Revision: D46093353

fbshipit-source-id: 66075f123ada9f2e52dfe516300e70a0d23cbc70

Author: sohailshafiiWk

Editor/AnimationRigging/DeformationConstraintEditor.cs

@@ -21,7 +21,7 @@ public override void OnInspectorGUI()
                 if (GUILayout.Button("Find OVR Skeleton"))
                 {
                     Undo.RecordObject(constraint, "Find OVR Skeleton");
-                    var skeleton = constraint.GetComponentInParent<OVRCustomSkeleton>();
+                    var skeleton = constraint.GetComponentInParent<OVRSkeleton>();
                     constraint.data.AssignOVRSkeleton(skeleton);
                 }
                 GUILayout.Space(EditorGUIUtility.standardVerticalSpacing);

Runtime/Scripts/AnimationRigging/DeformationConstraint.cs

@@ -90,7 +90,7 @@ public interface IDeformationData
         /// <summary>
         /// The OVR Skeleton component for the character.
         /// </summary>
-        public OVRCustomSkeleton ConstraintSkeleton { get; }
+        public OVRSkeleton ConstraintSkeleton { get; }
 
         /// <summary>
         /// The array of transforms from the hips to the head bones.
@@ -152,7 +152,7 @@ public enum SpineTranslationCorrectionType
 
         // Interface implementation
         /// <inheritdoc />
-        OVRCustomSkeleton IDeformationData.ConstraintSkeleton => _skeleton;
+        OVRSkeleton IDeformationData.ConstraintSkeleton => _skeleton;
 
         /// <inheritdoc />
         SpineTranslationCorrectionType IDeformationData.SpineCorrectionType => _spineTranslationCorrectionType;
@@ -178,7 +178,7 @@ public enum SpineTranslationCorrectionType
         /// <inheritdoc cref="IDeformationData.ConstraintSkeleton"/>
         [NotKeyable, SerializeField]
         [Tooltip(DeformationDataTooltips.Skeleton)]
-        private OVRCustomSkeleton _skeleton;
+        private OVRSkeleton _skeleton;
 
         /// <inheritdoc cref="IDeformationData.SpineCorrectionType"/>
         [NotKeyable, SerializeField]
@@ -245,57 +245,107 @@ public enum SpineTranslationCorrectionType
         /// <summary>
         /// Setup the deformation data struct for the deformation job.
         /// </summary>
-        public void Setup()
+        /// <param name="dummyOne">Dummy transform if skeleton is not ready.</param>
+        /// <param name="dummyTwo">Dummy transform if skeleton is not ready.</param>
+        public void Setup(Transform dummyOne, Transform dummyTwo)
         {
-            SetupHipsHeadData();
-            SetupArmData();
-            SetupBonePairs();
+            SetupHipsHeadData(dummyOne, dummyTwo);
+            SetupArmData(dummyOne, dummyTwo);
+            SetupBonePairs(dummyOne);
         }
 
         /// <summary>
         /// Assign the OVR Skeleton.
         /// </summary>
         /// <param name="skeleton">The OVRSkeleton</param>
-        public void AssignOVRSkeleton(OVRCustomSkeleton skeleton)
+        public void AssignOVRSkeleton(OVRSkeleton skeleton)
         {
             _skeleton = skeleton;
         }
 
-        private void SetupHipsHeadData()
+        private void SetupHipsHeadData(Transform dummyOne, Transform dummyTwo)
         {
             // Setup hips to head
             var hipToHeadBones = new List<Transform>();
-            for (int i = (int)OVRSkeleton.BoneId.Body_Hips; i <= (int)OVRSkeleton.BoneId.Body_Head; i++)
+
+            if (_skeleton.IsInitialized)
+            {
+                for (int boneId = (int)OVRSkeleton.BoneId.Body_Hips; boneId <= (int)OVRSkeleton.BoneId.Body_Head; boneId++)
+                {
+                    var bones = _skeleton.Bones;
+                    for (int boneIndex = 0; boneIndex < bones.Count; boneIndex++)
+                    {
+                        if (bones[boneIndex].Id == (OVRSkeleton.BoneId)boneId)
+                        {
+                            hipToHeadBones.Add(_skeleton.Bones[boneIndex].Transform);
+                        }
+                    }
+                }
+            }
+            else
             {
-                hipToHeadBones.Add(_skeleton.CustomBones[i].transform);
+                hipToHeadBones.Add(dummyOne);
+                hipToHeadBones.Add(dummyTwo);
             }
+
             _hipsToHeadDistance =
                 Vector3.Distance(hipToHeadBones[0].position, hipToHeadBones[^1].position);
             _hipsToHeadBones = hipToHeadBones.ToArray();
         }
 
-        private void SetupArmData()
+        private Transform FindBoneTransform(OVRSkeleton.BoneId boneId)
+        {
+            if (!_skeleton.IsInitialized)
+            {
+                return null;
+            }
+            var bones = _skeleton.Bones;
+            for (int boneIndex = 0; boneIndex < bones.Count; boneIndex++)
+            {
+                if (bones[boneIndex].Id == boneId)
+                {
+                    return bones[boneIndex].Transform;
+                }
+            }
+
+            return null;
+        }
+
+        private void SetupArmData(Transform dummyOne, Transform dummyTwo)
         {
+            bool skeletonInitialized = _skeleton.IsInitialized;
             // Setup arm data
             _leftArmData = new ArmPosData()
             {
                 Weight = _armWeight,
                 MoveSpeed = _armMoveSpeed,
-                ShoulderBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_LeftShoulder],
-                UpperArmBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_LeftArmUpper],
-                LowerArmBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_LeftArmLower],
+                ShoulderBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_LeftShoulder) :
+                    dummyOne,
+                UpperArmBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_LeftArmUpper) :
+                    dummyTwo,
+                LowerArmBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_LeftArmLower) :
+                    dummyTwo,
             };
             _rightArmData = new ArmPosData()
             {
                 Weight = _armWeight,
                 MoveSpeed = _armMoveSpeed,
-                ShoulderBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_RightShoulder],
-                UpperArmBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_RightArmUpper],
-                LowerArmBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_RightArmLower],
+                ShoulderBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_RightShoulder) :
+                    dummyOne,
+                UpperArmBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_RightArmUpper) :
+                    dummyTwo,
+                LowerArmBone = skeletonInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_RightArmLower) :
+                    dummyTwo,
             };
         }
 
-        private void SetupBonePairs()
+        private void SetupBonePairs(Transform dummyTransform)
         {
             // Setup bone pairs
             var bonePairs = new List<BonePairData>();
@@ -317,7 +367,9 @@ private void SetupBonePairs()
 
             if (_applyToArms)
             {
-                var chestBone = _skeleton.CustomBones[(int)OVRSkeleton.BoneId.Body_Chest].transform;
+                var chestBone = _skeleton.IsInitialized ?
+                    FindBoneTransform(OVRSkeleton.BoneId.Body_Chest) :
+                    dummyTransform;
                 var chestBonePos = chestBone.position;
                 var leftShoulderBonePos = _leftArmData.ShoulderBone.position;
                 var rightShoulderBonePos = _rightArmData.ShoulderBone.position;
@@ -416,14 +468,25 @@ public class DeformationConstraint : RigConstraint<
         DeformationJobBinder<DeformationData>>,
         IOVRSkeletonConstraint
     {
+        private GameObject _dummyOne, _dummyTwo;
+
+        private void Awake()
+        {
+            _dummyOne = new GameObject("Deformation Constraint Dummy 1");
+            _dummyOne.transform.SetParent(this.transform);
+            _dummyTwo = new GameObject("Deformation Constraint Dummy 2");
+            _dummyTwo.transform.SetParent(this.transform);
+        }
+
         private void Start()
         {
-            data.Setup();
+            data.Setup(_dummyOne.transform, _dummyTwo.transform);
         }
 
         /// <inheritdoc />
         public void RegenerateData()
         {
+            data.Setup(_dummyOne.transform, _dummyTwo.transform);
         }
     }
 }