Sg/template filtering

Author: Esmeralda Salamone

Packages/com.unity.shadergraph/Editor/Generation/SubTarget.cs

@@ -32,6 +32,8 @@ public virtual bool ValidateNodeCompatibility(AbstractMaterialNode node, out str
 
         // Call after SubTarget parent Target has been deserialized and Subtarget.target has been set to a non-null value.
         internal virtual void OnAfterParentTargetDeserialized() { }
+
+        virtual internal IEnumerable<(string key, string value)> SearchTerms => null;
     }
 
     [GenerationAPI] // TODO: Public

Packages/com.unity.shadergraph/Editor/Generation/Target.cs

@@ -54,5 +54,8 @@ public virtual bool DerivativeModificationCallback(
         public abstract bool WorksWithSRP(RenderPipelineAsset scriptableRenderPipeline);
 
         virtual public SubTarget activeSubTarget { get; set; }
+
+        // For synonyms, add multiple values for each key.
+        virtual internal IEnumerable<(string key, string value)> SearchTerms => null;        
     }
 }

Packages/com.unity.shadergraph/Editor/Importers/ShaderGraphImporter.cs

@@ -6,6 +6,7 @@
 using System.Linq;
 using System.Text;
 using UnityEditor.AssetImporters;
+using UnityEditor.Experimental.GraphView;
 using UnityEditor.Graphing;
 using UnityEditor.Graphing.Util;
 using UnityEditor.ShaderGraph.Internal;
@@ -76,6 +77,9 @@ Fallback Off
         [SerializeField]
         bool m_ExposeTemplateAsShader;
 
+        [SerializeField]
+        ShaderGraphIndexedData m_IndexedData;
+
         public bool UseAsTemplate
         {
             get => m_UseAsTemplate;
@@ -97,6 +101,8 @@ public ShaderGraphTemplate Template
             set => m_Template = value;
         }
 
+        public DataBag AdditionalSearchTerms => m_IndexedData?.AdditionalSeachTerms ?? default;
+
         public static Texture2D GetIcon() => EditorGUIUtility.IconContent(IconBasePath)?.image as Texture2D;
 
         [SuppressMessage("ReSharper", "UnusedMember.Local")]
@@ -371,6 +377,12 @@ public override void OnImportAsset(AssetImportContext ctx)
 
             ctx.AddObjectToAsset("SGInternal:Metadata", sgMetadata);
 
+            m_IndexedData = ScriptableObject.CreateInstance<ShaderGraphIndexedData>();
+            m_IndexedData.AdditionalSeachTerms = ShaderGraphTemplate.GatherSearchTerms(graph);
+            m_IndexedData.name = "Indexed Data";
+            m_IndexedData.hideFlags = HideFlags.HideInHierarchy;
+            ctx.AddObjectToAsset("Metadata", m_IndexedData);
+
             // declare dependencies
             foreach (var asset in assetCollection.assets)
             {

Packages/com.unity.shadergraph/Editor/Importers/ShaderGraphImporter.cs.meta

@@ -0,0 +1,19 @@
+using System;
+
+using UnityEngine;
+
+namespace UnityEditor.ShaderGraph
+{
+    [Serializable]
+    class ShaderGraphIndexedData : ScriptableObject
+    {
+        [SerializeField] internal Experimental.GraphView.DataBag additionalSearchTerms;
+
+
+        public Experimental.GraphView.DataBag AdditionalSeachTerms
+        {
+            get => additionalSearchTerms;
+            set => additionalSearchTerms = value;
+        }
+    }
+}

Packages/com.unity.shadergraph/Editor/Importers/ShaderGraphIndexedData.cs

@@ -6,13 +6,21 @@ namespace UnityEditor.ShaderGraph
 {
     static class ShaderGraphIndexerExtension
     {
-        [CustomObjectIndexer(typeof(Shader), version = 0)]
-        internal static void ShaderGraphImporterIndexer(CustomObjectIndexerTarget context, ObjectIndexer indexer)
+        static void ShaderGraphIndexer(CustomObjectIndexerTarget context, ObjectIndexer indexer)
         {
-            if (ShaderGraphTemplateHelper.TryGetTemplateStatic(context.id, out var template))
+            if (ShaderGraphTemplateHelper.TryGetTemplateStatic(context.id, out var template, out var dataBag))
             {
                 GraphViewIndexerExtension.IndexCommonData<ShaderGraphImporter>(context, indexer, template);
+                GraphViewIndexerExtension.IndexCustomData<ShaderGraphImporter>(context, indexer, dataBag.GetCustomData($"{template.ToolKey}."));
             }
         }
+
+        [CustomObjectIndexer(typeof(ShaderGraphImporter), version = 1)]
+        internal static void ShaderGraphImporterIndexer(CustomObjectIndexerTarget context, ObjectIndexer indexer)
+            => ShaderGraphIndexer(context, indexer);
+
+        [CustomObjectIndexer(typeof(Shader), version = 1)]
+        internal static void ShaderGraphShaderIndexer(CustomObjectIndexerTarget context, ObjectIndexer indexer)
+            => ShaderGraphIndexer(context, indexer);
     }
 }

Packages/com.unity.shadergraph/Editor/Importers/ShaderGraphIndexedData.cs.meta

@@ -1,4 +1,5 @@
 using System;
+using UnityEditor.ShaderGraph.Serialization;
 using UnityEngine;
 
 namespace UnityEditor.ShaderGraph
@@ -12,5 +13,40 @@ struct ShaderGraphTemplate
         public string description;
         public Texture2D icon;
         public Texture2D thumbnail;
+        public int order;
+
+        internal static Experimental.GraphView.DataBag GatherSearchTerms(GraphData graph)
+        {
+            // clear the existing terms, as this object's serialization persists across imports.
+            var additionalSearchTerms = default(Experimental.GraphView.DataBag);
+
+            if (graph is null || graph.objectIdIsEmpty)
+                return additionalSearchTerms;
+
+            foreach (var target in graph.activeTargets)
+            {
+                if (target is null or MultiJsonInternal.UnknownTargetType || target.objectIdIsEmpty || target.activeSubTarget is null || target.activeSubTarget.objectIdIsEmpty)
+                    continue;
+
+                additionalSearchTerms.AddCustomData("RenderPipeline", target.displayName);
+                additionalSearchTerms.AddCustomData("Material", target.activeSubTarget.displayName);
+                additionalSearchTerms.AddCustomData("VFX", target.SupportsVFX() ? "Supported" : "Not Supported");
+
+                if (target.SearchTerms != null)
+                    foreach (var term in target.SearchTerms)
+                        additionalSearchTerms.AddCustomData(term.key, term.value);
+
+                if (target.activeSubTarget.SearchTerms != null)
+                    foreach (var term in target.activeSubTarget.SearchTerms)
+                        additionalSearchTerms.AddCustomData(term.key, term.value);
+            }
+
+            foreach (var subData in graph.SubDatas)
+                if (subData == null || subData is MultiJsonInternal.UnknownGraphDataExtension || subData.objectIdIsEmpty || string.IsNullOrEmpty(subData.displayName))
+                    continue;
+                else additionalSearchTerms.AddCustomData("DataExtension", subData.displayName);
+
+            return additionalSearchTerms;
+        }
     }
 }

Packages/com.unity.shadergraph/Editor/Importers/ShaderGraphIndexerExtension.cs

@@ -10,9 +10,6 @@ namespace UnityEditor.ShaderGraph
 {
     class ShaderGraphTemplateHelper : ITemplateHelper
     {
-        const string k_TemplateBasePath = "Packages/com.unity.shadergraph/GraphTemplates";
-        const string k_BuiltInTemplatePath = k_TemplateBasePath + "/Default";
-
         class SaveFileDialog : GraphViewTemplateWindow.ISaveFileDialogHelper
         {
             public string OpenSaveFileDialog()
@@ -27,8 +24,8 @@ public string OpenSaveFileDialog()
         public string packageInfoName => "Shader Graph";
         public string learningSampleName => string.Empty;
         public string templateWindowDocUrl => Documentation.GetPageLink("index");
-        public string builtInTemplatePath => k_BuiltInTemplatePath;
-        public string builtInCategory => "Default Shader Graph Templates";
+        public string builtInTemplatePath => string.Empty;
+        public string builtInCategory => string.Empty;
         public Type assetType => typeof(Shader);
         public string createNewAssetTitle => "Create new Shader Graph Asset";
         public string insertTemplateTitle => "Insert a template into current Shader Graph Asset";
@@ -43,11 +40,12 @@ public void RaiseImportSampleDependencies(PackageManager.PackageInfo packageInfo
         public void RaiseTemplateUsed(GraphViewTemplateDescriptor usedTemplate) =>
             ShaderGraphAnalytics.SendShaderGraphTemplateEvent(usedTemplate);
 
-        public bool TryGetTemplate(string assetPath, out GraphViewTemplateDescriptor graphViewTemplate) => TryGetTemplateStatic(assetPath, out graphViewTemplate);
-        internal static bool TryGetTemplateStatic(string assetPath, out GraphViewTemplateDescriptor graphViewTemplate)
+        public bool TryGetTemplate(string assetPath, out GraphViewTemplateDescriptor graphViewTemplate) => TryGetTemplateStatic(assetPath, out graphViewTemplate, out _);
+        internal static bool TryGetTemplateStatic(string assetPath, out GraphViewTemplateDescriptor graphViewTemplate, out DataBag dataBag)
         {
             if (FileUtilities.TryGetImporter(assetPath, out var importer))
             {
+                dataBag = importer.AdditionalSearchTerms;
                 var template = importer.Template;
                 if (importer.UseAsTemplate)
                 {
@@ -79,14 +77,43 @@ public bool TrySetTemplate(string assetPath, GraphViewTemplateDescriptor graphVi
                     description = graphViewTemplate.description,
                     icon = graphViewTemplate.icon,
                     thumbnail = graphViewTemplate.thumbnail,
+                    order = graphViewTemplate.order,
                 };
                 importer.Template = template;
                 return true;
             }
             return false;
         }
 
+        internal static bool TryGetTemplateDescriptor(string assetPath, out GraphViewTemplateDescriptor graphViewTemplate)
+        {
+            if (FileUtilities.TryGetImporter(assetPath, out var importer))
+            {
+                var template = importer.Template;
+                if (importer.UseAsTemplate)
+                {
+                    var templateName = !string.IsNullOrEmpty(template.name) ? template.name : Path.GetFileNameWithoutExtension(assetPath);
+                    graphViewTemplate = new GraphViewTemplateDescriptor(ShaderGraphToolKey)
+                    {
+                        name = templateName,
+                        category = template.category,
+                        description = template.description,
+                        icon = template.icon,
+                        thumbnail = template.thumbnail,
+                        order =  template.order,
+                    };
+                    return true;
+                }
+            }
+            graphViewTemplate = default;
+            return false;
+        }
+
         public ITemplateSorter[] GetTemplateSorter() => Array.Empty<ITemplateSorter>();
-        public SearchProposition[] GetSearchPropositions() => Array.Empty<SearchProposition>();
+
+        public SearchProposition[] GetSearchPropositions()
+        {
+            return Array.Empty<SearchProposition>();
+        }
     }
 }