using System; using System.Collections.Generic; using System.Linq; using Unity.XR.CoreUtils.Editor; using UnityEditor.PackageManager; using UnityEditor.PackageManager.Requests; using UnityEditor.PackageManager.UI; using UnityEditor.XR.Interaction.Toolkit.ProjectValidation; using UnityEngine; #if TEXT_MESH_PRO_PRESENT || (UGUI_2_0_PRESENT && UNITY_6000_0_OR_NEWER) using System.IO; using TMPro; #endif namespace UnityEditor.XR.Interaction.Toolkit.Samples.Hands.Editor { /// /// Unity Editor class which registers Project Validation rules for the Hands Interaction Demo sample, /// checking that other required samples and packages are installed. /// static class HandsSampleProjectValidation { const string k_SampleDisplayName = "Hands Interaction Demo"; const string k_Category = "XR Interaction Toolkit"; const string k_StarterAssetsSampleName = "Starter Assets"; const string k_HandVisualizerSampleName = "HandVisualizer"; const string k_ProjectValidationSettingsPath = "Project/XR Plug-in Management/Project Validation"; const string k_HandsPackageDisplayName = "XR Hands"; const string k_HandsPackageName = "com.unity.xr.hands"; const string k_XRIPackageName = "com.unity.xr.interaction.toolkit"; const string k_ShaderGraphPackageName = "com.unity.shadergraph"; static readonly PackageVersion s_MinimumHandsPackageVersion = new PackageVersion("1.5.1"); static readonly PackageVersion s_RecommendedHandsPackageVersion = new PackageVersion("1.6.1"); #if UNITY_6000_0_OR_NEWER // The s_MinimumUIPackageVersion should match the UGUI_2_0_PRESENT version in the // Unity.XR.Interaction.Toolkit.Samples.StarterAssets.Editor.asmdef // and the Unity.XR.Interaction.Toolkit.Samples.StarterAssets.asmdef static readonly PackageVersion s_MinimumUIPackageVersion = new PackageVersion("2.0.0"); const string k_UIPackageName = "com.unity.ugui"; const string k_UIPackageDisplayName = "Unity UI"; #else // The s_MinimumUIPackageVersion should match the TEXT_MESH_PRO_PRESENT version in the // Unity.XR.Interaction.Toolkit.Samples.StarterAssets.Editor.asmdef // and the Unity.XR.Interaction.Toolkit.Samples.StarterAssets.asmdef static readonly PackageVersion s_MinimumUIPackageVersion = new PackageVersion("3.0.8"); const string k_UIPackageName = "com.unity.textmeshpro"; const string k_UIPackageDisplayName = "TextMeshPro"; #endif static AddRequest s_UIPackageAddRequest; static readonly BuildTargetGroup[] s_BuildTargetGroups = ((BuildTargetGroup[])Enum.GetValues(typeof(BuildTargetGroup))).Distinct().ToArray(); static readonly List s_BuildValidationRules = new List { new BuildValidationRule { IsRuleEnabled = () => s_HandsPackageAddRequest == null || s_HandsPackageAddRequest.IsCompleted, Message = $"[{k_SampleDisplayName}] XR Hands ({k_HandsPackageName}) package must be installed or updated to use this sample.", Category = k_Category, CheckPredicate = () => PackageVersionUtility.GetPackageVersion(k_HandsPackageName) >= s_MinimumHandsPackageVersion, FixIt = () => { if (s_HandsPackageAddRequest == null || s_HandsPackageAddRequest.IsCompleted) ProjectValidationUtility.InstallOrUpdatePackage(k_HandsPackageName, s_RecommendedHandsPackageVersion, ref s_HandsPackageAddRequest); }, FixItAutomatic = true, Error = true, }, new BuildValidationRule { IsRuleEnabled = () => s_HandsPackageAddRequest == null || s_HandsPackageAddRequest.IsCompleted, Message = $"[{k_SampleDisplayName}] XR Hands ({k_HandsPackageName}) package must be at version {s_RecommendedHandsPackageVersion} or higher to use the latest sample features.", Category = k_Category, CheckPredicate = () => PackageVersionUtility.GetPackageVersion(k_HandsPackageName) >= s_RecommendedHandsPackageVersion, FixIt = () => { if (s_HandsPackageAddRequest == null || s_HandsPackageAddRequest.IsCompleted) ProjectValidationUtility.InstallOrUpdatePackage(k_HandsPackageName, s_RecommendedHandsPackageVersion, ref s_HandsPackageAddRequest); }, FixItAutomatic = true, Error = false, }, new BuildValidationRule { IsRuleEnabled = () => PackageVersionUtility.GetPackageVersion(k_HandsPackageName) >= s_MinimumHandsPackageVersion, Message = $"[{k_SampleDisplayName}] {k_HandVisualizerSampleName} sample from XR Hands ({k_HandsPackageName}) package must be imported or updated to use this sample.", Category = k_Category, CheckPredicate = () => ProjectValidationUtility.SampleImportMeetsMinimumVersion(k_HandsPackageDisplayName, k_HandVisualizerSampleName, PackageVersionUtility.GetPackageVersion(k_HandsPackageName)), FixIt = () => { if (TryFindSample(k_HandsPackageName, string.Empty, k_HandVisualizerSampleName, out var sample)) { sample.Import(Sample.ImportOptions.OverridePreviousImports); } }, FixItAutomatic = true, Error = !ProjectValidationUtility.SampleImportMeetsMinimumVersion(k_HandsPackageDisplayName, k_HandVisualizerSampleName, s_MinimumHandsPackageVersion), }, new BuildValidationRule { Message = $"[{k_SampleDisplayName}] {k_StarterAssetsSampleName} sample from XR Interaction Toolkit ({k_XRIPackageName}) package must be imported or updated to use this sample. {GetImportSampleVersionMessage(k_Category, k_StarterAssetsSampleName, ProjectValidationUtility.minimumXRIStarterAssetsSampleVersion)}", Category = k_Category, CheckPredicate = () => ProjectValidationUtility.SampleImportMeetsMinimumVersion(k_Category, k_StarterAssetsSampleName, ProjectValidationUtility.minimumXRIStarterAssetsSampleVersion), FixIt = () => { if (TryFindSample(k_XRIPackageName, string.Empty, k_StarterAssetsSampleName, out var sample)) { sample.Import(Sample.ImportOptions.OverridePreviousImports); } }, FixItAutomatic = true, Error = !ProjectValidationUtility.HasSampleImported(k_Category, k_StarterAssetsSampleName), }, new BuildValidationRule { IsRuleEnabled = () => s_ShaderGraphPackageAddRequest == null || s_ShaderGraphPackageAddRequest.IsCompleted, Message = $"[{k_SampleDisplayName}] Shader Graph ({k_ShaderGraphPackageName}) package must be installed for materials used in this sample.", Category = k_Category, CheckPredicate = () => PackageVersionUtility.IsPackageInstalled(k_ShaderGraphPackageName), FixIt = () => { s_ShaderGraphPackageAddRequest = Client.Add(k_ShaderGraphPackageName); if (s_ShaderGraphPackageAddRequest.Error != null) { Debug.LogError($"Package installation error: {s_ShaderGraphPackageAddRequest.Error}: {s_ShaderGraphPackageAddRequest.Error.message}"); } }, FixItAutomatic = true, Error = false, }, new BuildValidationRule { IsRuleEnabled = () => s_UIPackageAddRequest == null || s_UIPackageAddRequest.IsCompleted, Message = $"[{k_StarterAssetsSampleName}] {k_UIPackageDisplayName} ({k_UIPackageName}) package must be installed and at minimum version {s_MinimumUIPackageVersion}.", Category = k_Category, CheckPredicate = () => PackageVersionUtility.GetPackageVersion(k_UIPackageName) >= s_MinimumUIPackageVersion, FixIt = () => { if (s_UIPackageAddRequest == null || s_UIPackageAddRequest.IsCompleted) ProjectValidationUtility.InstallOrUpdatePackage(k_UIPackageName, s_MinimumUIPackageVersion, ref s_UIPackageAddRequest); }, FixItAutomatic = true, Error = true, }, #if TEXT_MESH_PRO_PRESENT || (UGUI_2_0_PRESENT && UNITY_6000_0_OR_NEWER) new BuildValidationRule { IsRuleEnabled = () => PackageVersionUtility.IsPackageInstalled(k_UIPackageName), Message = $"[{k_SampleDisplayName}] TextMesh Pro - TMP Essentials must be installed for this sample.", HelpText = "Can be installed using Window > TextMeshPro > Import TMP Essential Resources or by clicking this Edit button and then Import TMP Essentials in the window that appears.", Category = k_Category, CheckPredicate = () => PackageVersionUtility.IsPackageInstalled(k_UIPackageName) && TextMeshProEssentialsInstalled(), FixIt = () => { TMP_PackageResourceImporterWindow.ShowPackageImporterWindow(); }, FixItAutomatic = false, Error = true, }, #endif }; static AddRequest s_HandsPackageAddRequest; static AddRequest s_ShaderGraphPackageAddRequest; [InitializeOnLoadMethod] static void RegisterProjectValidationRules() { foreach (var buildTargetGroup in s_BuildTargetGroups) { BuildValidator.AddRules(buildTargetGroup, s_BuildValidationRules); } // Delay evaluating conditions for issues to give time for Package Manager and UPM cache to fully initialize. EditorApplication.delayCall += ShowWindowIfIssuesExist; } static void ShowWindowIfIssuesExist() { foreach (var validation in s_BuildValidationRules) { if (validation.CheckPredicate == null || (!validation.CheckPredicate.Invoke() && validation.Error)) { ShowWindow(); return; } } } internal static void ShowWindow() { // Delay opening the window since sometimes other settings in the player settings provider redirect to the // project validation window causing serialized objects to be nullified. EditorApplication.delayCall += () => { SettingsService.OpenProjectSettings(k_ProjectValidationSettingsPath); }; } static bool TryFindSample(string packageName, string packageVersion, string sampleDisplayName, out Sample sample) { sample = default; if (!PackageVersionUtility.IsPackageInstalled(packageName)) return false; IEnumerable packageSamples; try { packageSamples = Sample.FindByPackage(packageName, packageVersion); } catch (Exception e) { Debug.LogError($"Couldn't find samples of the {ToString(packageName, packageVersion)} package; aborting project validation rule. Exception: {e}"); return false; } if (packageSamples == null) { Debug.LogWarning($"Couldn't find samples of the {ToString(packageName, packageVersion)} package; aborting project validation rule."); return false; } foreach (var packageSample in packageSamples) { if (packageSample.displayName == sampleDisplayName) { sample = packageSample; return true; } } Debug.LogWarning($"Couldn't find {sampleDisplayName} sample in the {ToString(packageName, packageVersion)} package; aborting project validation rule."); return false; } static string ToString(string packageName, string packageVersion) { return string.IsNullOrEmpty(packageVersion) ? packageName : $"{packageName}@{packageVersion}"; } #if TEXT_MESH_PRO_PRESENT || (UGUI_2_0_PRESENT && UNITY_6000_0_OR_NEWER) static bool TextMeshProEssentialsInstalled() { // Matches logic in Project Settings window, see TMP_PackageResourceImporter.cs. // For simplicity, we don't also copy the check if the asset needs to be updated. return File.Exists("Assets/TextMesh Pro/Resources/TMP Settings.asset"); } #endif static string GetImportSampleVersionMessage(string packageFolderName, string sampleDisplayName, PackageVersion version) { if (ProjectValidationUtility.SampleImportMeetsMinimumVersion(packageFolderName, sampleDisplayName, version) || !ProjectValidationUtility.HasSampleImported(packageFolderName, sampleDisplayName)) return string.Empty; return $"An older version of {sampleDisplayName} has been found. This may cause errors."; } } }