NEW: Add UI Toolkit matching control bindings UI (#1835)

* Add 'matching controls' into tree view of new UI TK action asset UI
* Tightened up layout of control scheme text and the matching paths tree view labels
* Split out MatchingControlPaths to separate source file

Author: lyndon-unity

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -21,6 +21,7 @@ however, it has to be formatted properly to pass verification tests.
   - [`InputAction.WasCompletedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasCompletedThisFrame) returns `true` on the frame that the action stopped being in the performed phase. This allows for similar functionality to [`WasPressedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasPressedThisFrame)/[`WasReleasedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasReleasedThisFrame) when paired with [`WasPerformedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasPerformedThisFrame) except it is directly based on the interactions driving the action. For example, you can use it to distinguish between the button being released or whether it was released after being held for long enough to perform when using the Hold interaction.
 - Added Copy, Paste and Cut support for Action Maps, Actions and Bindings via context menu and key command shortcuts.
 - Added Dual Sense Edge controller to be mapped to the same layout as the Dual Sense controller
+- UI Toolkit input action editor now supports showing the derived bindings.
 
 ### Fixed
 - Fixed syntax of code examples in API documentation for [`AxisComposite`](xref:UnityEngine.InputSystem.Composites.AxisComposite).

Packages/com.unity.inputsystem/InputSystem/Editor/AssetEditor/InputBindingPropertiesView.cs

@@ -117,171 +117,61 @@ protected override void DrawGeneralProperties()
         private static bool showMatchingLayouts = false;
         private static Dictionary<string, bool> showMatchingChildLayouts = new Dictionary<string, bool>();
 
-        /// <summary>
-        /// Finds all registered control paths implemented by concrete classes which match the current binding path and renders it.
-        /// </summary>
-        private void DrawMatchingControlPaths()
+        private static void DrawMatchingControlPaths(List<MatchingControlPath> matchingControlPaths)
         {
-            var path = m_ControlPathEditor.pathProperty.stringValue;
-            if (path == string.Empty)
-                return;
-
-            var deviceLayoutPath = InputControlPath.TryGetDeviceLayout(path);
-            var parsedPath = InputControlPath.Parse(path).ToArray();
-
-            // If the provided path is parseable into device and control components, draw UI which shows control layouts that match the path.
-            if (parsedPath.Length >= 2 && !string.IsNullOrEmpty(deviceLayoutPath))
+            foreach (var matchingControlPath in matchingControlPaths)
             {
-                bool matchExists = false;
+                bool showLayout = false;
+                EditorGUI.indentLevel++;
 
-                var rootDeviceLayout = EditorInputControlLayoutCache.TryGetLayout(deviceLayoutPath);
-                bool isValidDeviceLayout = deviceLayoutPath == InputControlPath.Wildcard || (rootDeviceLayout != null && !rootDeviceLayout.isOverride && !rootDeviceLayout.hideInUI);
-                // Exit early if a malformed device layout was provided,
-                if (!isValidDeviceLayout)
-                    return;
+                var text = $"{matchingControlPath.deviceName} > {matchingControlPath.controlName}";
+                if (matchingControlPath.children.Count() > 0 && !matchingControlPath.isRoot)
+                {
+                    showMatchingChildLayouts.TryGetValue(matchingControlPath.deviceName, out showLayout);
+                    showMatchingChildLayouts[matchingControlPath.deviceName] = EditorGUILayout.Foldout(showLayout, text);
+                }
+                else
+                {
+                    EditorGUILayout.LabelField(text);
+                }
 
-                bool controlPathUsagePresent = parsedPath[1].usages.Count() > 0;
-                bool hasChildDeviceLayouts = deviceLayoutPath == InputControlPath.Wildcard || EditorInputControlLayoutCache.HasChildLayouts(rootDeviceLayout.name);
+                showLayout |= matchingControlPath.isRoot;
+                if (showLayout)
+                    DrawMatchingControlPaths(matchingControlPath.children);
 
-                // If the path provided matches exactly one control path (i.e. has no ui-facing child device layouts or uses control usages), then exit early
-                if (!controlPathUsagePresent && !hasChildDeviceLayouts)
-                    return;
+                EditorGUI.indentLevel--;
+            }
+        }
 
-                // Otherwise, we will show either all controls that match the current binding (if control usages are used)
-                // or all controls in derived device layouts (if a no control usages are used).
+        /// <summary>
+        /// Finds all registered control paths implemented by concrete classes which match the current binding path and renders it.
+        /// </summary>
+        private void DrawMatchingControlPaths()
+        {
+            bool controlPathUsagePresent = false;
+            List<MatchingControlPath> matchingControlPaths = MatchingControlPath.CollectMatchingControlPaths(m_ControlPathEditor.pathProperty.stringValue, showMatchingLayouts, ref controlPathUsagePresent);
+            if (matchingControlPaths == null || matchingControlPaths.Count != 0)
+            {
                 EditorGUILayout.BeginVertical();
                 showMatchingLayouts = EditorGUILayout.Foldout(showMatchingLayouts, "Derived Bindings");
 
                 if (showMatchingLayouts)
                 {
-                    // If our control path contains a usage, make sure we render the binding that belongs to the root device layout first
-                    if (deviceLayoutPath != InputControlPath.Wildcard && controlPathUsagePresent)
-                    {
-                        matchExists |= DrawMatchingControlPathsForLayout(rootDeviceLayout, in parsedPath, true);
-                    }
-                    // Otherwise, just render the bindings that belong to child device layouts. The binding that matches the root layout is
-                    // already represented by the user generated control path itself.
-                    else
-                    {
-                        IEnumerable<InputControlLayout> matchedChildLayouts = Enumerable.Empty<InputControlLayout>();
-                        if (deviceLayoutPath == InputControlPath.Wildcard)
-                        {
-                            matchedChildLayouts = EditorInputControlLayoutCache.allLayouts
-                                .Where(x => x.isDeviceLayout && !x.hideInUI && !x.isOverride && x.isGenericTypeOfDevice && x.baseLayouts.Count() == 0).OrderBy(x => x.displayName);
-                        }
-                        else
-                        {
-                            matchedChildLayouts = EditorInputControlLayoutCache.TryGetChildLayouts(rootDeviceLayout.name);
-                        }
-
-                        foreach (var childLayout in matchedChildLayouts)
-                        {
-                            matchExists |= DrawMatchingControlPathsForLayout(childLayout, in parsedPath);
-                        }
-                    }
-
-                    // Otherwise, indicate that no layouts match the current path.
-                    if (!matchExists)
+                    if (matchingControlPaths == null)
                     {
                         if (controlPathUsagePresent)
                             EditorGUILayout.HelpBox("No registered controls match this current binding. Some controls are only registered at runtime.", MessageType.Warning);
                         else
                             EditorGUILayout.HelpBox("No other registered controls match this current binding. Some controls are only registered at runtime.", MessageType.Warning);
                     }
-                }
-
-                EditorGUILayout.EndVertical();
-            }
-        }
-
-        /// <summary>
-        /// Returns true if the deviceLayout or any of its children has controls which match the provided parsed path. exist matching registered control paths.
-        /// </summary>
-        /// <param name="deviceLayout">The device layout to draw control paths for</param>
-        /// <param name="parsedPath">The parsed path containing details of the Input Controls that can be matched</param>
-        private bool DrawMatchingControlPathsForLayout(InputControlLayout deviceLayout, in InputControlPath.ParsedPathComponent[] parsedPath, bool isRoot = false)
-        {
-            string deviceName = deviceLayout.displayName;
-            string controlName = string.Empty;
-            bool matchExists = false;
-
-            for (int i = 0; i < deviceLayout.m_Controls.Length; i++)
-            {
-                ref InputControlLayout.ControlItem controlItem = ref deviceLayout.m_Controls[i];
-                if (InputControlPath.MatchControlComponent(ref parsedPath[1], ref controlItem, true))
-                {
-                    // If we've already located a match, append a ", " to the control name
-                    // This is to accomodate cases where multiple control items match the same path within a single device layout
-                    // Note, some controlItems have names but invalid displayNames (i.e. the Dualsense HID > leftTriggerButton)
-                    // There are instance where there are 2 control items with the same name inside a layout definition, however they are not
-                    // labeled significantly differently.
-                    // The notable example is that the Android Xbox and Android Dualshock layouts have 2 d-pad definitions, one is a "button"
-                    // while the other is an axis.
-                    controlName += matchExists ? $", {controlItem.name}" : controlItem.name;
-
-                    // if the parsePath has a 3rd component, try to match it with items in the controlItem's layout definition.
-                    if (parsedPath.Length == 3)
-                    {
-                        var controlLayout = EditorInputControlLayoutCache.TryGetLayout(controlItem.layout);
-                        if (controlLayout.isControlLayout && !controlLayout.hideInUI)
-                        {
-                            for (int j = 0; j < controlLayout.m_Controls.Count(); j++)
-                            {
-                                ref InputControlLayout.ControlItem controlLayoutItem = ref controlLayout.m_Controls[j];
-                                if (InputControlPath.MatchControlComponent(ref parsedPath[2], ref controlLayoutItem))
-                                {
-                                    controlName += $"/{controlLayoutItem.name}";
-                                    matchExists = true;
-                                }
-                            }
-                        }
-                    }
                     else
                     {
-                        matchExists = true;
+                        DrawMatchingControlPaths(matchingControlPaths);
                     }
                 }
-            }
-
-            IEnumerable<InputControlLayout> matchedChildLayouts = EditorInputControlLayoutCache.TryGetChildLayouts(deviceLayout.name);
 
-            // If this layout does not have a match, or is the top level root layout,
-            // skip over trying to draw any items for it, and immediately try processing the child layouts
-            if (!matchExists)
-            {
-                foreach (var childLayout in matchedChildLayouts)
-                {
-                    matchExists |= DrawMatchingControlPathsForLayout(childLayout, in parsedPath);
-                }
-            }
-            // Otherwise, draw the items for it, and then only process the child layouts if the foldout is expanded.
-            else
-            {
-                bool showLayout = false;
-                EditorGUI.indentLevel++;
-                if (matchedChildLayouts.Count() > 0 && !isRoot)
-                {
-                    showMatchingChildLayouts.TryGetValue(deviceName, out showLayout);
-                    showMatchingChildLayouts[deviceName] = EditorGUILayout.Foldout(showLayout, $"{deviceName} > {controlName}");
-                }
-                else
-                {
-                    EditorGUILayout.LabelField($"{deviceName} > {controlName}");
-                }
-
-                showLayout |= isRoot;
-
-                if (showLayout)
-                {
-                    foreach (var childLayout in matchedChildLayouts)
-                    {
-                        DrawMatchingControlPathsForLayout(childLayout, in parsedPath);
-                    }
-                }
-                EditorGUI.indentLevel--;
+                EditorGUILayout.EndVertical();
             }
-
-            return matchExists;
         }
 
         /// <summary>

Packages/com.unity.inputsystem/InputSystem/Editor/UITKAssetEditor/Resources/InputActionsEditorStyles.uss

@@ -199,3 +199,17 @@
 .unity-two-pane-split-view__dragline-anchor {
     background-color: rgb(25, 25, 25);
 }
+
+#control-scheme-usage-title {
+    margin: 3px;
+    -unity-font-style: bold;
+}
+
+.matching-controls {
+    display: flex;
+    flex-grow: 1;
+}
+
+.matching-controls-labels {
+    margin: 1px;
+}

Packages/com.unity.inputsystem/InputSystem/Editor/UITKAssetEditor/Views/BindingPropertiesView.cs

@@ -2,6 +2,9 @@
 using System.Linq;
 using UnityEditor;
 using UnityEngine.UIElements;
+using UnityEngine.InputSystem.Layouts;
+using UnityEngine.InputSystem.Utilities;
+using System.Collections.Generic;
 
 namespace UnityEngine.InputSystem.Editor
 {
@@ -50,6 +53,7 @@ public override void RedrawUI(ViewState viewState)
             else if (binding.Value.isPartOfComposite)
             {
                 m_CompositePartBindingPropertiesView = CreateChildView(new CompositePartBindingPropertiesView(rootElement, stateContainer));
+                DrawMatchingControlPaths(viewState);
                 DrawControlSchemeToggles(viewState, binding.Value);
             }
             else
@@ -64,10 +68,77 @@ public override void RedrawUI(ViewState viewState)
                 var controlPathContainer = new IMGUIContainer(controlPathEditor.OnGUI);
                 rootElement.Add(controlPathContainer);
 
+                DrawMatchingControlPaths(viewState);
                 DrawControlSchemeToggles(viewState, binding.Value);
             }
         }
 
+        static bool s_showMatchingLayouts = false;
+        internal void DrawMatchingControlPaths(ViewState viewState)
+        {
+            bool controlPathUsagePresent = false;
+            bool showPaths = s_showMatchingLayouts;
+            List<MatchingControlPath> matchingControlPaths = MatchingControlPath.CollectMatchingControlPaths(viewState.selectedBindingPath.stringValue, showPaths, ref controlPathUsagePresent);
+
+            var parentElement = rootElement;
+            if (matchingControlPaths == null || matchingControlPaths.Count != 0)
+            {
+                var controllingElement = new Foldout()
+                {
+                    text = $"Show Derived Bindings",
+                    value = showPaths
+                };
+                rootElement.Add(controllingElement);
+
+                controllingElement.RegisterValueChangedCallback(changeEvent =>
+                {
+                    if (changeEvent.target == controllingElement)   // only react to foldout and not tree elements
+                        s_showMatchingLayouts = changeEvent.newValue;
+                });
+
+                parentElement = controllingElement;
+            }
+
+            if (matchingControlPaths == null)
+            {
+                var messageString = controlPathUsagePresent ? "No registered controls match this current binding. Some controls are only registered at runtime." :
+                    "No other registered controls match this current binding. Some controls are only registered at runtime.";
+
+                var helpBox = new HelpBox(messageString, HelpBoxMessageType.Warning);
+                helpBox.AddToClassList("matching-controls");
+                parentElement.Add(helpBox);
+            }
+            else if (matchingControlPaths.Count > 0)
+            {
+                List<TreeViewItemData<MatchingControlPath>> treeViewMatchingControlPaths = MatchingControlPath.BuildMatchingControlPathsTreeData(matchingControlPaths);
+
+                var treeView = new TreeView();
+                parentElement.Add(treeView);
+                treeView.selectionType = UIElements.SelectionType.None;
+                treeView.AddToClassList("matching-controls");
+                treeView.fixedItemHeight = 20;
+                treeView.SetRootItems(treeViewMatchingControlPaths);
+
+                // Set TreeView.makeItem to initialize each node in the tree.
+                treeView.makeItem = () =>
+                {
+                    var label = new Label();
+                    label.AddToClassList("matching-controls-labels");
+                    return label;
+                };
+
+                // Set TreeView.bindItem to bind an initialized node to a data item.
+                treeView.bindItem = (VisualElement element, int index) =>
+                {
+                    var label = (element as Label);
+                    var matchingControlPath = treeView.GetItemDataForIndex<MatchingControlPath>(index);
+                    label.text = $"{matchingControlPath.deviceName} > {matchingControlPath.controlName}";
+                };
+
+                treeView.ExpandRootItems();
+            }
+        }
+
         public override void DestroyView()
         {
             m_CompositeBindingPropertiesView?.DestroyView();
@@ -78,7 +149,11 @@ private void DrawControlSchemeToggles(ViewState viewState, SerializedInputBindin
         {
             if (!viewState.controlSchemes.Any()) return;
 
-            var useInControlSchemeLabel = new Label("Use in control scheme");
+            var useInControlSchemeLabel = new Label("Use in control scheme")
+            {
+                name = "control-scheme-usage-title"
+            };
+
             rootElement.Add(useInControlSchemeLabel);
 
             foreach (var controlScheme in viewState.controlSchemes)