Merge remote-tracking branch 'refs/remotes/origin/master' into UNI-21369-convert-model-hierarchy-fix

vkovec · vkovec · commit 01bcd4c3a086 · 2017-07-13T13:34:17.000-04:00
# Conflicts:
#	Assets/FbxExporters/Editor/ConvertToModel.cs
diff --git a/Assets/FbxExporters/Editor/ConvertToModel.cs b/Assets/FbxExporters/Editor/ConvertToModel.cs
@@ -78,7 +78,12 @@ private static List<GameObject> OnConvertInPlace (GameObject [] unityActiveGOs)
                 string dirPath = Path.Combine (Application.dataPath, "Objects");
 
                 for(int n = 0; n < gosToExport.Length; n++){
-                    filePaths[n] = Path.Combine (dirPath, gosToExport[n].name + ".fbx");
+                    var filename = ModelExporter.ConvertToValidFilename (gosToExport [n].name + ".fbx");
+                    var filePath = Path.Combine (dirPath, filename);
+                    if (File.Exists (filePath)) {
+                        filePath = IncrementFileName (dirPath, filename);
+                    }
+                    filePaths[n] = filePath;
                 }
 
                 string[] fbxFileNames = new string[filePaths.Length];
@@ -93,7 +98,7 @@ private static List<GameObject> OnConvertInPlace (GameObject [] unityActiveGOs)
                 {
                     var fbxFileName = fbxFileNames [i];
                     if (fbxFileName == null) {
-                        Debug.Log (string.Format ("Warning: Export failed for GameObject {0}", gosToExport [i].name));
+                        Debug.LogWarning (string.Format ("Warning: Export failed for GameObject {0}", gosToExport [i].name));
                         continue;
                     }
 
@@ -110,7 +115,7 @@ private static List<GameObject> OnConvertInPlace (GameObject [] unityActiveGOs)
                     Object unityMainAsset = AssetDatabase.LoadMainAssetAtPath (fbxFileName);
 
                     if (unityMainAsset != null) {
-                        Object unityObj = PrefabUtility.InstantiateAttachedAsset (unityMainAsset);
+                        Object unityObj = PrefabUtility.InstantiatePrefab (unityMainAsset);
                         GameObject unityGO = unityObj as GameObject;
                         if (unityGO != null) 
                         {
@@ -138,6 +143,28 @@ private static List<GameObject> OnConvertInPlace (GameObject [] unityActiveGOs)
                 return result;
             }
 
+            /// <summary>
+            /// Check if the file exists, and if it does, then increment the name.
+            /// e.g. if filename is Sphere.fbx and it already exists, change it to Sphere 1.fbx.
+            /// </summary>
+            /// <returns>new file name.</returns>
+            /// <param name="filename">Filename.</param>
+            private static string IncrementFileName(string path, string filename)
+            {
+                string fileWithoutExt = Path.GetFileNameWithoutExtension (filename);
+                string ext = Path.GetExtension (filename);
+
+                int index = 1;
+                string file = null;
+                do {
+                    file = string.Format ("{0} {1}{2}", fileWithoutExt, index, ext);
+                    file = Path.Combine(path, file);
+                    index++;
+                } while (File.Exists (file));
+
+                return file;
+            } 
+
             /// <summary>
             /// Enforces that all object names be unique before exporting.
             /// If an object with a duplicate name is found, then it is incremented.
diff --git a/Assets/FbxExporters/Editor/FbxExportSettings.cs b/Assets/FbxExporters/Editor/FbxExportSettings.cs
@@ -11,8 +11,21 @@ public class ExportSettingsEditor : UnityEditor.Editor {
         public override void OnInspectorGUI() {
             ExportSettings exportSettings = (ExportSettings)target;
 
+            // Increasing the label width so that none of the text gets cut off
+            EditorGUIUtility.labelWidth = 300;
+
             exportSettings.weldVertices = EditorGUILayout.Toggle ("Weld Vertices:", exportSettings.weldVertices);
             exportSettings.embedTextures = EditorGUILayout.Toggle ("Embed Textures:", exportSettings.embedTextures);
+            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 " +
+                    "(e.g. \"foo bar\" becomes \"fooFBXASC032bar\"). " +
+                    "On export, convert the names of GameObjects so they are Maya compatible." +
+                    (exportSettings.mayaCompatibleNames? "" : 
+                        "\n\nWARNING: Disabling this feature may result in lost material connections," +
+                        " and unexpected character replacements in Maya.")
+                ),
+                exportSettings.mayaCompatibleNames);
 
             if (GUI.changed) {
                 EditorUtility.SetDirty (exportSettings);
@@ -26,6 +39,7 @@ public class ExportSettings : FbxExporters.EditorTools.ScriptableSingleton<Expor
     {
         public bool weldVertices = true;
         public bool embedTextures = false;
+        public bool mayaCompatibleNames = true;
 
         [MenuItem("Edit/Project Settings/Fbx Export", priority = 300)]
         static void ShowManager()
diff --git a/Assets/FbxExporters/Editor/FbxExporter.cs b/Assets/FbxExporters/Editor/FbxExporter.cs
@@ -36,6 +36,16 @@ public class ModelExporter : System.IDisposable
 
             const string ProgressBarTitle = "Fbx Export";
 
+            const char MayaNamespaceSeparator = ':';
+
+            // replace invalid chars with this one
+            const char InvalidCharReplacement = '_';
+
+            const string RegexCharStart = "[";
+            const string RegexCharEnd = "]";
+
+            const int UnitScaleFactor = 100;
+
             /// <summary>
             /// Create instance of example
             /// </summary>
@@ -239,13 +249,13 @@ public void ExportTexture (Material unityMaterial, string unityPropName,
             /// <summary>
             /// Get the color of a material, or grey if we can't find it.
             /// </summary>
-            public FbxDouble3 GetMaterialColor (Material unityMaterial, string unityPropName)
+            public FbxDouble3 GetMaterialColor (Material unityMaterial, string unityPropName, float defaultValue = 1)
             {
                 if (!unityMaterial) {
-                    return new FbxDouble3 (0.5);
+                    return new FbxDouble3(defaultValue);
                 }
                 if (!unityMaterial.HasProperty (unityPropName)) {
-                    return new FbxDouble3 (0.5);
+                    return new FbxDouble3(defaultValue);
                 }
                 var unityColor = unityMaterial.GetColor (unityPropName);
                 return new FbxDouble3 (unityColor.r, unityColor.g, unityColor.b);
@@ -351,12 +361,14 @@ public void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode, FbxScene fbxScene, b
                     }
                     fbxMesh.InitControlPoints (NumControlPoints);
 
-                    // copy control point data from Unity to FBX
+                    // Copy control point data from Unity to FBX.
+                    // As we do so, scale the points by 100 to convert
+                    // from m to cm.
                     foreach (var controlPoint in ControlPointToIndex.Keys) {
                         fbxMesh.SetControlPointAt (new FbxVector4 (
-                            -controlPoint.x,
-                            controlPoint.y,
-                            controlPoint.z
+                            -controlPoint.x*UnitScaleFactor,
+                            controlPoint.y*UnitScaleFactor,
+                            controlPoint.z*UnitScaleFactor
                         ), ControlPointToIndex [controlPoint]);
                     }
                 } else {
@@ -368,9 +380,9 @@ public void ExportMesh (MeshInfo meshInfo, FbxNode fbxNode, FbxScene fbxScene, b
                     {
                         // convert from left to right-handed by negating x (Unity negates x again on import)
                         fbxMesh.SetControlPointAt(new FbxVector4 (
-                            -meshInfo.Vertices [v].x,
-                            meshInfo.Vertices [v].y,
-                            meshInfo.Vertices [v].z
+                            -meshInfo.Vertices [v].x*UnitScaleFactor,
+                            meshInfo.Vertices [v].y*UnitScaleFactor,
+                            meshInfo.Vertices [v].z*UnitScaleFactor
                         ), v);
                     }
                 }
@@ -447,8 +459,13 @@ protected void ExportTransform (UnityEngine.Transform unityTransform, FbxNode fb
 
                 // transfer transform data from Unity to Fbx
                 // Negating the x value of the translation, and the y and z values of the rotation
-                // to convert from Unity to Maya coordinates (left to righthanded)
-                var fbxTranslate = new FbxDouble3 (-unityTranslate.x, unityTranslate.y, unityTranslate.z);
+                // to convert from Unity to Maya coordinates (left to righthanded).
+                // Scaling the translation by 100 to convert from m to cm.
+                var fbxTranslate = new FbxDouble3 (
+                    -unityTranslate.x*UnitScaleFactor,
+                    unityTranslate.y*UnitScaleFactor,
+                    unityTranslate.z*UnitScaleFactor
+                );
                 var fbxRotate = new FbxDouble3 (unityRotate.x, -unityRotate.y, -unityRotate.z);
                 var fbxScale = new FbxDouble3 (unityScale.x, unityScale.y, unityScale.z);
 
@@ -469,6 +486,10 @@ protected int ExportComponents (
             {
                 int numObjectsExported = exportProgress;
 
+                if (FbxExporters.EditorTools.ExportSettings.instance.mayaCompatibleNames) {
+                    unityGo.name = ConvertToMayaCompatibleName (unityGo.name);
+                }
+
                 // create an FbxNode and add it as a child of parent
                 FbxNode fbxNode = FbxNode.Create (fbxScene, unityGo.name);
                 NumNodes++;
@@ -609,9 +630,11 @@ public int ExportAll (IEnumerable<UnityEngine.Object> unityExportSet)
                         fbxSceneInfo.mComment = Comments;
                         fbxScene.SetSceneInfo (fbxSceneInfo);
 
-                        // Set up the axes (Y up, Z forward, X to the right) and units (meters)
+                        // Set up the axes (Y up, Z forward, X to the right) and units (centimeters)
+                        // Exporting in centimeters as this is the default unit for FBX files, and easiest
+                        // to work with when importing into Maya or Max
                         var fbxSettings = fbxScene.GetGlobalSettings ();
-                        fbxSettings.SetSystemUnit (FbxSystemUnit.m);
+                        fbxSettings.SetSystemUnit (FbxSystemUnit.cm);
 
                         // The Unity axis system has Y up, Z forward, X to the right (left handed system with odd parity).
                         // The Maya axis system has Y up, Z forward, X to the left (right handed system with odd parity).
@@ -725,7 +748,10 @@ public static bool OnValidateMenuItem ()
             }
 
             // Add a menu item called "Export Model..." to a GameObject's context menu.
-            [MenuItem ("GameObject/Export Model... %e", false, 30)]
+            // NOTE: The ellipsis at the end of the Menu Item name prevents the context
+            //       from being passed to command, thus resulting in OnContextItem()
+            //       being called only once regardless of what is selected.
+            [MenuItem ("GameObject/Export Model...", false, 30)]
             static void OnContextItem (MenuCommand command)
             {
                 OnExport ();
@@ -838,6 +864,11 @@ public Material Material {
                         if (!renderer) {
                             return null;
                         }
+
+                        if (FbxExporters.EditorTools.ExportSettings.instance.mayaCompatibleNames) {
+                            renderer.sharedMaterial.name = ConvertToMayaCompatibleName (renderer.sharedMaterial.name);
+                        }
+
                         // .material instantiates a new material, which is bad
                         // most of the time.
                         return renderer.sharedMaterial;
@@ -956,13 +987,19 @@ private static void OnExport ()
                 					  ? Application.dataPath
                 					  : System.IO.Path.GetDirectoryName (LastFilePath);
 
-                var filename = string.IsNullOrEmpty (LastFilePath)
-                					 ? MakeFileName (basename: FileBaseName, extension: Extension)
-                					 : System.IO.Path.GetFileName (LastFilePath);
+                GameObject [] selectedGOs = Selection.GetFiltered<GameObject> (SelectionMode.TopLevel);
+                string filename = null;
+                if (selectedGOs.Length == 1) {
+                    filename = ConvertToValidFilename (selectedGOs [0].name + ".fbx");
+                } else {
+                    filename = string.IsNullOrEmpty (LastFilePath)
+                        ? MakeFileName (basename: FileBaseName, extension: Extension)
+                        : System.IO.Path.GetFileName (LastFilePath);
+                }
 
                 var title = string.Format ("Export Model FBX ({0})", FileBaseName);
 
-                var filePath = EditorUtility.SaveFilePanel (title, directory, filename, "");
+                var filePath = EditorUtility.SaveFilePanel (title, directory, filename, "fbx");
 
                 if (string.IsNullOrEmpty (filePath)) {
                     return;
@@ -1011,6 +1048,56 @@ private static void EnsureDirectory (string path)
                     Directory.CreateDirectory (fileInfo.Directory.FullName);
                 }
             }
+
+            /// <summary>
+            /// Removes the diacritics (i.e. accents) from letters.
+            /// e.g. é becomes e
+            /// </summary>
+            /// <returns>Text with accents removed.</returns>
+            /// <param name="text">Text.</param>
+            private static string RemoveDiacritics(string text) 
+            {
+                var normalizedString = text.Normalize(System.Text.NormalizationForm.FormD);
+                var stringBuilder = new System.Text.StringBuilder();
+
+                foreach (var c in normalizedString)
+                {
+                    var unicodeCategory = System.Globalization.CharUnicodeInfo.GetUnicodeCategory(c);
+                    if (unicodeCategory != System.Globalization.UnicodeCategory.NonSpacingMark)
+                    {
+                        stringBuilder.Append(c);
+                    }
+                }
+
+                return stringBuilder.ToString().Normalize(System.Text.NormalizationForm.FormC);
+            }
+
+            private static string ConvertToMayaCompatibleName(string name)
+            {
+                string newName = RemoveDiacritics (name);
+
+                if (char.IsDigit (newName [0])) {
+                    newName = newName.Insert (0, InvalidCharReplacement.ToString());
+                }
+
+                for (int i = 0; i < newName.Length; i++) {
+                    if (!char.IsLetterOrDigit (newName, i)) {
+                        if (i < newName.Length-1 && newName [i] == MayaNamespaceSeparator) {
+                            continue;
+                        }
+                        newName = newName.Replace (newName [i], InvalidCharReplacement);
+                    }
+                }
+                return newName;
+            }
+
+            public static string ConvertToValidFilename(string filename)
+            {
+                return System.Text.RegularExpressions.Regex.Replace (filename, 
+                    RegexCharStart + new string(Path.GetInvalidFileNameChars()) + RegexCharEnd,
+                    InvalidCharReplacement.ToString()
+                );
+            }
         }
     }
 }
