feat(Editor): Update helper menus to add retargeting processors on the one-click setup

Andrew Kim · facebook-github-bot · commit cb2d5daa0b21 · 2023-10-30T20:00:28.000-07:00
Summary:
Update HelperMenus to add the required retargeting processors to a character.
Update RetargetingProcessorScriptableObjectDrawer so that if the scriptable object is an instance in the scene, it can be saved on disk to a file.

Reviewed By: sohailshafiiWk

Differential Revision: D50812698

fbshipit-source-id: bc2b8359c71cf777f94ab7a03951af58b90e92ea
diff --git a/Editor/Meta.Movement.Editor.asmdef b/Editor/Meta.Movement.Editor.asmdef
@@ -3,6 +3,7 @@
     "rootNamespace": "",
     "references": [
         "GUID:502e28d01b3ebaf4689df96d8655467c",
+        "GUID:2a230cb87a1d3ba4a98bdc0ddae76e6c",
         "GUID:f64c9ebcd7899c3448a08dc9f9ddbe30",
         "GUID:d2761a0af0f567748a72629d4bb18a26",
         "GUID:7305c54a43f3814439df347c7519653e",
diff --git a/Editor/ThirdParty/RetargetingProcessorScriptableObjectDrawer.cs b/Editor/ThirdParty/RetargetingProcessorScriptableObjectDrawer.cs
@@ -21,6 +21,10 @@ namespace Oculus.Movement.AnimationRigging
     [CustomPropertyDrawer(typeof(RetargetingProcessor), true)]
     public class RetargetingProcessorScriptableObjectDrawer : PropertyDrawer
     {
+        private const int buttonWidth = 66;
+        private static readonly List<string> ignoreClassFullNames = new List<string> { "TMPro.TMP_FontAsset" };
+
+        /// <inheritdoc />
         public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
         {
             float totalHeight = EditorGUIUtility.singleLineHeight;
@@ -39,7 +43,10 @@ public override float GetPropertyHeight(SerializedProperty property, GUIContent
                 {
                     do
                     {
-                        if (prop.name == "m_Script") continue;
+                        if (prop.name == "m_Script")
+                        {
+                            continue;
+                        }
                         var subProp = serializedObject.FindProperty(prop.name);
                         float height = EditorGUI.GetPropertyHeight(subProp, null, true) +
                                        EditorGUIUtility.standardVerticalSpacing;
@@ -55,10 +62,7 @@ public override float GetPropertyHeight(SerializedProperty property, GUIContent
             return totalHeight;
         }
 
-        const int buttonWidth = 66;
-
-        static readonly List<string> ignoreClassFullNames = new List<string> { "TMPro.TMP_FontAsset" };
-
+        /// <inheritdoc />
         public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
         {
             EditorGUI.BeginProperty(position, label, property);
@@ -98,24 +102,63 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
 
             var indentedPosition = EditorGUI.IndentedRect(position);
             var indentOffset = indentedPosition.x - position.x;
+            var saveToAssets = false;
+            var propertyWidth = buttonWidth;
             propertyRect = new Rect(position.x + (EditorGUIUtility.labelWidth - indentOffset), position.y,
                 position.width - (EditorGUIUtility.labelWidth - indentOffset), EditorGUIUtility.singleLineHeight);
 
-            if (propertySO != null || property.objectReferenceValue == null)
+            if (property.propertyType == SerializedPropertyType.ObjectReference &&
+                property.objectReferenceValue != null)
+            {
+                var data = (ScriptableObject)property.objectReferenceValue;
+                if (!AssetDatabase.Contains(data))
+                {
+                    saveToAssets = true;
+                    propertyWidth = Mathf.RoundToInt(buttonWidth * 1.5f);
+                }
+            }
+
+            if (propertySO != null || property.objectReferenceValue == null || saveToAssets)
             {
-                propertyRect.width -= buttonWidth;
+                propertyRect.width -= propertyWidth;
             }
 
             EditorGUI.ObjectField(propertyRect, property, type, GUIContent.none);
-            if (GUI.changed) property.serializedObject.ApplyModifiedProperties();
+            if (GUI.changed)
+            {
+                property.serializedObject.ApplyModifiedProperties();
+            }
 
-            var buttonRect = new Rect(position.x + position.width - buttonWidth, position.y, buttonWidth,
+            var buttonRect = new Rect(position.x + position.width - propertyWidth, position.y, propertyWidth,
                 EditorGUIUtility.singleLineHeight);
 
             if (property.propertyType == SerializedPropertyType.ObjectReference && property.objectReferenceValue != null)
             {
                 var data = (ScriptableObject)property.objectReferenceValue;
 
+                if (saveToAssets)
+                {
+                    if (GUI.Button(buttonRect, "Save to Assets"))
+                    {
+                        string selectedAssetPath = "Assets";
+                        if (property.serializedObject.targetObject is MonoBehaviour)
+                        {
+                            MonoScript ms = MonoScript.FromMonoBehaviour((MonoBehaviour)property.serializedObject.targetObject);
+                            selectedAssetPath = System.IO.Path.GetDirectoryName(AssetDatabase.GetAssetPath(ms));
+                        }
+
+                        var replacementObject = ReplaceAssetWithSavePrompt(data.GetType(), selectedAssetPath, data as RetargetingProcessor);
+                        if (replacementObject != null)
+                        {
+                            Undo.DestroyObjectImmediate(data);
+                            property.objectReferenceValue = replacementObject;
+                        }
+                        property.serializedObject.ApplyModifiedProperties();
+                        GUIUtility.ExitGUI();
+                        return;
+                    }
+                }
+
                 if (property.isExpanded)
                 {
                     // Draw a background that shows us clearly which fields are part of the ScriptableObject
@@ -137,7 +180,10 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
                         do
                         {
                             // Don't bother drawing the class file
-                            if (prop.name == "m_Script") continue;
+                            if (prop.name == "m_Script")
+                            {
+                                continue;
+                            }
                             float height = EditorGUI.GetPropertyHeight(prop, new GUIContent(prop.displayName), true);
                             EditorGUI.PropertyField(new Rect(position.x, y, position.width - buttonWidth, height), prop,
                                 true);
@@ -146,7 +192,9 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
                     }
 
                     if (GUI.changed)
+                    {
                         serializedObject.ApplyModifiedProperties();
+                    }
                     serializedObject.Dispose();
                     EditorGUI.indentLevel--;
                 }
@@ -163,19 +211,22 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
                     }
 
                     property.objectReferenceValue = CreateAssetWithSavePrompt(type, selectedAssetPath);
+                    property.serializedObject.ApplyModifiedProperties();
+                    GUIUtility.ExitGUI();
+                    return;
                 }
             }
 
             property.serializedObject.ApplyModifiedProperties();
             EditorGUI.EndProperty();
         }
 
-        public static T _GUILayout<T>(string label, T objectReferenceValue, ref bool isExpanded) where T : ScriptableObject
+        private static T _GUILayout<T>(string label, T objectReferenceValue, ref bool isExpanded) where T : ScriptableObject
         {
             return _GUILayout<T>(new GUIContent(label), objectReferenceValue, ref isExpanded);
         }
 
-        public static T _GUILayout<T>(GUIContent label, T objectReferenceValue, ref bool isExpanded)
+        private static T _GUILayout<T>(GUIContent label, T objectReferenceValue, ref bool isExpanded)
             where T : ScriptableObject
         {
             Rect position = EditorGUILayout.BeginVertical();
@@ -239,7 +290,7 @@ public static T _GUILayout<T>(GUIContent label, T objectReferenceValue, ref bool
             return objectReferenceValue;
         }
 
-        static void DrawScriptableObjectChildFields<T>(T objectReferenceValue) where T : ScriptableObject
+        private static void DrawScriptableObjectChildFields<T>(T objectReferenceValue) where T : ScriptableObject
         {
             // Draw a background that shows us clearly which fields are part of the ScriptableObject
             EditorGUI.indentLevel++;
@@ -259,13 +310,15 @@ static void DrawScriptableObjectChildFields<T>(T objectReferenceValue) where T :
             }
 
             if (GUI.changed)
+            {
                 serializedObject.ApplyModifiedProperties();
+            }
             serializedObject.Dispose();
             EditorGUILayout.EndVertical();
             EditorGUI.indentLevel--;
         }
 
-        public static T DrawScriptableObjectField<T>(GUIContent label, T objectReferenceValue, ref bool isExpanded)
+        private static T DrawScriptableObjectField<T>(GUIContent label, T objectReferenceValue, ref bool isExpanded)
             where T : ScriptableObject
         {
             Rect position = EditorGUILayout.BeginVertical();
@@ -329,11 +382,14 @@ public static T DrawScriptableObjectField<T>(GUIContent label, T objectReference
         }
 
         // Creates a new ScriptableObject via the default Save File panel
-        static ScriptableObject CreateAssetWithSavePrompt(Type type, string path)
+        private static ScriptableObject CreateAssetWithSavePrompt(Type type, string path)
         {
             path = EditorUtility.SaveFilePanelInProject("Save ScriptableObject", type.Name + ".asset", "asset",
                 "Enter a file name for the ScriptableObject.", path);
-            if (path == "") return null;
+            if (path == "")
+            {
+                return null;
+            }
             ScriptableObject asset = ScriptableObject.CreateInstance(type);
             AssetDatabase.CreateAsset(asset, path);
             AssetDatabase.SaveAssets();
@@ -343,16 +399,43 @@ static ScriptableObject CreateAssetWithSavePrompt(Type type, string path)
             return asset;
         }
 
-        Type GetFieldType()
+        private static ScriptableObject ReplaceAssetWithSavePrompt(Type type, string path, RetargetingProcessor processor)
+        {
+            path = EditorUtility.SaveFilePanelInProject("Save ScriptableObject", processor.name + ".asset", "asset",
+                "Enter a file name for the ScriptableObject.", path);
+            if (path == "")
+            {
+                return null;
+            }
+            ScriptableObject asset = ScriptableObject.CreateInstance(type);
+            var newProcessor = asset as RetargetingProcessor;
+            if (newProcessor != null)
+            {
+                newProcessor.CopyData(processor);
+            }
+            AssetDatabase.CreateAsset(asset, path);
+            AssetDatabase.SaveAssets();
+            AssetDatabase.Refresh();
+            AssetDatabase.ImportAsset(path, ImportAssetOptions.ForceUpdate);
+            EditorGUIUtility.PingObject(asset);
+            return asset;
+        }
+
+        private Type GetFieldType()
         {
             Type type = fieldInfo.FieldType;
-            if (type.IsArray) type = type.GetElementType();
+            if (type.IsArray)
+            {
+                type = type.GetElementType();
+            }
             else if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(List<>))
+            {
                 type = type.GetGenericArguments()[0];
+            }
             return type;
         }
 
-        static bool AreAnySubPropertiesVisible(SerializedProperty property)
+        private static bool AreAnySubPropertiesVisible(SerializedProperty property)
         {
             var data = (ScriptableObject)property.objectReferenceValue;
             SerializedObject serializedObject = new SerializedObject(data);
diff --git a/Editor/Utils/HelperMenus.cs b/Editor/Utils/HelperMenus.cs
@@ -1,5 +1,6 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
+using Oculus.Interaction.Input;
 using Oculus.Movement.AnimationRigging;
 using Oculus.Movement.Tracking;
 using System;
@@ -98,6 +99,11 @@ private static void SetupCharacterForAnimationRiggingRetargetingConstraints()
             AddAnimationRiggingLayer(activeGameObject, retargetingLayer, rigBuilder,
                 constraintMonos.ToArray(), retargetingLayer);
 
+            // Add retargeting processors to the retargeting layer.
+            AddCorrectBonesRetargetingProcessor(retargetingLayer);
+            AddCorrectHandRetargetingProcessor(retargetingLayer, Handedness.Left);
+            AddCorrectHandRetargetingProcessor(retargetingLayer, Handedness.Right);
+
             Undo.SetCurrentGroupName("Setup Animation Rigging Retargeting");
         }
 
@@ -300,6 +306,55 @@ private static void AddAnimationRiggingLayer(GameObject mainParent,
             Undo.RegisterCreatedObjectUndo(rigSetup, "Create Anim Rig Setup");
         }
 
+        private static void AddCorrectBonesRetargetingProcessor(RetargetingLayer retargetingLayer)
+        {
+            bool needCorrectBones = true;
+            foreach (var processor in retargetingLayer.RetargetingProcessors)
+            {
+                if (processor as RetargetingProcessorCorrectBones != null)
+                {
+                    needCorrectBones = false;
+                }
+            }
+
+            if (needCorrectBones)
+            {
+                var retargetingProcessorCorrectBones = ScriptableObject.CreateInstance<RetargetingProcessorCorrectBones>();
+                Undo.RegisterCreatedObjectUndo(retargetingProcessorCorrectBones, "Create correct bones retargeting processor.");
+                Undo.RecordObject (retargetingLayer, "Add retargeting processor to retargeting layer.");
+                retargetingProcessorCorrectBones.name = "CorrectBones";
+                retargetingLayer.AddRetargetingProcessor(retargetingProcessorCorrectBones);
+            }
+        }
+
+        private static void AddCorrectHandRetargetingProcessor(RetargetingLayer retargetingLayer, Handedness handedness)
+        {
+            bool needCorrectHand = true;
+            foreach (var processor in retargetingLayer.RetargetingProcessors)
+            {
+                var correctHand = processor as RetargetingProcessorCorrectHand;
+                if (correctHand != null)
+                {
+                    if (correctHand.Handedness == handedness)
+                    {
+                        needCorrectHand = false;
+                    }
+                }
+            }
+
+            if (needCorrectHand)
+            {
+                var retargetingProcessorCorrectHand = ScriptableObject.CreateInstance<RetargetingProcessorCorrectHand>();
+                var handednessString = handedness == Handedness.Left ? "Left" : "Right";
+                Undo.RegisterCreatedObjectUndo(retargetingProcessorCorrectHand, $"Create correct hand ({handednessString}) retargeting processor.");
+                Undo.RecordObject (retargetingLayer, "Add retargeting processor to retargeting layer.");
+                retargetingProcessorCorrectHand.Handedness = handedness;
+                retargetingProcessorCorrectHand.HandIKType = RetargetingProcessorCorrectHand.IKType.CCDIK;
+                retargetingProcessorCorrectHand.name = $"Correct{handednessString}Hand";
+                retargetingLayer.AddRetargetingProcessor(retargetingProcessorCorrectHand);
+            }
+        }
+
         private static RetargetedBoneTarget[] AddSpineBoneTargets(GameObject rigObject,
             Animator animator)
         {
diff --git a/Runtime/Scripts/AnimationRigging/RetargetingLayer.cs b/Runtime/Scripts/AnimationRigging/RetargetingLayer.cs
@@ -167,7 +167,7 @@ public RetargetingAnimationConstraint RetargetingConstraint
         /// </summary>
         [SerializeField]
         [Tooltip(RetargetingLayerTooltips.RetargetingProcessors)]
-        protected List<RetargetingProcessor> _retargetingProcessors;
+        protected List<RetargetingProcessor> _retargetingProcessors = new();
         /// <inheritdoc cref="_retargetingProcessors"/>
         public List<RetargetingProcessor> RetargetingProcessors
         {
@@ -661,6 +661,15 @@ public void RemoveProcessor(IOVRSkeletonProcessor processor)
             _skeletonPostProcessing -= processor.ProcessSkeleton;
         }
 
+        /// <summary>
+        /// Add the specified retargeting processor.
+        /// </summary>
+        /// <param name="processor">The processor to be added.</param>
+        public void AddRetargetingProcessor(RetargetingProcessor processor)
+        {
+            _retargetingProcessors.Add(processor);
+        }
+
         /// <summary>
         /// Gets number of transforms being retargeted currently. This can change during
         /// initialization.
diff --git a/Runtime/Scripts/RetargetingProcessing/RetargetingProcessor.cs b/Runtime/Scripts/RetargetingProcessing/RetargetingProcessor.cs
@@ -15,6 +15,15 @@ public class RetargetingProcessor : ScriptableObject, IRetargetingProcessor
         [Range(0.0f, 1.0f)]
         public float Weight = 1.0f;
 
+        /// <summary>
+        /// Deep copy data from another processor to this processor.
+        /// </summary>
+        /// <param name="source">The source processor to copy from.</param>
+        public virtual void CopyData(RetargetingProcessor source)
+        {
+            Weight = source.Weight;
+        }
+
         /// <inheritdoc />
         public virtual void SetupRetargetingProcessor(RetargetingLayer retargetingLayer)
         {
diff --git a/Runtime/Scripts/RetargetingProcessing/RetargetingProcessorCorrectBones.cs b/Runtime/Scripts/RetargetingProcessing/RetargetingProcessorCorrectBones.cs
@@ -67,6 +67,22 @@ public float RightHandCorrectionWeightLateUpdate
             set => _rightHandCorrectionWeightLateUpdate = value;
         }
 
+        /// <inheritdoc />
+        public override void CopyData(RetargetingProcessor source)
+        {
+            base.CopyData(source);
+            var sourceCorrectBones = source as RetargetingProcessorCorrectBones;
+            if (sourceCorrectBones == null)
+            {
+                Debug.LogError($"Failed to copy properties from {source.name} processor to {name} processor");
+                return;
+            }
+            _correctPositionsLateUpdate = sourceCorrectBones.CorrectPositionsLateUpdate;
+            _shoulderCorrectionWeightLateUpdate = sourceCorrectBones.ShoulderCorrectionWeightLateUpdate;
+            _leftHandCorrectionWeightLateUpdate = sourceCorrectBones.LeftHandCorrectionWeightLateUpdate;
+            _rightHandCorrectionWeightLateUpdate = sourceCorrectBones.RightHandCorrectionWeightLateUpdate;
+        }
+
         /// <inheritdoc />
         public override void ProcessRetargetingLayer(RetargetingLayer retargetingLayer, IList<OVRBone> ovrBones)
         {
@@ -76,8 +92,8 @@ public override void ProcessRetargetingLayer(RetargetingLayer retargetingLayer,
             }
 
             bool handCorrectionTurnedOn =
-                _leftHandCorrectionWeightLateUpdate > Mathf.Epsilon ||
-                _rightHandCorrectionWeightLateUpdate > Mathf.Epsilon;
+                LeftHandCorrectionWeightLateUpdate > Mathf.Epsilon ||
+                RightHandCorrectionWeightLateUpdate > Mathf.Epsilon;
 
             if (ovrBones == null)
             {
diff --git a/Runtime/Scripts/RetargetingProcessing/RetargetingProcessorCorrectHand.cs b/Runtime/Scripts/RetargetingProcessing/RetargetingProcessorCorrectHand.cs
