Merge pull request #146 from Unity-Technologies/uni-25710-safe-to-delete

Uni 25710 and uni 25723: fbx export settings minor changes

Author: benoithudson

Assets/FbxExporters/Editor/ConvertToModel.cs

@@ -62,6 +62,23 @@ public static bool OnValidateMenuItem ()
                 return true;
             }
 
+            /// <summary>
+            /// After a convert-to-model, we normally delete the original object.
+            /// That can be overridden.
+            /// </summary>
+            public enum KeepOriginal {
+                Default, // Use the export settings.
+                Keep, // Don't delete, just rename it.
+                Delete, // Delete the original hierarchy.
+            }
+
+            /// <summary>
+            /// Gets the export settings.
+            /// </summary>
+            public static EditorTools.ExportSettings ExportSettings {
+                get { return EditorTools.ExportSettings.instance; }
+            }
+
             /// <summary>
             /// Create instantiated model prefabs from a selection of objects.
             ///
@@ -73,7 +90,10 @@ public static bool OnValidateMenuItem ()
             /// <param name="unityGameObjectsToConvert">Unity game objects to convert to Model Prefab instances</param>
             /// <param name="path">Path to save Model Prefab; use FbxExportSettings if null</param>
             /// <param name="keepOriginal">If set to <c>true</c> keep original gameobject hierarchy.</param>
-            public static GameObject[] CreateInstantiatedModelPrefab (GameObject [] unityGameObjectsToConvert, string directoryFullPath = null, bool keepOriginal = true)
+            public static GameObject[] CreateInstantiatedModelPrefab (
+                GameObject [] unityGameObjectsToConvert,
+                string directoryFullPath = null,
+                KeepOriginal keepOriginal = KeepOriginal.Default)
             {
                 if (directoryFullPath == null) {
                     directoryFullPath = FbxExporters.EditorTools.ExportSettings.GetAbsoluteSavePath();
@@ -119,7 +139,7 @@ public static GameObject Convert (
                 GameObject toConvert,
                 string directoryFullPath = null,
                 string fbxFullPath = null,
-                bool keepOriginal = true)
+                KeepOriginal keepOriginal = KeepOriginal.Default)
             {
                 if (string.IsNullOrEmpty(fbxFullPath)) {
                     // Generate a unique filename.
@@ -197,7 +217,20 @@ public static GameObject Convert (
                 unityGO = PrefabUtility.ConnectGameObjectToPrefab(unityGO, prefab);
 
                 // Remove (now redundant) gameobject
-                if (!keepOriginal) {
+                bool actuallyKeepOriginal;
+                switch(keepOriginal) {
+                case KeepOriginal.Delete:
+                    actuallyKeepOriginal = false;
+                    break;
+                case KeepOriginal.Keep:
+                    actuallyKeepOriginal = true;
+                    break;
+                case KeepOriginal.Default:
+                default:
+                    actuallyKeepOriginal = ExportSettings.keepOriginalAfterConvert;
+                    break;
+                }
+                if (!actuallyKeepOriginal) {
                     Object.DestroyImmediate (toConvert);
                 } else {
                     // rename and put under scene root in case we need to check values

Assets/FbxExporters/Editor/FbxExportSettings.cs

@@ -27,8 +27,6 @@ public override void OnInspectorGUI() {
                 EditorGUILayout.Space ();
             }
 
-            exportSettings.weldVertices = EditorGUILayout.Toggle ("Weld Vertices:", exportSettings.weldVertices);
-
             exportSettings.mayaCompatibleNames = EditorGUILayout.Toggle (
                 new GUIContent ("Convert to Maya Compatible Naming:",
                     "In Maya some symbols such as spaces and accents get replaced when importing an FBX " +
@@ -121,10 +119,16 @@ public class ExportSettings : ScriptableSingleton<ExportSettings>
         public const string kDefaultSavePath = ".";
 
         // Note: default values are set in LoadDefaults().
-        public bool weldVertices;
         public bool mayaCompatibleNames;
         public bool centerObjects;
 
+        /// <summary>
+        /// In Convert-to-model, by default we delete the original object.
+        /// This option lets you override that.
+        /// </summary>
+        [HideInInspector]
+        public bool keepOriginalAfterConvert;
+
         [SerializeField]
         public UnityEngine.Object turntableScene;
 
@@ -143,9 +147,9 @@ public class ExportSettings : ScriptableSingleton<ExportSettings>
 
         protected override void LoadDefaults()
         {
-            weldVertices = true;
             mayaCompatibleNames = true;
             centerObjects = true;
+            keepOriginalAfterConvert = false;
             convertToModelSavePath = kDefaultSavePath;
             turntableScene = null;
         }

Assets/FbxExporters/Editor/FbxExporter.cs

@@ -542,17 +542,16 @@ private void AssignLayerElementMaterial(FbxMesh fbxMesh, Mesh mesh, int material
             ///
             /// Use fbxNode.GetMesh() to access the exported mesh.
             /// </summary>
-            /// <param name="weldVertices">If set to <c>true</c>, combine identical vertices together into one Fbx vertex.</param>
-            public void ExportMesh (Mesh mesh, FbxNode fbxNode, bool weldVertices = true, Material[] materials = null)
+            public void ExportMesh (Mesh mesh, FbxNode fbxNode, Material[] materials = null)
             {
                 var meshInfo = new MeshInfo(mesh, materials);
-                ExportMesh(meshInfo, fbxNode, weldVertices);
+                ExportMesh(meshInfo, fbxNode);
             }
 
             /// <summary>
             /// Exports a unity mesh and attaches it to the node as an FbxMesh.
             /// </summary>
-            void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode, bool weldVertices)
+            void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode)
             {
                 if (!meshInfo.IsValid) {
                     return;
@@ -567,31 +566,20 @@ void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode, bool weldVertices)
 
                 // Create control points.
                 Dictionary<Vector3, int> ControlPointToIndex = new Dictionary<Vector3, int> ();
-
-                int NumControlPoints = 0;
-                if (weldVertices) {
-                    for (int v = 0; v < meshInfo.VertexCount; v++) {
-                        if (ControlPointToIndex.ContainsKey (meshInfo.Vertices [v])) {
+                {
+                    var vertices = meshInfo.Vertices;
+                    for (int v = 0, n = meshInfo.VertexCount; v < n; v++) {
+                        if (ControlPointToIndex.ContainsKey (vertices [v])) {
                             continue;
                         }
-                        ControlPointToIndex [meshInfo.Vertices [v]] = NumControlPoints;
-
-                        NumControlPoints++;
-                    }
-                    fbxMesh.InitControlPoints (NumControlPoints);
-
-                    foreach (var controlPoint in ControlPointToIndex.Keys) {
-                        fbxMesh.SetControlPointAt (ConvertPositionToRightHanded(controlPoint),
-                            ControlPointToIndex [controlPoint]);
+                        ControlPointToIndex [vertices [v]] = ControlPointToIndex.Count();
                     }
-                } else {
-                    NumControlPoints = meshInfo.VertexCount;
-                    fbxMesh.InitControlPoints (NumControlPoints);
+                    fbxMesh.InitControlPoints (ControlPointToIndex.Count());
 
-                    // copy control point data from Unity to FBX
-                    for (int v = 0; v < NumControlPoints; v++)
-                    {
-                        fbxMesh.SetControlPointAt(ConvertPositionToRightHanded(meshInfo.Vertices[v]), v);
+                    foreach (var kvp in ControlPointToIndex) {
+                        var controlPoint = kvp.Key;
+                        var index = kvp.Value;
+                        fbxMesh.SetControlPointAt (ConvertPositionToRightHanded(controlPoint), index);
                     }
                 }
 
@@ -636,9 +624,7 @@ void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode, bool weldVertices)
                             // properly export UVs, normals, binormals, etc.
                             unmergedPolygons [current] = polyVert;
 
-                            if (weldVertices) {
-                                polyVert = ControlPointToIndex [meshInfo.Vertices [polyVert]];
-                            }
+                            polyVert = ControlPointToIndex [meshInfo.Vertices [polyVert]];
                             fbxMesh.AddPolygon (polyVert);
 
                             current++;
@@ -746,8 +732,7 @@ protected bool ExportInstance (GameObject unityGo, FbxNode fbxNode, FbxScene fbx
 
                 if (!SharedMeshes.TryGetValue (unityPrefabParent.name, out fbxMesh))
                 {
-                    bool weldVertices = ExportSettings.weldVertices;
-                    ExportMesh (unityGo, fbxNode, weldVertices);
+                    ExportMesh (unityGo, fbxNode);
                     if (fbxNode.GetMesh() != null) {
                         SharedMeshes [unityPrefabParent.name] = fbxNode.GetMesh();
                     }
@@ -812,8 +797,7 @@ protected int ExportComponents (
 
                 // try exporting mesh as an instance, export regularly if we cannot
                 if (!ExportInstance (unityGo, fbxNode, fbxScene)) {
-                    bool weldVertices = ExportSettings.weldVertices;
-                    ExportMesh (unityGo, fbxNode, weldVertices);
+                    ExportMesh (unityGo, fbxNode);
                 }
 
                 if (Verbose)
@@ -1494,7 +1478,7 @@ public static void UnRegisterMeshCallback(GetMeshForObject callback)
             /// This goes through the callback system to find the right mesh and
             /// allow plugins to substitute their own meshes.
             /// </summary>
-            void ExportMesh (GameObject gameObject, FbxNode fbxNode, bool weldVertices)
+            void ExportMesh (GameObject gameObject, FbxNode fbxNode)
             {
                 // First allow the object-based callbacks to have a hack at it.
                 foreach(var callback in MeshForObjectCallbacks) {
@@ -1547,14 +1531,14 @@ void ExportMesh (GameObject gameObject, FbxNode fbxNode, bool weldVertices)
                 if (meshFilter) {
                     var renderer = gameObject.GetComponent<Renderer>();
                     var materials = renderer ? renderer.sharedMaterials : null;
-                    ExportMesh(new MeshInfo(meshFilter.sharedMesh, materials), fbxNode, weldVertices);
+                    ExportMesh(new MeshInfo(meshFilter.sharedMesh, materials), fbxNode);
                 } else {
                     var smr = defaultComponent as SkinnedMeshRenderer;
                     if (smr) {
                         var mesh = new Mesh();
                         smr.BakeMesh(mesh);
                         var materials = smr.sharedMaterials;
-                        ExportMesh(new MeshInfo(mesh, materials), fbxNode, weldVertices);
+                        ExportMesh(new MeshInfo(mesh, materials), fbxNode);
                         Object.DestroyImmediate(mesh);
                     }
                 }

Assets/FbxExporters/Editor/UnitTests/ConvertToModelTest.cs

@@ -138,9 +138,9 @@ public void BasicTest()
             // Create a cube.
             var cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
 
-            // Convert it to a prefab.
+            // Convert it to a prefab -- but keep the cube.
             var cubePrefabInstance = ConvertToModel.Convert(cube,
-                directoryFullPath: path, keepOriginal: true);
+                directoryFullPath: path, keepOriginal: ConvertToModel.KeepOriginal.Keep);
 
             // Make sure it's what we expect.
             Assert.That(cube); // we kept the original
@@ -173,9 +173,20 @@ public void BasicTest()
             Assert.AreEqual(Path.GetFullPath(path), Path.GetDirectoryName(assetFullPath));
 
             // Convert it again, make sure there's only one FbxPrefab (see UNI-25528).
+            // Also make sure we deleted.
             var cubePrefabInstance2 = ConvertToModel.Convert(cubePrefabInstance,
-                    directoryFullPath: path, keepOriginal: false);
+                directoryFullPath: path, keepOriginal: ConvertToModel.KeepOriginal.Delete);
+            Assert.IsFalse(cubePrefabInstance);
             Assert.That(cubePrefabInstance2.GetComponents<FbxPrefab>().Length, Is.EqualTo(1));
+
+            // Create another cube, make sure the export settings drive whether we keep the cube or not.
+            ConvertToModel.Convert(cube, directoryFullPath: path,
+                    keepOriginal: ConvertToModel.KeepOriginal.Default);
+            if (ConvertToModel.ExportSettings.keepOriginalAfterConvert) {
+                Assert.IsTrue(cube);
+            } else {
+                Assert.IsFalse(cube);
+            }
         }
     }
 }

Assets/FbxExporters/Editor/UnitTests/FbxPrefabTest.cs

@@ -4,6 +4,7 @@
 using NUnit.Framework;
 using System.Collections.Generic;
 using System.Linq;
+using FbxExporters.Editor;
 
 namespace FbxExporters.UnitTests
 {
@@ -152,7 +153,7 @@ public void Init() {
 
             // Convert it to FBX. The asset file will be deleted automatically
             // on termination.
-            var fbxAsset = FbxExporters.Editor.ModelExporter.ExportObject(
+            var fbxAsset = ModelExporter.ExportObject(
                     GetRandomFbxFilePath(), m_original);
             m_source = AssetDatabase.LoadMainAssetAtPath(fbxAsset) as GameObject;
             m_originalHistory = Rep(m_source);
@@ -210,7 +211,7 @@ GameObject ModifySourceFbx()
             // enough, so the asset database knows to reload it. I was getting
             // test failures otherwise.
             SleepForFileTimestamp();
-            FbxExporters.Editor.ModelExporter.ExportObjects (
+            ModelExporter.ExportObjects (
                     AssetDatabase.GetAssetPath(m_source),
                     new Object[] { newModel } );
             AssetDatabase.Refresh();
@@ -291,7 +292,7 @@ public void BasicTest() {
             // Switch to some other model, which looks like the original model
             // (but is a totally different file). This will cause an update
             // immediately.
-            var fbxAsset = FbxExporters.Editor.ModelExporter.ExportObject(
+            var fbxAsset = ModelExporter.ExportObject(
                     GetRandomFbxFilePath(), m_original);
             var newSource = AssetDatabase.LoadMainAssetAtPath(fbxAsset) as GameObject;
             Assert.IsTrue(newSource);
@@ -351,13 +352,13 @@ public void TestCubeAtRoot()
             var cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
             cube.name = "Cube";
             var cubeAssetPath = GetRandomFbxFilePath();
-            var autoPrefab = FbxExporters.Editor.ConvertToModel.Convert(cube,
+            var autoPrefab = ConvertToModel.Convert(cube,
                 fbxFullPath: cubeAssetPath);
             Assert.IsTrue(autoPrefab);
 
             // Make a maya locator.
             var locator = new GameObject("Cube");
-            var locatorAssetPath = FbxExporters.Editor.ModelExporter.ExportObject(
+            var locatorAssetPath = ModelExporter.ExportObject(
                 GetRandomFbxFilePath(), locator);
 
             // Check the prefab has all the default stuff it should have.
@@ -405,8 +406,9 @@ public void TestTransformAndReparenting()
             building3.transform.parent = building2.transform;
             building3.transform.localScale = new Vector3(.5f, .5f, .5f);
 
-            var original = FbxExporters.Editor.ConvertToModel.Convert (root,
-                               fbxFullPath: GetRandomFbxFilePath (), keepOriginal: true);
+            var original = ConvertToModel.Convert (root,
+                fbxFullPath: GetRandomFbxFilePath (),
+                keepOriginal: ConvertToModel.KeepOriginal.Keep);
 
             // Make sure it's OK.
             Assert.That (original.transform.GetChild (0).name, Is.EqualTo ("building2"));
@@ -417,7 +419,7 @@ public void TestTransformAndReparenting()
             // Modify the hierarchy, export to a new FBX, then copy the FBX under the prefab.
             root.SetActive(true);
             building2.name = "building2_renamed";
-            var newCopyPath = FbxExporters.Editor.ModelExporter.ExportObject(
+            var newCopyPath = ModelExporter.ExportObject(
                 GetRandomFbxFilePath(), root);
             SleepForFileTimestamp();
             System.IO.File.Copy(