Merge pull request #309 from Unity-Technologies/Uni-35304-UnitTestsForExportingTimelineClip

Uni 35304 unit tests for exporting timeline clip

Author: MarcShakour

Assets/FbxExporters/Editor/FbxExporter.cs

@@ -83,7 +83,7 @@ public class ModelExporter : System.IDisposable
             //       being called only once regardless of what is selected.
             const string MenuItemName = "GameObject/Export Model...";
 
-            const string ClipMenuItemName = "GameObject/Export All Timeline Clips...";
+            const string ClipMenuItemName = "GameObject/Export All Recorded Animation Clips...";
             const string TimelineClipMenuItemName = "GameObject/Export Selected Timeline Clip...";																				
 
             const string AnimOnlyMenuItemName = "GameObject/Export Animation Only...";
@@ -2945,45 +2945,62 @@ private void ReplaceFile ()
             }
 
             /// <summary>
-            /// Add an option "Export selected Timeline clip" in the contextual GameObject menu.
+            /// GameObject/Export Selected Timeline Clip...
             /// </summary>
-            [MenuItem(TimelineClipMenuItemName, false, 31)]
+            /// <param name="command"></param>
+			[MenuItem(TimelineClipMenuItemName, false, 31)]
             static void OnClipContextClick(MenuCommand command)
             {
-                var selectedObjects = Selection.objects;
-                foreach (var obj in selectedObjects)
+                // Now that we know we have stuff to export, get the user-desired path.
+                string directory = string.IsNullOrEmpty(LastFilePath)
+                                      ? Application.dataPath
+                                      : System.IO.Path.GetDirectoryName(LastFilePath);
+
+                string title = "Select the folder in which the animation files from the timeline will be exported";
+                string folderPath = EditorUtility.SaveFolderPanel(title, directory, "");
+
+                if (string.IsNullOrEmpty(folderPath))
                 {
-                    if (obj.GetType().Name.Contains("EditorClip"))
-                    {
-                        var timeLineClip = GetPropertyFromObject<TimelineClip> (obj, "clip");
+                    return;
+                }
+                Debug.Log(folderPath);
 
-                        var selClipItem = GetPropertyFromObject<object>(obj, "item");
-                        var editorClipAnimationTrack = GetPropertyFromObject<AnimationTrack> (selClipItem, "parentTrack");
+                Object[] selectedObjects = Selection.objects;
 
-                        GameObject animationTrackGObject = UnityEditor.Timeline.TimelineEditor.playableDirector.GetGenericBinding (editorClipAnimationTrack) as GameObject;
+                foreach (Object editorClipSelected in selectedObjects)
+                {
+                    ExportSingleEditorClip(editorClipSelected, folderPath);
+                }
+            }
 
-                        string filePath = GetExportFilePath (animationTrackGObject.name + "@" + timeLineClip.animationClip.name);
-                        if (string.IsNullOrEmpty (filePath)) {
-                            continue;
-                        }
+            public static void ExportSingleEditorClip(Object editorClipSelected, string folderPath)
+            {
+                if (editorClipSelected.GetType().Name.Contains("EditorClip"))
+                {
+                    object selClip = editorClipSelected.GetType().GetProperty("clip").GetValue(editorClipSelected, null);
+					UnityEngine.Timeline.TimelineClip timeLineClip = selClip as UnityEngine.Timeline.TimelineClip;
 
-                        UnityEngine.Object[] myArray = new UnityEngine.Object[] { animationTrackGObject, timeLineClip.animationClip };
+					object selClipItem = editorClipSelected.GetType().GetProperty("item").GetValue(editorClipSelected, null);
+					object selClipItemParentTrack = selClipItem.GetType().GetProperty("parentTrack").GetValue(selClipItem, null);
+					AnimationTrack editorClipAnimationTrack = selClipItemParentTrack as AnimationTrack;
+                    GameObject animationTrackGObject = UnityEditor.Timeline.TimelineEditor.playableDirector.GetGenericBinding (editorClipAnimationTrack) as GameObject;
 
-                        ExportObjects (filePath, myArray, AnimationExportType.timelineAnimationClip);
-                        return;
-                    } 
-                }
+                    ExportSingleTimelineClip(timeLineClip, folderPath, animationTrackGObject);
+                } 
             }
 
-            private static T GetPropertyFromObject<T>(object obj, string propertyName) where T : class {
-                return obj.GetType ().GetProperty (propertyName).GetValue (obj, null) as T;
+            public static void ExportSingleTimelineClip(TimelineClip timelineClipSelected, string folderPath, GameObject animationTrackGObject)
+            {
+				string filePath = folderPath + "/" + animationTrackGObject.name + "@" + timelineClipSelected.animationClip.name + ".fbx";
+				UnityEngine.Object[] myArray = new UnityEngine.Object[] { animationTrackGObject, timelineClipSelected.animationClip };
+				ExportObjects(filePath, myArray, AnimationExportType.timelineAnimationClip);
             }
 
             /// <summary>
-            /// Add an option "Export all Timeline clips" in the contextual GameObject menu.
+            /// Add an option " GameObject/Export All Recorded Animation Clips..." in the contextual GameObject menu.
             /// </summary>
             [MenuItem(ClipMenuItemName, false, 31)]
-            static void OnGameObjectWithTimelineContextClick(MenuCommand command)
+            public static void OnPlayableDirectorGameObjectContextClick(MenuCommand command)
             {
                 // Now that we know we have stuff to export, get the user-desired path.
                 string directory = string.IsNullOrEmpty(LastFilePath)
@@ -3008,31 +3025,38 @@ static void OnGameObjectWithTimelineContextClick(MenuCommand command)
                 else
                 {
                     // We were invoked from the right-click menu, so use the context of the context menu.
-                    var selected = command.context as GameObject;
+                    GameObject selected = command.context as GameObject;
                     if (selected)
                     {
                         selection = new GameObject[] { selected };
                     }
                 }
 
-                foreach (GameObject obj in selection)
+                foreach (GameObject objectWithPlayableDirector in selection)
                 {
-                    PlayableDirector pd = obj.GetComponent<PlayableDirector>();
-                    if (pd != null)
-                    {
-                        foreach (PlayableBinding output in pd.playableAsset.outputs)
-                        {
-                            AnimationTrack at = output.sourceObject as AnimationTrack;
+                    ExportAllTimelineClips(objectWithPlayableDirector,folderPath);
+                }
+            }
 
-                            GameObject atObject = pd.GetGenericBinding(output.sourceObject) as GameObject;
-                            // One file by animation clip
-                            foreach (TimelineClip timeLineClip in at.GetClips()) {
-                                string filePath = string.Format(AnimFbxFileFormat, folderPath, atObject.name, timeLineClip.animationClip.name);
-                                UnityEngine.Object[] myArray = new UnityEngine.Object[] { atObject, timeLineClip.animationClip };
-                                ExportObjects (filePath, myArray, AnimationExportType.timelineAnimationClip);
+            public static void ExportAllTimelineClips(GameObject objectWithPlayableDirector, string folderPath)
+            {
+                Debug.Log(objectWithPlayableDirector.GetType().BaseType.ToString() + ":" + objectWithPlayableDirector.name);
 
-                            }
-                        }
+                PlayableDirector pd = objectWithPlayableDirector.GetComponent<PlayableDirector>();
+                if (pd != null)
+                {
+                    foreach (PlayableBinding output in pd.playableAsset.outputs)
+                    {
+                        AnimationTrack at = output.sourceObject as AnimationTrack;
+
+                        GameObject atObject = pd.GetGenericBinding(output.sourceObject) as GameObject;
+			            // One file by animation clip
+			            foreach(TimelineClip timeLineClip in at.GetClips())
+			            {
+				            string filePath = folderPath + "/" + atObject.name + "@" + timeLineClip.animationClip.name + ".fbx";
+				            UnityEngine.Object[] myArray = new UnityEngine.Object[] { atObject, timeLineClip.animationClip };
+				            ExportObjects(filePath, myArray, AnimationExportType.timelineAnimationClip);
+			            }
                     }
                 }
             }
@@ -3581,7 +3605,6 @@ private static string GetExportFilePath(string filenameSuggestion = ""){
 
             private static void OnExport (AnimationExportType exportType = AnimationExportType.all)
             {
-
                 // Now that we know we have stuff to export, get the user-desired path.
                 GameObject [] selectedGOs = Selection.GetFiltered<GameObject> (SelectionMode.TopLevel);
                 string filename = null;
@@ -3610,6 +3633,7 @@ private static void OnExport (AnimationExportType exportType = AnimationExportTy
             /// Export a list of (Game) objects to FBX file. 
             /// Use the SaveFile panel to allow user to enter a file name.
             /// <summary>
+            //public static string ExportObjects (string filePath, UnityEngine.Object[] objects = null, AnimationExportType exportType = AnimationExportType.all /*, bool animOnly = false*/)
             public static string ExportObjects (
                 string filePath,
                 UnityEngine.Object[] objects = null,
@@ -3666,6 +3690,7 @@ public static string ExportObjects (
                 return null;
             }
 
+            //public static string ExportObject (string filePath, UnityEngine.Object root, AnimationExportType exportType = AnimationExportType.all /*, bool animOnly = false*/)
             public static string ExportObject (
                 string filePath, UnityEngine.Object root,
                 AnimationExportType exportType = AnimationExportType.all,

Assets/FbxExporters/Editor/UnitTests/ExportTimelineClipTest.cs

@@ -0,0 +1,59 @@
+using UnityEngine;
+using UnityEditor;
+using NUnit.Framework;
+using FbxExporters.Editor;
+using UnityEngine.Timeline;
+using UnityEngine.Playables;
+using UnityEditor.SceneManagement;
+
+namespace FbxExporters.UnitTests
+{
+    public class ExportTimelineClipTest : ExporterTestBase
+    {
+        private static string m_testScenePath = "Scene/TestScene.unity";
+
+        [SetUp]
+        public override void Init()
+        {
+            base.Init ();
+            string testScenePath = FindPathInUnitTests (m_testScenePath);
+            Assert.That (testScenePath, Is.Not.Null);
+            EditorSceneManager.OpenScene("Assets/" + testScenePath);
+        }
+
+        [Test]
+        public void ExportSingleTimelineClipTest()
+        {
+            GameObject myCube = GameObject.Find("CubeSpecial");
+            string folderPath = GetRandomFileNamePath(extName: "");
+
+            PlayableDirector pd = myCube.GetComponent<PlayableDirector> ();
+            if (pd != null) {
+                foreach (PlayableBinding output in pd.playableAsset.outputs) {
+                    AnimationTrack at = output.sourceObject as AnimationTrack;
+
+                    GameObject atObject = pd.GetGenericBinding (output.sourceObject) as GameObject;
+                    // One file by animation clip
+                    foreach (TimelineClip timeLineClip in at.GetClips()) {
+                        ModelExporter.ExportSingleTimelineClip (timeLineClip, folderPath, atObject);
+                        FileAssert.Exists (string.Format("{0}/{1}@{2}", folderPath, atObject.name, "Recorded.fbx"));
+                    }
+                }
+            }
+        }
+
+        [Test]
+        public void ExportAllTimelineClipTest()
+        {
+            GameObject myCube = GameObject.Find("CubeSpecial");
+            Selection.objects = new UnityEngine.GameObject[] { myCube };
+            string folderPath = GetRandomFileNamePath(extName: "");
+
+            foreach(GameObject obj in Selection.objects)
+            {
+                ModelExporter.ExportAllTimelineClips(obj, folderPath);
+                FileAssert.Exists(string.Format("{0}/{1}@{2}", folderPath, obj.name, "Recorded.fbx"));
+            }
+        }
+    }
+}

Assets/FbxExporters/Editor/UnitTests/ExportTimelineClipTest.cs.meta

@@ -194,6 +194,9 @@ void DeleteOnNextUpdate()
         [TearDown]
         public virtual void Term ()
         {
+            // Put back the initial setting for the auto-updater toggle
+            FbxExporters.EditorTools.ExportSettings.instance.autoUpdaterEnabled = isAutoUpdaterOn;
+
             if (string.IsNullOrEmpty(_testDirectory)) {
                 return;
             }
@@ -213,7 +216,6 @@ public virtual void Init()
             FbxExporters.EditorTools.ExportSettings.instance.autoUpdaterEnabled = true;
         }
 
-
         /// <summary>
         /// Exports the Objects in selected.
         /// </summary>

Assets/FbxExporters/Editor/UnitTests/ExporterTestBase.cs

@@ -834,7 +834,9 @@ public void AnimOnlyExportTest(string prefabPath)
 
             // export fbx
             // get GameObject
-            string filename = ExportToFbx(originalGO, true);
+            string filename = GetRandomFbxFilePath ();
+            var exportedFilePath = ModelExporter.ExportObject (filename, originalGO, ModelExporter.AnimationExportType.componentAnimation);
+            Assert.That (exportedFilePath, Is.EqualTo (filename));
 
             GameObject fbxObj = AssetDatabase.LoadMainAssetAtPath (filename) as GameObject;
             Assert.IsTrue (fbxObj);

Assets/FbxExporters/Editor/UnitTests/FbxAnimationTest.cs

@@ -159,13 +159,11 @@ public void TestNameMapping()
             // In FbxPrefab Component of Cube, add SphereFBX/Sphere name mapping
             FbxPrefab fbxPrefabScript = cubePrefabInstance.transform.GetComponent<FbxPrefab>();
 
-
             FbxPrefab.StringPair stringpair = new FbxPrefab.StringPair();
             stringpair.FBXObjectName = "SphereFBX";
             stringpair.UnityObjectName = "Sphere";
             fbxPrefabScript.NameMapping.Add(stringpair);
 
-
             FbxPrefabAutoUpdater.FbxPrefabUtility fbxPrefabUtility = new FbxPrefabAutoUpdater.FbxPrefabUtility(fbxPrefabScript);
 
             Assert.IsTrue(fbxPrefabUtility.GetUnityObjectName("SphereFBX") == stringpair.UnityObjectName);
@@ -329,7 +327,7 @@ public void RemappingTest()
 
 
         [TearDown]
-        public void stopTest()
+        public void StopTest()
         {
             // Put back the initial setting for the auto-updater toggle
             FbxExporters.EditorTools.ExportSettings.instance.autoUpdaterEnabled = isAutoUpdaterOn;