Merge pull request #8804 from davidkline-ms/shaderImport

Fix immutable shader issue when switching to URP (#8783)

Author: David Kline

Assets/MRTK/StandardAssets/EditorUtilities.meta

@@ -0,0 +1,14 @@
+{
+    "name": "Microsoft.MixedReality.Toolkit.StandardAssets.Editor",
+    "references": [],
+    "optionalUnityReferences": [],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": []
+}

Assets/MRTK/StandardAssets/EditorUtilities/MRTK.StandardAssets.Editor.asmdef

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using System.IO;
+using UnityEditor;
+using UnityEngine;
+
+namespace Microsoft.MixedReality.Toolkit.Utilities.Editor
+{
+    [InitializeOnLoad]
+    static class OnLoadUtilities
+    {
+        private const string SessionStateKey = "StandardAssetsOnLoadUtilitiesSessionStateKey";
+
+        private const string ShaderSentinelGuid = "05852dd420bb9ec4cb7318bfa529d37c";
+        private const string ShaderSentinelFile = "MRTK.Shaders.Sentinel";
+
+        private const string ShaderImportDestination = "MRTK/Shaders";
+
+        static OnLoadUtilities()
+        {
+            // This InitializeOnLoad handler only runs once at editor launch in order to adjust for Unity version
+            // differences. These don't need to (and should not be) run on an ongoing basis. This uses the
+            // volatile SessionState which is clear when Unity launches to ensure that this only runs the
+            // expensive work (file system i/o) once.
+            if (!SessionState.GetBool(SessionStateKey, false))
+            {
+                SessionState.SetBool(SessionStateKey, true);
+                EnsureShaders();
+            }
+        }
+
+        /// <summary>
+        /// Ensures that MRTK shader files are present in a writable location. To support the 
+        /// Universal Render Pipeline, shader modifications must be persisted.
+        /// </summary>
+        private static void EnsureShaders()
+        {
+            if (!AssetsContainsShaders())
+            {
+                ImportShaderFiles();
+            }
+        }
+
+        /// <summary>
+        /// Checks to see if the Assets or Packages (if embedded) folder trees contains the MRTK shaders.
+        /// </summary>
+        /// <returns>True if the shader sentinel file is found, otherwise false.</returns>
+        private static bool AssetsContainsShaders()
+        {
+            return !string.IsNullOrWhiteSpace(AssetDatabase.GUIDToAssetPath(ShaderSentinelGuid));
+        }
+
+        /// <summary>
+        /// Finds the shader folder within an installed or embedded package.
+        /// </summary>
+        /// <returns>
+        /// DirectoryInfo object representing the shader folder in the package cache.
+        /// If not found, returns null.
+        /// </returns>
+        private static DirectoryInfo FindShaderFolderInPackage()
+        {
+            List<string> searchPaths = new List<string>
+            {
+                Path.GetFullPath(Path.Combine("Library", "PackageCache")),
+                Path.GetFullPath("Packages")
+            };
+
+            foreach (string path in searchPaths)
+            {
+                DirectoryInfo di = new DirectoryInfo(path);
+                if (!di.Exists) { continue; }
+
+                FileInfo[] files = di.GetFiles(ShaderSentinelFile, SearchOption.AllDirectories);
+                if (files.Length > 0)
+                {
+                    return new DirectoryInfo(files[0].DirectoryName);
+                }
+            }
+
+            return null;
+        }
+
+        /// <summary>
+        /// Copies the shader files from the package cache to the Assets folder tree.
+        /// </summary>
+        private static void ImportShaderFiles()
+        {
+            DirectoryInfo source = FindShaderFolderInPackage();
+            if (source == null)
+            {
+                Debug.LogError("Unable to locate the shader source folder in the package");
+                return;
+            }
+
+            DirectoryInfo destination = new DirectoryInfo(Path.Combine(Application.dataPath, ShaderImportDestination));
+            if (!destination.Exists)
+            {
+                destination.Create();
+            }
+
+            FileInfo[] sourceFiles = source.GetFiles();
+            foreach (FileInfo fi in sourceFiles)
+            {
+                fi.CopyTo(Path.Combine(destination.FullName, fi.Name));
+            }
+        }
+    }
+}

Assets/MRTK/StandardAssets/EditorUtilities/MRTK.StandardAssets.Editor.asmdef.meta

@@ -28,6 +28,10 @@ There are no breaking changes since version 2.5.0.
 
 ## Known issues
 
+### Some Mixed Reality Toolkit Standard Shader features require the Foundation package
+
+When imported via the Unity Package Manager, the MRTK Standard Shader utilities scripts (ex: HoverLight.cs) are not co-located with the shader in the Standard Assets package. To access this functionality, applications will require the Foundation package to be imported.
+
 ### CameraCache may create a new camera on shutdown
 
 In some situations (e.g. when using the LeapMotion provider in the Unity Editor), it is possible for the CameraCache to re-create the MainCamera on shutdown. Please see [this issue](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/8459) for more information.

Assets/MRTK/StandardAssets/EditorUtilities/OnLoadUtilities.cs

@@ -369,7 +369,8 @@ $InitializeOnLoadExceptions = [System.Collections.Generic.HashSet[String]]@(
     "Assets/MRTK/Providers/Oculus/XRSDK/Editor/OculusXRSDKConfigurationChecker.cs",
     "Assets/MRTK/Providers/WindowsMixedReality/Shared/Editor/WindowsMixedRealityConfigurationChecker.cs",
     "Assets/MRTK/Providers/WindowsMixedReality/XRSDK/Editor/WindowsMixedRealityXRSDKConfigurationChecker.cs",
-    "Assets/MRTK/Providers/XRSDK/Editor/XRSDKConfigurationChecker.cs"
+    "Assets/MRTK/Providers/XRSDK/Editor/XRSDKConfigurationChecker.cs",
+    "Assets/MRTK/StandardAssets/EditorUtilities/OnLoadUtilities.cs"
 )
 
 <#
@@ -622,6 +623,7 @@ $AsmDefExceptions = [System.Collections.Generic.HashSet[String]]@(
     "Assets/MRTK/Services/SceneSystem/MRTK.SceneSystem.asmdef",
     "Assets/MRTK/Services/SpatialAwarenessSystem/MRTK.SpatialAwarenessSystem.asmdef",
     "Assets/MRTK/Services/TeleportSystem/MRTK.TeleportSystem.asmdef",
+    "Assets/MRTK/StandardAssets/EditorUtilities/MRTK.StandardAssets.Editor.asmdef",
     "Assets/MRTK/Tests/EditModeTests/MRTK.EditModeTests.asmdef",
     "Assets/MRTK/Tests/PlayModeTests/MRTK.PlayModeTests.asmdef",
     "Assets/MRTK/Tests/TestUtilities/MRTK.Tests.Utilities.asmdef",

Assets/MRTK/StandardAssets/EditorUtilities/OnLoadUtilities.cs.meta

@@ -130,6 +130,13 @@ foreach ($entry in $packages.GetEnumerator()) {
         # helper script to prepare the folder.
         Start-Process -FilePath "$PSHOME/powershell.exe" -ArgumentList "$scriptPath/foundationpreupm.ps1 -PackageRoot $packagePath" -NoNewWindow -Wait
     }
+    elseif ($packageName -eq "standardassets") {
+        # The standard assets package contains shaders that need to be imported into the Assets folder so that they
+        # can be modified if the render pipeline is changed. To avoid duplicate resources (in library and assets)
+        # we rename the Shaders folder to Shaders~, which makes it hidden to the Unity Editor.
+        Rename-Item -Path "$packagePath/Shaders" -NewName "$packagePath/Shaders~"
+        Remove-Item -Path "$packagePath/Shaders.meta"
+    }
     elseif ($packageName -eq "examples") {
         # The examples folder is a collection of sample projects. In order to perform the necessary
         # preparaton, without overly complicating this script, we will use a helper script to prepare
@@ -179,6 +186,11 @@ foreach ($entry in $packages.GetEnumerator()) {
         # The foundation package MOVES some content around. This restores the moved files.
         Start-Process -FilePath "git" -ArgumentList "checkout Services/SceneSystem/SceneSystemResources*" -NoNewWindow -Wait
     }
+    elseif ($packageName -eq "standardassets") {
+        # The standard assets package RENAMES and DELETES some content. This restores the original files.
+        Rename-Item -Path "$packagePath/Shaders~" -NewName "$packagePath/Shaders"
+        Start-Process -FilePath "git" -ArgumentList "checkout Shaders.meta" -NoNewWindow -Wait
+    }
 
     # Delete the files copied in previously
     Remove-Item -Path "$packagePath/LICENSE.md*"