Merge pull request #7215 from CDiaz-MS/issue_7184

Fix MixedRealityToolkit.Generated folder creation location

Author: David Kline

Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityProfileCloneWindow.cs

@@ -3,6 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.Utilities.Editor;
 using System.Collections.Generic;
+using System.IO;
 using System.Reflection;
 using UnityEditor;
 using UnityEngine;
@@ -24,7 +25,7 @@ private struct SubProfileAction
             public SubProfileAction(
                 ProfileCloneBehavior behavior,
                 SerializedProperty property,
-                Object substitutionReference, 
+                Object substitutionReference,
                 System.Type profileType)
             {
                 Behavior = behavior;
@@ -46,7 +47,7 @@ public SubProfileAction(
 
         private const string AdvancedModeKey = "MRTK_ProfileCloneWindow_AdvancedMode_Key";
         private static bool AdvancedMode = false;
-        private const string DefaultCustomProfileFolder = "Assets/MixedRealityToolkit.Generated/CustomProfiles";
+        protected static string DefaultCustomProfileFolder => Path.Combine(MixedRealityToolkitFiles.MapModulePath(MixedRealityToolkitModuleType.Generated), "CustomProfiles");
         private const string IsCustomProfileProperty = "isCustomProfile";
         private static readonly Vector2 MinWindowSizeBasic = new Vector2(500, 180);
         private const float SubProfileSizeMultiplier = 95f;
@@ -241,7 +242,7 @@ private void OnGUI()
                 {
                     cloneWindow.Close();
                 }
-            }   
+            }
 
             // If there are no sub profiles, limit the max so the window isn't spawned too large
             if (subProfileActions.Count <= 0 || !AdvancedMode)
@@ -400,14 +401,15 @@ private static Object EnsureTargetFolder(Object targetFolder)
                 return targetFolder;
             }
 
-            if (!AssetDatabase.IsValidFolder(DefaultCustomProfileFolder))
+            string customProfilesFolderPath = DefaultCustomProfileFolder;
+            if (!AssetDatabase.IsValidFolder(customProfilesFolderPath))
             {
                 // AssetDatabase.CreateFolder must be called to create each child of the asset folder
                 // path individually. 
-                // Calling AssetDatabase.CreateFolder("Assets", "MixedRealityToolkit.Generated/CustomProfiles")
-                // generates a folder that looks like "Assets/MixedRealityToolkit.Generated_CustomProfiles".
-                AssetDatabase.CreateFolder("Assets", "MixedRealityToolkit.Generated");
-                AssetDatabase.CreateFolder("Assets/MixedRealityToolkit.Generated", "CustomProfiles");
+
+                // If the packages have been imported via NugetForUnity, MixedRealityToolkitFiles.GetGeneratedFolder
+                // will also create the MixedRealityToolkit.Generated Folder and return the path to the folder.
+                AssetDatabase.CreateFolder(MixedRealityToolkitFiles.GetGeneratedFolder, "CustomProfiles");
             }
             return AssetDatabase.LoadAssetAtPath(DefaultCustomProfileFolder, typeof(Object));
         }

Assets/MixedRealityToolkit/Utilities/Editor/Setup/MixedRealityToolkitFiles.cs

@@ -101,7 +101,7 @@ public static void OnPostprocessAllAssets(string[] importedAssets, string[] dele
         private static Task searchForFoldersTask = null;
         private static CancellationTokenSource searchForFoldersToken;
 
-        private static string NormalizeSeparators(string path) => 
+        private static string NormalizeSeparators(string path) =>
             path?.Replace('\\', Path.DirectorySeparatorChar).Replace('/', Path.DirectorySeparatorChar);
 
         private static string FormatSeparatorsForUnity(string path) => path?.Replace('\\', '/');
@@ -350,6 +350,19 @@ public static MixedRealityToolkitModuleType GetModuleFromPackageFolder(string pa
             return moduleNameMap.TryGetValue(packageFolder, out moduleType) ? moduleType : MixedRealityToolkitModuleType.None;
         }
 
+        /// <summary>
+        /// Creates the MixedRealityToolkit.Generated folder if it does not exist and returns the 
+        /// path to the generated folder.
+        /// </summary>
+        public static string GetGeneratedFolder
+        {
+            get
+            {
+                TryToCreateGeneratedFolder();
+                return MapModulePath(MixedRealityToolkitModuleType.Generated);
+            }
+        }
+
         private static async Task SearchForFoldersAsync(string rootPath)
         {
             if (searchForFoldersToken != null)
@@ -376,6 +389,9 @@ private static void SearchForFolders(string rootPath, CancellationToken ct)
                         ct.ThrowIfCancellationRequested();
                     }
                 }
+
+                // Create the Generated folder, if the user tries to delete the Generated folder it will be created again
+                TryToCreateGeneratedFolder();
             }
             catch (OperationCanceledException)
             {
@@ -408,20 +424,15 @@ private static void RegisterFolderToModule(string folderPath, MixedRealityToolki
             }
 
             modFolders.Add(normalizedFolder);
-
-            if (module == MixedRealityToolkitModuleType.Core)
-            {
-                TryToCreateGeneratedFolder(folderPath);
-            }
         }
 
-        private static void TryToCreateGeneratedFolder(string folderPath)
+        private static void TryToCreateGeneratedFolder()
         {
+            // Always add the the MixedRealityToolkit.Generated folder to Assets
             var generatedDirs = GetDirectories(MixedRealityToolkitModuleType.Generated);
             if (generatedDirs == null || !generatedDirs.Any())
             {
-                string parentFolderPath = Directory.GetParent(folderPath).FullName;
-                string generatedFolderPath = Path.Combine(parentFolderPath, "MixedRealityToolkit.Generated");
+                string generatedFolderPath = Path.Combine("Assets", "MixedRealityToolkit.Generated");
                 if (!Directory.Exists(generatedFolderPath))
                 {
                     Directory.CreateDirectory(generatedFolderPath);