Vfx/feature/filter enum (#243)

iTris666 · iTris666 · commit ba38685a101a · 2020-04-07T14:38:29.000+02:00
* Allow filtering enums values in VFXModels.

* Add an explicit GetHashCode() to default NameNType.

* Update CHANGELOG.md

* Update VFXHDRPSubOutput.cs

* fix based on review
diff --git a/com.unity.render-pipelines.high-definition/Editor/VFXGraph/VFXHDRPSubOutput.cs b/com.unity.render-pipelines.high-definition/Editor/VFXGraph/VFXHDRPSubOutput.cs
@@ -16,6 +16,9 @@ class VFXHDRPSubOutput : VFXSRPSubOutput
         [VFXSetting(VFXSettingAttribute.VisibleFlags.InInspector), Header("HDRP"), Tooltip("Specifies when in the render queue particles are drawn. This is useful for drawing particles behind refractive surfaces like frosted glass, for performance gains by rendering them in low resolution, or to draw particles after post processing so they are not affected by effects such as Depth of Field.")]
         public TransparentRenderQueue transparentRenderQueue = TransparentRenderQueue.Default;
 
+
+        
+
         // Caps
         public override bool supportsExposure { get { return true; } } 
         public override bool supportsMotionVector
@@ -41,6 +44,18 @@ protected override IEnumerable<string> filteredOutSettings
             }
         }
 
+        public override IEnumerable<int> GetFilteredOutEnumerators(string name)
+        {
+            switch (name)
+            {
+                case "opaqueRenderQueue":
+                    return new int[] { (int)OpaqueRenderQueue.Raytracing };
+                case "transparentRenderQueue":
+                    return new int[] { (int)TransparentRenderQueue.Raytracing };
+            }
+            return null;
+        }
+
         public override string GetBlendModeStr()
         {
             bool isOffscreen = transparentRenderQueue == TransparentRenderQueue.LowResolution || transparentRenderQueue == TransparentRenderQueue.AfterPostProcessing;
diff --git a/com.unity.visualeffectgraph/CHANGELOG.md b/com.unity.visualeffectgraph/CHANGELOG.md
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Noise evaluation now performed on CPU when possible
 - Range and Min attributes support on int and uint parameters
 - New Construct Matrix from Vector4 operator
+- Allow filtering enums in VFXModels' VFXSettings.
 
 ### Fixed
 - Moved VFX Event Tester Window visibility to Component Play Controls SceneView Window
diff --git a/com.unity.visualeffectgraph/Editor/Controls/VFXEnumField.cs b/com.unity.visualeffectgraph/Editor/Controls/VFXEnumField.cs
@@ -1,3 +1,6 @@
+using System.Collections.Generic;
+using System.Linq;
+using System;
 using UnityEngine;
 using UnityEngine.UIElements;
 using UnityEditor.VFX.UI;
@@ -11,6 +14,10 @@ class VFXEnumField : ValueControl<int>
         TextElement m_ValueText;
         System.Type m_EnumType;
 
+        public IEnumerable<int> filteredOutValues { get; set; }
+
+        public Action<VFXEnumField> OnDisplayMenu;
+
         void CreateHierarchy()
         {
             AddToClassList("unity-enum-field");
@@ -29,13 +36,15 @@ void CreateHierarchy()
 
         void OnClick()
         {
+            if (OnDisplayMenu != null)
+                OnDisplayMenu(this);
             GenericMenu menu = new GenericMenu();
 
             foreach (string val in System.Enum.GetNames(m_EnumType))
             {
                 int valueInt = (int)System.Enum.Parse(m_EnumType, val);
-
-                menu.AddItem(new GUIContent(ObjectNames.NicifyVariableName(val)), valueInt == m_Value, ChangeValue, valueInt);
+                if(filteredOutValues == null || !filteredOutValues.Any(t=>t == valueInt))
+                    menu.AddItem(new GUIContent(ObjectNames.NicifyVariableName(val)), valueInt == m_Value, ChangeValue, valueInt);
             }
             menu.DropDown(m_DropDownButton.worldBound);
         }
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXDataAnchorController.cs b/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXDataAnchorController.cs
@@ -67,6 +67,9 @@ public override string name
 
         public Type portType { get; set; }
 
+
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
+
         public Type storageType
         {
             get
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXParameterController.cs b/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXParameterController.cs
@@ -67,6 +67,7 @@ public VFXSubParameterController[] children
                 return m_Children;
             }
         }
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
 
         VFXCoordinateSpace IPropertyRMProvider.space
         {
@@ -213,6 +214,7 @@ public object value
             }
         }
 
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
         public string name
         {
             get { return m_Min ? "Min" : "Max"; }
@@ -336,6 +338,7 @@ void OnSlotChanged()
                 return;
             NotifyChange(ValueChanged);
         }
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
 
         Dictionary<string, VFXSubParameterController> m_ChildrenByPath = new Dictionary<string, VFXSubParameterController>();
 
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXParameterNodeController.cs b/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXParameterNodeController.cs
@@ -227,6 +227,7 @@ bool IPropertyRMProvider.editable
         bool IPropertyRMProvider.expandableIfShowsEverything { get { return false; } }
 
 
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
         public object value
         {
             get
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXSettingController.cs b/com.unity.visualeffectgraph/Editor/GraphView/Elements/Controllers/VFXSettingController.cs
@@ -72,6 +72,9 @@ public virtual bool expandable
         }
         bool IPropertyRMProvider.expandableIfShowsEverything { get { return false; } }
 
+
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return (m_Owner as VFXModel).GetFilteredOutEnumerators(name); } }
+
         public virtual string iconName
         {
             get { return portType.Name; }
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Views/Properties/PropertyRM.cs b/com.unity.visualeffectgraph/Editor/GraphView/Views/Properties/PropertyRM.cs
@@ -28,6 +28,8 @@ interface IPropertyRMProvider
         Type portType { get; }
         int depth {get; }
         bool editable { get; }
+
+        IEnumerable<int> filteredOutEnumerators { get; }
         void RetractPath();
         void ExpandPath();
     }
@@ -67,6 +69,9 @@ object IPropertyRMProvider.value
                 m_Setter((T)value);
             }
         }
+
+        IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }
+
         string IPropertyRMProvider.name
         {
             get { return m_Name; }
diff --git a/com.unity.visualeffectgraph/Editor/GraphView/Views/Properties/SimplePropertiesRM.cs b/com.unity.visualeffectgraph/Editor/GraphView/Views/Properties/SimplePropertiesRM.cs
@@ -3,14 +3,7 @@
 using System.Reflection;
 using UnityEngine;
 using UnityEngine.UIElements;
-using UnityEditor.UIElements;
-using UnityEditor.VFX;
-using UnityEditor.VFX.UIElements;
-using Object = UnityEngine.Object;
-using Type = System.Type;
 using EnumField = UnityEditor.VFX.UIElements.VFXEnumField;
-using VFXVector2Field = UnityEditor.VFX.UI.VFXVector2Field;
-using VFXVector4Field = UnityEditor.VFX.UI.VFXVector4Field;
 
 namespace UnityEditor.VFX.UI
 {
@@ -40,7 +33,15 @@ public override float GetPreferredControlWidth()
 
         public override ValueControl<int> CreateField()
         {
-            return new EnumField(m_Label, m_Provider.portType);
+            var field = new EnumField(m_Label, m_Provider.portType);
+            field.OnDisplayMenu = OnDisplayMenu;
+
+            return field;
+        }
+
+        void OnDisplayMenu(EnumField field)
+        {
+            field.filteredOutValues = provider.filteredOutEnumerators;
         }
     }
 
diff --git a/com.unity.visualeffectgraph/Editor/Inspector/VFXSlotContainerEditor.cs b/com.unity.visualeffectgraph/Editor/Inspector/VFXSlotContainerEditor.cs
@@ -33,16 +33,28 @@ protected virtual SerializedProperty FindProperty(VFXSetting setting)
         return serializedObject.FindProperty(setting.field.Name);
     }
 
+    struct NameNType
+    {
+        public string name;
+        public Type type;
+
+        public override int GetHashCode()
+        {
+            return name.GetHashCode() * 23 + type.GetHashCode();
+        }
+    }
+
     public virtual void DoInspectorGUI()
     {
         var slotContainer = targets[0] as VFXModel;
-        IEnumerable<VFXSetting> settingFields = slotContainer.GetSettings(false, VFXSettingAttribute.VisibleFlags.InInspector);
+        List<VFXSetting> settingFields = slotContainer.GetSettings(false, VFXSettingAttribute.VisibleFlags.InInspector).ToList();
 
         for (int i = 1; i < targets.Length; ++i)
         {
-            IEnumerable<VFXSetting> otherSettingFields = (targets[i] as VFXModel).GetSettings(false, VFXSettingAttribute.VisibleFlags.InInspector);
+            IEnumerable<VFXSetting> otherSettingFields = (targets[i] as VFXModel).GetSettings(false, VFXSettingAttribute.VisibleFlags.InInspector).ToArray() ;
 
-            settingFields = settingFields.Intersect(otherSettingFields);
+            var excluded = new HashSet<NameNType>(settingFields.Select(t => new NameNType() { name = t.name, type = t.field.FieldType }).Except(otherSettingFields.Select(t => new NameNType() { name = t.name, type = t.field.FieldType })));
+            settingFields.RemoveAll(t => excluded.Any( u=> u.name == t.name));
         }
 
         foreach (var prop in settingFields.Select(t => new KeyValuePair<FieldInfo, SerializedProperty>(t.field, FindProperty(t))).Where(t => t.Value != null))
@@ -59,6 +71,32 @@ public virtual void DoInspectorGUI()
                     prop.Value.stringValue = strings[result];
                 }
             }
+            else if(prop.Key.FieldType.IsEnum)
+            {
+                GUIContent[] enumNames = null;
+                int[] enumValues = null;
+
+                Array enums = Enum.GetValues(prop.Key.FieldType);
+                List<int> values = new List<int>(enums.Length);
+                for (int i = 0; i < enums.Length; ++i)
+                {
+                    values.Add((int)enums.GetValue(i));
+                }
+
+                foreach (var target in targets)
+                {
+                    VFXModel targetIte = target as VFXModel;
+
+                    var filteredValues = targetIte.GetFilteredOutEnumerators(prop.Key.Name);
+                    if (filteredValues != null)
+                        foreach (int val in filteredValues)
+                            values.Remove(val);
+                }
+                enumNames = values.Select(t => new GUIContent(Enum.GetName(prop.Key.FieldType, t))).ToArray();
+                enumValues = values.ToArray();
+
+                EditorGUILayout.IntPopup(prop.Value,enumNames,enumValues );
+            }
             else
             {
                 bool visibleChildren = EditorGUILayout.PropertyField(prop.Value);
diff --git a/com.unity.visualeffectgraph/Editor/Models/Contexts/Implementations/VFXAbstractRenderedOutput.cs b/com.unity.visualeffectgraph/Editor/Models/Contexts/Implementations/VFXAbstractRenderedOutput.cs
@@ -44,6 +44,12 @@ public virtual bool hasMotionVector
 
         protected VFXAbstractRenderedOutput(VFXDataType dataType) : base(VFXContextType.Output, dataType, VFXDataType.None) {}
 
+
+
+        public override IEnumerable<int> GetFilteredOutEnumerators(string name)
+        {
+            return subOutput.GetFilteredOutEnumerators(name);
+        }
         public VFXSRPSubOutput subOutput
         {
             get
diff --git a/com.unity.visualeffectgraph/Editor/Models/VFXModel.cs b/com.unity.visualeffectgraph/Editor/Models/VFXModel.cs
@@ -303,7 +303,8 @@ private bool SetSettingValueAndReturnIfChanged(string name, object value)
 
         // Override this method to update other settings based on a setting modification
         // Use OnIvalidate with KSettingChanged and not this method to handle other side effects
-        protected virtual void OnSettingModified(VFXSetting setting) {}
+        protected virtual void OnSettingModified(VFXSetting setting) { }
+        public virtual IEnumerable<int> GetFilteredOutEnumerators(string name) { return null; }
 
         public virtual VFXSetting GetSetting(string name)
         {

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@ public override string name`
`67`	`67`
`68`	`68`	`public Type portType { get; set; }`
`69`	`69`
	`70`	`+`
	`71`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
	`72`	`+`
`70`	`73`	`public Type storageType`
`71`	`74`	`{`
`72`	`75`	`get`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ public VFXSubParameterController[] children`
`67`	`67`	`return m_Children;`
`68`	`68`	`}`
`69`	`69`	`}`
	`70`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
`70`	`71`
`71`	`72`	`VFXCoordinateSpace IPropertyRMProvider.space`
`72`	`73`	`{`
`@@ -213,6 +214,7 @@ public object value`
`213`	`214`	`}`
`214`	`215`	`}`
`215`	`216`
	`217`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
`216`	`218`	`public string name`
`217`	`219`	`{`
`218`	`220`	`get { return m_Min ? "Min" : "Max"; }`
`@@ -336,6 +338,7 @@ void OnSlotChanged()`
`336`	`338`	`return;`
`337`	`339`	`NotifyChange(ValueChanged);`
`338`	`340`	`}`
	`341`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
`339`	`342`
`340`	`343`	`Dictionary<string, VFXSubParameterController> m_ChildrenByPath = new Dictionary<string, VFXSubParameterController>();`
`341`	`344`
Original file line number	Diff line number	Diff line change
`@@ -227,6 +227,7 @@ bool IPropertyRMProvider.editable`
`227`	`227`	`bool IPropertyRMProvider.expandableIfShowsEverything { get { return false; } }`
`228`	`228`
`229`	`229`
	`230`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
`230`	`231`	`public object value`
`231`	`232`	`{`
`232`	`233`	`get`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,9 @@ public virtual bool expandable`
`72`	`72`	`}`
`73`	`73`	`bool IPropertyRMProvider.expandableIfShowsEverything { get { return false; } }`
`74`	`74`
	`75`	`+`
	`76`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return (m_Owner as VFXModel).GetFilteredOutEnumerators(name); } }`
	`77`	`+`
`75`	`78`	`public virtual string iconName`
`76`	`79`	`{`
`77`	`80`	`get { return portType.Name; }`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ interface IPropertyRMProvider`
`28`	`28`	`Type portType { get; }`
`29`	`29`	`int depth {get; }`
`30`	`30`	`bool editable { get; }`
	`31`	`+`
	`32`	`+ IEnumerable<int> filteredOutEnumerators { get; }`
`31`	`33`	`void RetractPath();`
`32`	`34`	`void ExpandPath();`
`33`	`35`	`}`
`@@ -67,6 +69,9 @@ object IPropertyRMProvider.value`
`67`	`69`	`m_Setter((T)value);`
`68`	`70`	`}`
`69`	`71`	`}`
	`72`	`+`
	`73`	`+ IEnumerable<int> IPropertyRMProvider.filteredOutEnumerators { get { return null; } }`
	`74`	`+`
`70`	`75`	`string IPropertyRMProvider.name`
`71`	`76`	`{`
`72`	`77`	`get { return m_Name; }`