Better support for the LabelByChildAttribute across Toolbox Editors

Author: arimger

Assets/Editor Toolbox/Editor/Drawers/Regular/LabelByChildAttributeDrawer.cs

@@ -7,6 +7,7 @@
 
 namespace Toolbox.Editor
 {
+    using Toolbox.Attributes;
     using Toolbox.Editor.Drawers;
 
     /// <summary>
@@ -83,6 +84,12 @@ internal class ToolboxPropertyHandler
         /// </summary>
         private bool hasToolboxConditionDrawer;
 
+        /// <summary>
+        /// Temporary solution to cache all attributes responsible for overriding label.
+        /// This will be replaced with validation attributes.
+        /// </summary>
+        private ILabelProcessorAttribute labelProcessorAttribute;
+
 
         /// <summary>
         /// Constructor prepares all property-related data for custom drawing.
@@ -166,26 +173,27 @@ private void CheckIfPropertyHasPropertyDrawer(Type type)
 
         private void HandleNewAttribute(PropertyAttribute attribute)
         {
-            if (!isChild)
+            //NOTE: setting tooltip and labels is valid only for parent or single properties
+            //it's a bit ugly but, it's the only semi-acceptable way to support built-in TooltipAttribute
+            //TODO: move these attributes to validation drawers
+            switch (attribute)
             {
-                //NOTE: setting tooltip and labels is valid only for parent or single properties
-                //it's a bit ugly but, it's the only semi-acceptable way to support built-in TooltipAttribute
-                switch (attribute)
-                {
-                    case TooltipAttribute a:
-                        label.tooltip = a.tooltip;
-                        return;
-                    case NewLabelAttribute a:
-                        label.text = a.NewLabel;
-                        return;
-                    case LabelByChildAttribute a:
-                        if (!isArray)
-                        {
-                            PropertyUtility.OverrideLabelByChild(label, property, a.ChildName);
-                        }
-
-                        return;
-                }
+                case TooltipAttribute a:
+                    label.tooltip = a.tooltip;
+                    return;
+                case NewLabelAttribute a:
+                    if (!isChild)
+                    {
+                        labelProcessorAttribute = a;
+                    }
+                    return;
+                case LabelByChildAttribute a:
+                    if (!isArray)
+                    {
+                        labelProcessorAttribute = a;
+                    }
+
+                    return;
             }
 
             var attributeType = attribute.GetType();
@@ -276,6 +284,8 @@ private bool TryAssignConditionAttribute(ToolboxConditionAttribute attribute)
 
         private void DrawProperty(SerializedProperty property, GUIContent label)
         {
+            ProcessLabel(property, label);
+
             //get toolbox drawer for the property or draw it in the default way
             if (hasToolboxPropertyDrawer && (!hasBuiltInPropertyDrawer || isArray))
             {
@@ -326,6 +336,25 @@ private void CloseDecoratorDrawers(PropertyCondition conditionState = PropertyCo
             }
         }
 
+        //TODO: replace this method with validation attributes
+        private void ProcessLabel(SerializedProperty property, GUIContent label)
+        {
+            if (labelProcessorAttribute == null)
+            {
+                return;
+            }
+
+            switch (labelProcessorAttribute)
+            {
+                case NewLabelAttribute a:
+                    label.text = a.NewLabel;
+                    return;
+                case LabelByChildAttribute a:
+                    PropertyUtility.OverrideLabelByChild(label, property, a.ChildName);
+                    return;
+            }
+        }
+
         private void HandleDecorator(ToolboxDecoratorAttribute attribute, bool onBegin, PropertyCondition conditionState = PropertyCondition.Valid)
         {
             var drawer = ToolboxDrawerModule.GetDecoratorDrawer(attribute);

Assets/Editor Toolbox/Editor/ToolboxPropertyHandler.cs

@@ -0,0 +1,8 @@
+namespace Toolbox.Attributes
+{
+    /// <summary>
+    /// Temporary interface used to wrap all attributes used to override property labels.
+    /// </summary>
+    public interface ILabelProcessorAttribute
+    { }
+}

Assets/Editor Toolbox/Runtime/Attributes/ILabelProcessorAttribute.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Diagnostics;
 
+using Toolbox.Attributes;
+
 namespace UnityEngine
 {
     /// <summary>
@@ -22,7 +24,7 @@ namespace UnityEngine
     /// </summary>
     [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
     [Conditional("UNITY_EDITOR")]
-    public class LabelByChildAttribute : PropertyAttribute
+    public class LabelByChildAttribute : PropertyAttribute, ILabelProcessorAttribute
     {
         public LabelByChildAttribute(string childName)
         {

…ular/LabelByChildAttributeDrawer.cs.meta …ributes/ILabelProcessorAttribute.cs.metaAssets/Editor Toolbox/Editor/Drawers/Regular/LabelByChildAttributeDrawer.cs.meta renamed to Assets/Editor Toolbox/Runtime/Attributes/ILabelProcessorAttribute.cs.meta Assets/Editor Toolbox/Editor/Drawers/Regular/LabelByChildAttributeDrawer.cs.meta renamed to Assets/Editor Toolbox/Runtime/Attributes/ILabelProcessorAttribute.cs.meta

@@ -1,6 +1,8 @@
 using System;
 using System.Diagnostics;
 
+using Toolbox.Attributes;
+
 namespace UnityEngine
 {
     /// <summary>
@@ -10,7 +12,7 @@ namespace UnityEngine
     /// </summary>
     [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
     [Conditional("UNITY_EDITOR")]
-    public class NewLabelAttribute : PropertyAttribute
+    public class NewLabelAttribute : PropertyAttribute, ILabelProcessorAttribute
     {
         public NewLabelAttribute(string newLabel)
         {

Assets/Editor Toolbox/Runtime/Attributes/Special/LabelByChildAttribute.cs

@@ -703,28 +703,6 @@ MonoBehaviour:
   sceneReference: {fileID: 0}
   childReference: {fileID: 0}
   prefabReference: {fileID: 0}
-  sampleField:
-    var1: {fileID: 2100000, guid: 7404c70251f9d0045a4aabaa49d83963, type: 2}
-    var2: 0
-    var3:
-      var1: 0
-      var2: Label By Value
-  sampleFields:
-  - var1: {fileID: 0}
-    var2: 64
-    var3:
-      var1: 0
-      var2: 
-  - var1: {fileID: 0}
-    var2: 53
-    var3:
-      var1: 0
-      var2: 
-  - var1: {fileID: 0}
-    var2: 38
-    var3:
-      var1: 0
-      var2: 
   bigNumber: 12345678
   currency: 20.41
 --- !u!4 &959025299
@@ -1171,6 +1149,16 @@ MonoBehaviour:
   var1: 25.4
   var2: {fileID: 977748988}
   var3: 0
+  var4:
+  - var1: 36
+  - var1: 52
+  sampleField:
+    var1: {fileID: 0}
+    var2: 266
+    var3:
+      var1: 0
+      var2: New Label from var2.var3
+  sampleFields: []
 --- !u!4 &1583836799
 Transform:
   m_ObjectHideFlags: 2

Assets/Editor Toolbox/Runtime/Attributes/Special/NewLabelAttribute.cs

@@ -103,28 +103,6 @@ public enum FlagExample
     [PrefabObjectOnly]
     public GameObject prefabReference;
 
-    [Label("Label By Child", skinStyle: SkinStyle.Box)]
-
-    [LabelByChild("var3.var2")]
-    public SampleClass1 sampleField;
-    [LabelByChild("var2")]
-    public SampleClass1[] sampleFields;
-
-    [System.Serializable]
-    public class SampleClass1
-    {
-        public Material var1;
-        public KeyCode var2;
-        public SampleClass2 var3;
-    }
-
-    [System.Serializable]
-    public class SampleClass2
-    {
-        public int var1;
-        public string var2;
-    }
-
     [Label("Formatted Number", skinStyle: SkinStyle.Box)]
 
     [FormattedNumber]

Assets/Examples/Scenes/SampleScene.unity

@@ -1,4 +1,5 @@
-using UnityEngine;
+using System;
+using UnityEngine;
 
 [ExecuteAlways]
 [AddComponentMenu("Editor Toolbox/Cheat Sheet 7 (Special & Others)")]
@@ -16,4 +17,26 @@ public class SampleBehaviour7 : MonoBehaviour
 
     [HideLabel]
     public int var3;
+
+    [Label("LabelByChild", skinStyle: SkinStyle.Box)]
+
+    [LabelByChild("var3.var2")]
+    public SampleClass1 sampleField;
+    [LabelByChild("var2"), ReorderableList]
+    public SampleClass1[] sampleFields;
+
+    [Serializable]
+    public class SampleClass1
+    {
+        public Material var1;
+        public KeyCode var2;
+        public SampleClass2 var3;
+    }
+
+    [Serializable]
+    public class SampleClass2
+    {
+        public int var1;
+        public string var2;
+    }
 }