[MLA-1939] Match3 Custom Editor (#5263)

Chris Elion · web-flow · commit 04a02c1316d5 · 2021-04-15T13:42:34.000-07:00
diff --git a/Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuator.cs b/Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuator.cs
@@ -1,4 +1,3 @@
-using Unity.MLAgents;
 using Unity.MLAgents.Integrations.Match3;
 
 namespace Unity.MLAgentsExamples
diff --git a/Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuatorComponent.cs b/Project/Assets/ML-Agents/Examples/Match3/Scripts/Match3ExampleActuatorComponent.cs
@@ -10,7 +10,6 @@ public class Match3ExampleActuatorComponent : Match3ActuatorComponent
         public override IActuator[] CreateActuators()
         {
             var board = GetComponent<Match3Board>();
-            var agent = GetComponentInParent<Agent>();
             var seed = RandomSeed == -1 ? gameObject.GetInstanceID() : RandomSeed + 1;
             return new IActuator[] { new Match3ExampleActuator(board, ForceHeuristic, ActuatorName, seed) };
         }
diff --git a/com.unity.ml-agents/Editor/BufferSensorComponentEditor.cs b/com.unity.ml-agents/Editor/BufferSensorComponentEditor.cs
@@ -3,7 +3,7 @@
 
 namespace Unity.MLAgents.Editor
 {
-    [CustomEditor(typeof(BufferSensorComponent))]
+    [CustomEditor(typeof(BufferSensorComponent), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class BufferSensorComponentEditor : UnityEditor.Editor
     {
diff --git a/com.unity.ml-agents/Editor/CameraSensorComponentEditor.cs b/com.unity.ml-agents/Editor/CameraSensorComponentEditor.cs
@@ -3,7 +3,7 @@
 
 namespace Unity.MLAgents.Editor
 {
-    [CustomEditor(typeof(CameraSensorComponent))]
+    [CustomEditor(typeof(CameraSensorComponent), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class CameraSensorComponentEditor : UnityEditor.Editor
     {
diff --git a/com.unity.ml-agents/Editor/GridSensorComponentEditor.cs b/com.unity.ml-agents/Editor/GridSensorComponentEditor.cs
@@ -4,7 +4,7 @@
 
 namespace Unity.MLAgents.Editor
 {
-    [CustomEditor(typeof(GridSensorComponent))]
+    [CustomEditor(typeof(GridSensorComponent), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class GridSensorComponentEditor : UnityEditor.Editor
     {
diff --git a/com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs b/com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs
@@ -0,0 +1,38 @@
+using UnityEditor;
+using Unity.MLAgents.Integrations.Match3;
+namespace Unity.MLAgents.Editor
+{
+    [CustomEditor(typeof(Match3ActuatorComponent), editorForChildClasses: true)]
+    [CanEditMultipleObjects]
+    internal class Match3ActuatorComponentEditor : UnityEditor.Editor
+    {
+        public override void OnInspectorGUI()
+        {
+            var so = serializedObject;
+            so.Update();
+
+            // Drawing the RenderTextureComponent
+            EditorGUI.BeginChangeCheck();
+
+            EditorGUI.BeginDisabledGroup(!EditorUtilities.CanUpdateModelProperties());
+            {
+                EditorGUILayout.PropertyField(so.FindProperty("m_ActuatorName"), true);
+                EditorGUILayout.PropertyField(so.FindProperty("m_RandomSeed"), true);
+            }
+            EditorGUI.EndDisabledGroup();
+            EditorGUILayout.PropertyField(so.FindProperty("m_ForceHeuristic"), true);
+
+            var requireSensorUpdate = EditorGUI.EndChangeCheck();
+            so.ApplyModifiedProperties();
+
+            if (requireSensorUpdate)
+            {
+                UpdateActuator();
+            }
+        }
+
+        void UpdateActuator()
+        {
+        }
+    }
+}
diff --git a/com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs.meta b/com.unity.ml-agents/Editor/Match3ActuatorComponentEditor.cs.meta
diff --git a/com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs b/com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs
@@ -0,0 +1,37 @@
+using UnityEditor;
+using Unity.MLAgents.Integrations.Match3;
+namespace Unity.MLAgents.Editor
+{
+    [CustomEditor(typeof(Match3SensorComponent), editorForChildClasses: true)]
+    [CanEditMultipleObjects]
+    internal class Match3SensorComponentEditor : UnityEditor.Editor
+    {
+        public override void OnInspectorGUI()
+        {
+            var so = serializedObject;
+            so.Update();
+
+            // Drawing the RenderTextureComponent
+            EditorGUI.BeginChangeCheck();
+
+            EditorGUI.BeginDisabledGroup(!EditorUtilities.CanUpdateModelProperties());
+            {
+                EditorGUILayout.PropertyField(so.FindProperty("m_SensorName"), true);
+                EditorGUILayout.PropertyField(so.FindProperty("m_ObservationType"), true);
+            }
+            EditorGUI.EndDisabledGroup();
+
+            var requireSensorUpdate = EditorGUI.EndChangeCheck();
+            so.ApplyModifiedProperties();
+
+            if (requireSensorUpdate)
+            {
+                UpdateSensor();
+            }
+        }
+
+        void UpdateSensor()
+        {
+        }
+    }
+}
diff --git a/com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs.meta b/com.unity.ml-agents/Editor/Match3SensorComponentEditor.cs.meta
diff --git a/com.unity.ml-agents/Editor/RayPerceptionSensorComponentBaseEditor.cs b/com.unity.ml-agents/Editor/RayPerceptionSensorComponentBaseEditor.cs
@@ -87,7 +87,7 @@ void UpdateSensorIfDirty()
         }
     }
 
-    [CustomEditor(typeof(RayPerceptionSensorComponent2D))]
+    [CustomEditor(typeof(RayPerceptionSensorComponent2D), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class RayPerceptionSensorComponent2DEditor : RayPerceptionSensorComponentBaseEditor
     {
@@ -97,7 +97,7 @@ public override void OnInspectorGUI()
         }
     }
 
-    [CustomEditor(typeof(RayPerceptionSensorComponent3D))]
+    [CustomEditor(typeof(RayPerceptionSensorComponent3D), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class RayPerceptionSensorComponent3DEditor : RayPerceptionSensorComponentBaseEditor
     {
diff --git a/com.unity.ml-agents/Editor/RenderTextureSensorComponentEditor.cs b/com.unity.ml-agents/Editor/RenderTextureSensorComponentEditor.cs
@@ -2,7 +2,7 @@
 using Unity.MLAgents.Sensors;
 namespace Unity.MLAgents.Editor
 {
-    [CustomEditor(typeof(RenderTextureSensorComponent))]
+    [CustomEditor(typeof(RenderTextureSensorComponent), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class RenderTextureSensorComponentEditor : UnityEditor.Editor
     {
diff --git a/com.unity.ml-agents/Editor/VectorSensorComponentEditor.cs b/com.unity.ml-agents/Editor/VectorSensorComponentEditor.cs
@@ -3,7 +3,7 @@
 
 namespace Unity.MLAgents.Editor
 {
-    [CustomEditor(typeof(VectorSensorComponent))]
+    [CustomEditor(typeof(VectorSensorComponent), editorForChildClasses: true)]
     [CanEditMultipleObjects]
     internal class VectorSensorComponentEditor : UnityEditor.Editor
     {
diff --git a/com.unity.ml-agents/Runtime/Integrations/Match3/Match3ActuatorComponent.cs b/com.unity.ml-agents/Runtime/Integrations/Match3/Match3ActuatorComponent.cs
@@ -10,30 +10,50 @@ namespace Unity.MLAgents.Integrations.Match3
     [AddComponentMenu("ML Agents/Match 3 Actuator", (int)MenuGroup.Actuators)]
     public class Match3ActuatorComponent : ActuatorComponent
     {
+        [HideInInspector, SerializeField, FormerlySerializedAs("ActuatorName")]
+        string m_ActuatorName = "Match3 Actuator";
+
         /// <summary>
         /// Name of the generated Match3Actuator object.
         /// Note that changing this at runtime does not affect how the Agent sorts the actuators.
         /// </summary>
-        public string ActuatorName = "Match3 Actuator";
+        public string ActuatorName
+        {
+            get => m_ActuatorName;
+            set => m_ActuatorName = value;
+        }
+
+        [HideInInspector, SerializeField, FormerlySerializedAs("RandomSeed")]
+        int m_RandomSeed = -1;
 
         /// <summary>
-        /// A random seed used to generate a board, if needed.
+        /// A random seed used in the actuator's heuristic, if needed.
         /// </summary>
-        public int RandomSeed = -1;
+        public int RandomSeed
+        {
+            get => m_RandomSeed;
+            set => m_RandomSeed = value;
+        }
+
+        [HideInInspector, SerializeField, FormerlySerializedAs("ForceHeuristic")]
+        [Tooltip("Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.")]
+        bool m_ForceHeuristic;
 
         /// <summary>
         /// Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.
         /// </summary>
-        [FormerlySerializedAs("ForceRandom")]
-        [Tooltip("Force using the Agent's Heuristic() method to decide the action. This should only be used in testing.")]
-        public bool ForceHeuristic;
+        public bool ForceHeuristic
+        {
+            get => m_ForceHeuristic;
+            set => m_ForceHeuristic = value;
+        }
 
         /// <inheritdoc/>
         public override IActuator[] CreateActuators()
         {
             var board = GetComponent<AbstractBoard>();
-            var seed = RandomSeed == -1 ? gameObject.GetInstanceID() : RandomSeed + 1;
-            return new IActuator[] { new Match3Actuator(board, ForceHeuristic, seed, ActuatorName) };
+            var seed = m_RandomSeed == -1 ? gameObject.GetInstanceID() : m_RandomSeed + 1;
+            return new IActuator[] { new Match3Actuator(board, m_ForceHeuristic, seed, m_ActuatorName) };
         }
 
         /// <inheritdoc/>
diff --git a/com.unity.ml-agents/Runtime/Integrations/Match3/Match3SensorComponent.cs b/com.unity.ml-agents/Runtime/Integrations/Match3/Match3SensorComponent.cs
@@ -1,6 +1,7 @@
 using System;
 using Unity.MLAgents.Sensors;
 using UnityEngine;
+using UnityEngine.Serialization;
 
 namespace Unity.MLAgents.Integrations.Match3
 {
@@ -10,16 +11,30 @@ namespace Unity.MLAgents.Integrations.Match3
     [AddComponentMenu("ML Agents/Match 3 Sensor", (int)MenuGroup.Sensors)]
     public class Match3SensorComponent : SensorComponent, IDisposable
     {
+        [HideInInspector, SerializeField, FormerlySerializedAs("SensorName")]
+        string m_SensorName = "Match3 Sensor";
+
         /// <summary>
         /// Name of the generated Match3Sensor object.
         /// Note that changing this at runtime does not affect how the Agent sorts the sensors.
         /// </summary>
-        public string SensorName = "Match3 Sensor";
+        public string SensorName
+        {
+            get => m_SensorName;
+            set => m_SensorName = value;
+        }
+
+        [HideInInspector, SerializeField, FormerlySerializedAs("ObservationType")]
+        Match3ObservationType m_ObservationType = Match3ObservationType.Vector;
 
         /// <summary>
         /// Type of observation to generate.
         /// </summary>
-        public Match3ObservationType ObservationType = Match3ObservationType.Vector;
+        public Match3ObservationType ObservationType
+        {
+            get => m_ObservationType;
+            set => m_ObservationType = value;
+        }
 
         private ISensor[] m_Sensors;
 
@@ -30,9 +45,9 @@ public override ISensor[] CreateSensors()
             Dispose();
 
             var board = GetComponent<AbstractBoard>();
-            var cellSensor = Match3Sensor.CellTypeSensor(board, ObservationType, SensorName + " (cells)");
+            var cellSensor = Match3Sensor.CellTypeSensor(board, m_ObservationType, m_SensorName + " (cells)");
             // This can be null if numSpecialTypes is 0
-            var specialSensor = Match3Sensor.SpecialTypeSensor(board, ObservationType, SensorName + " (special)");
+            var specialSensor = Match3Sensor.SpecialTypeSensor(board, m_ObservationType, m_SensorName + " (special)");
             m_Sensors = specialSensor != null
                 ? new ISensor[] { cellSensor, specialSensor }
             : new ISensor[] { cellSensor };

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-using Unity.MLAgents;`
`2`	`1`	`using Unity.MLAgents.Integrations.Match3;`
`3`	`2`
`4`	`3`	`namespace Unity.MLAgentsExamples`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ public class Match3ExampleActuatorComponent : Match3ActuatorComponent`
`10`	`10`	`public override IActuator[] CreateActuators()`
`11`	`11`	`{`
`12`	`12`	`var board = GetComponent<Match3Board>();`
`13`		`- var agent = GetComponentInParent<Agent>();`
`14`	`13`	`var seed = RandomSeed == -1 ? gameObject.GetInstanceID() : RandomSeed + 1;`
`15`	`14`	`return new IActuator[] { new Match3ExampleActuator(board, ForceHeuristic, ActuatorName, seed) };`
`16`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Unity.MLAgents.Editor`
`5`	`5`	`{`
`6`		`- [CustomEditor(typeof(BufferSensorComponent))]`
	`6`	`+ [CustomEditor(typeof(BufferSensorComponent), editorForChildClasses: true)]`
`7`	`7`	`[CanEditMultipleObjects]`
`8`	`8`	`internal class BufferSensorComponentEditor : UnityEditor.Editor`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Unity.MLAgents.Editor`
`5`	`5`	`{`
`6`		`- [CustomEditor(typeof(CameraSensorComponent))]`
	`6`	`+ [CustomEditor(typeof(CameraSensorComponent), editorForChildClasses: true)]`
`7`	`7`	`[CanEditMultipleObjects]`
`8`	`8`	`internal class CameraSensorComponentEditor : UnityEditor.Editor`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Unity.MLAgents.Editor`
`6`	`6`	`{`
`7`		`- [CustomEditor(typeof(GridSensorComponent))]`
	`7`	`+ [CustomEditor(typeof(GridSensorComponent), editorForChildClasses: true)]`
`8`	`8`	`[CanEditMultipleObjects]`
`9`	`9`	`internal class GridSensorComponentEditor : UnityEditor.Editor`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ void UpdateSensorIfDirty()`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`
`90`		`- [CustomEditor(typeof(RayPerceptionSensorComponent2D))]`
	`90`	`+ [CustomEditor(typeof(RayPerceptionSensorComponent2D), editorForChildClasses: true)]`
`91`	`91`	`[CanEditMultipleObjects]`
`92`	`92`	`internal class RayPerceptionSensorComponent2DEditor : RayPerceptionSensorComponentBaseEditor`
`93`	`93`	`{`
`@@ -97,7 +97,7 @@ public override void OnInspectorGUI()`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`
`100`		`- [CustomEditor(typeof(RayPerceptionSensorComponent3D))]`
	`100`	`+ [CustomEditor(typeof(RayPerceptionSensorComponent3D), editorForChildClasses: true)]`
`101`	`101`	`[CanEditMultipleObjects]`
`102`	`102`	`internal class RayPerceptionSensorComponent3DEditor : RayPerceptionSensorComponentBaseEditor`
`103`	`103`	`{`