updated and fixed the categorical parameter UI

Author: sleal-unity

com.unity.perception/CHANGELOG.md

@@ -27,6 +27,8 @@ Added new capture options to Perception Camera:
 * Can now render intermediate frames between captures.
 * Capture can now be triggered manually using a function call, instead of automatic capturing on a schedule.
 
+Categorical Parameters will now validate that their specified options are unique at runtime
+
 ### Changed
 
 Randomizers now access their parent scenario through the static activeScenario property
@@ -45,6 +47,7 @@ RandomizerTagManager.Query<T>() now returns RandomizerTags directly instead of t
 
 Semantic Segmentation Labeler now places data in folders with randomized filenames
 
+The uniform toggle on Categorical Parameters will now reset the parameter's probability weights to be uniform
 
 ### Deprecated
 
@@ -74,6 +77,8 @@ Semantic Segmentation Labeler now produces output in the proper form for distrib
 
 Texture Randomizer is now compatible with HDRP
 
+Categorical Parameters no longer error when deleting items from long options lists
+
 
 ## [0.6.0-preview.1] - 2020-12-03
 

com.unity.perception/Editor/Randomization/VisualElements/Parameter/CategoricalOptionElement.cs

@@ -17,22 +17,26 @@ internal CategoricalOptionElement(
         {
             m_CategoryProperty = categoryProperty;
             m_ProbabilitiesProperty = probabilitiesProperty;
-
-            var template = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>(
-                $"{StaticData.uxmlDir}/Parameter/CategoricalOptionElement.uxml");
-            template.CloneTree(this);
         }
 
         // Called from categorical parameter
         public void BindProperties(int i)
         {
+            // Reset this categorical item's UI
+            Clear();
+            var template = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>(
+                $"{StaticData.uxmlDir}/Parameter/CategoricalOptionElement.uxml");
+            template.CloneTree(this);
+
             m_Index = i;
             var indexLabel = this.Q<Label>("index-label");
             indexLabel.text = $"[{m_Index}]";
 
             var optionProperty = m_CategoryProperty.GetArrayElementAtIndex(i);
             var option = this.Q<PropertyField>("option");
             option.BindProperty(optionProperty);
+
+            // Remove the redundant element label to save space
             var label = option.Q<Label>();
             label.parent.Remove(label);
 

com.unity.perception/Editor/Randomization/VisualElements/Parameter/ParameterElement.cs

@@ -105,6 +105,17 @@ void BindItem(VisualElement e, int i)
             {
                 probabilitiesProperty.arraySize++;
                 optionsProperty.arraySize++;
+                var newOption = optionsProperty.GetArrayElementAtIndex(optionsProperty.arraySize - 1);
+                switch (newOption.propertyType)
+                {
+                    case SerializedPropertyType.ObjectReference:
+                        newOption.objectReferenceValue = null;
+                        break;
+                    case SerializedPropertyType.String:
+                        newOption.stringValue = string.Empty;
+                        break;
+                }
+
                 m_SerializedProperty.serializedObject.ApplyModifiedProperties();
                 listView.itemsSource = categoricalParameter.probabilities;
                 listView.Refresh();
@@ -162,18 +173,33 @@ void BindItem(VisualElement e, int i)
             var uniformToggle = template.Q<Toggle>("uniform");
             var uniformProperty = m_SerializedProperty.FindPropertyRelative("uniform");
             uniformToggle.BindProperty(uniformProperty);
-            void ToggleProbabilityFields(bool toggle)
-            {
-                if (toggle)
-                    listView.AddToClassList("collapsed");
-                else
-                    listView.RemoveFromClassList("collapsed");
-            }
-            ToggleProbabilityFields(uniformToggle.value);
+
+            if (uniformToggle.value)
+                listView.AddToClassList("collapsed");
+            else
+                listView.RemoveFromClassList("collapsed");
+
             if (Application.isPlaying)
                 uniformToggle.SetEnabled(false);
             else
-                uniformToggle.RegisterCallback<ChangeEvent<bool>>(evt => ToggleProbabilityFields(evt.newValue));
+            {
+                uniformToggle.RegisterCallback<ChangeEvent<bool>>(evt =>
+                {
+                    listView.ToggleInClassList("collapsed");
+                    if (!evt.newValue)
+                        return;
+                    var numOptions = optionsProperty.arraySize;
+                    var uniformProbabilityValue = 1f / numOptions;
+                    for (var i = 0; i < numOptions; i++)
+                    {
+                        var probability = probabilitiesProperty.GetArrayElementAtIndex(i);
+                        probability.floatValue = uniformProbabilityValue;
+                    }
+                    m_SerializedProperty.serializedObject.ApplyModifiedProperties();
+                    listView.itemsSource = categoricalParameter.probabilities;
+                    listView.Refresh();
+                });
+            }
 
             m_PropertiesContainer.Add(template);
         }

com.unity.perception/Runtime/Randomization/Parameters/CategoricalParameter.cs

@@ -97,8 +97,20 @@ void AddOption(T option, float probability)
         public override void Validate()
         {
             base.Validate();
+
+            // Check for a non-zero amount of specified categories
             if (m_Categories.Count == 0)
                 throw new ParameterValidationException("No options added to categorical parameter");
+
+            // Check for duplicate categories
+            var uniqueCategories = new HashSet<T>();
+            foreach (var option in m_Categories)
+                if (uniqueCategories.Contains(option))
+                    throw new ParameterValidationException("Duplicate categories");
+                else
+                    uniqueCategories.Add(option);
+
+            // Check if the number of specified probabilities is different from the number of listed categories
             if (!uniform)
             {
                 if (probabilities.Count != m_Categories.Count)

com.unity.perception/Tests/Runtime/Randomization/ParameterTests/CategoricalParameterTests.cs

@@ -1,5 +1,6 @@
 using NUnit.Framework;
 using UnityEngine;
+using UnityEngine.Experimental.Perception.Editor;
 using UnityEngine.Experimental.Perception.Randomization.Parameters;
 
 namespace RandomizationTests.ParameterTests
@@ -25,12 +26,20 @@ public void TearDown()
         public void NegativeProbabilities()
         {
             var parameter = new StringParameter();
-            var optionsArray = new [] { ("option1", 1f), ("option1", -1f) };
+            var optionsArray = new [] { ("option1", 1f), ("option2", -1f) };
             Assert.Throws<ParameterValidationException>(() => parameter.SetOptions(optionsArray));
         }
 
         [Test]
         public void ZeroSumProbability()
+        {
+            var parameter = new StringParameter();
+            var optionsArray = new [] { ("option1", 0f), ("option2", 0f) };
+            Assert.Throws<ParameterValidationException>(() => parameter.SetOptions(optionsArray));
+        }
+
+        [Test]
+        public void DuplicateCategoriesTest()
         {
             var parameter = new StringParameter();
             var optionsArray = new [] { ("option1", 0f), ("option1", 0f) };