CHANGE: ISX-2377: Rebinding sample improvements (Mouse sensitivity + Swap sticks) (Validation week)

Assets/Samples/RebindingUI/ActionLabelEditor.cs

@@ -15,38 +15,17 @@
     {
         protected void OnEnable()
         {
-            m_ActionProperty = serializedObject.FindProperty("m_Action");
-            m_BindingIdProperty = serializedObject.FindProperty("m_BindingId");
             m_BindingTextProperty = serializedObject.FindProperty("m_BindingText");
-            m_DisplayStringOptionsProperty = serializedObject.FindProperty("m_DisplayStringOptions");
             m_UpdateBindingUIEventProperty = serializedObject.FindProperty("m_UpdateBindingUIEvent");
-
-            RefreshBindingOptions();
+            m_BindingUI = new BindingUI(serializedObject);
         }
 
         public override void OnInspectorGUI()
         {
             EditorGUI.BeginChangeCheck();
 
             // Binding section.
-            EditorGUILayout.LabelField(m_BindingLabel, Styles.boldLabel);
-            using (new EditorGUI.IndentLevelScope())
-            {
-                EditorGUILayout.PropertyField(m_ActionProperty);
-
-                var newSelectedBinding = EditorGUILayout.Popup(m_BindingLabel, m_SelectedBindingOption, m_BindingOptions);
-                if (newSelectedBinding != m_SelectedBindingOption)
-                {
-                    var bindingId = m_BindingOptionValues[newSelectedBinding];
-                    m_BindingIdProperty.stringValue = bindingId;
-                    m_SelectedBindingOption = newSelectedBinding;
-                }
-
-                var optionsOld = (InputBinding.DisplayStringOptions)m_DisplayStringOptionsProperty.intValue;
-                var optionsNew = (InputBinding.DisplayStringOptions)EditorGUILayout.EnumFlagsField(m_DisplayOptionsLabel, optionsOld);
-                if (optionsOld != optionsNew)
-                    m_DisplayStringOptionsProperty.intValue = (int)optionsNew;
-            }
+            m_BindingUI.Draw();
 
             // UI section.
             EditorGUILayout.Space();
@@ -67,91 +46,16 @@
             if (EditorGUI.EndChangeCheck())
             {
                 serializedObject.ApplyModifiedProperties();
-                RefreshBindingOptions();
-            }
-        }
-
-        protected void RefreshBindingOptions()
-        {
-            var actionReference = (InputActionReference)m_ActionProperty.objectReferenceValue;
-            var action = actionReference?.action;
-
-            if (action == null)
-            {
-                m_BindingOptions = new GUIContent[0];
-                m_BindingOptionValues = new string[0];
-                m_SelectedBindingOption = -1;
-                return;
-            }
-
-            var bindings = action.bindings;
-            var bindingCount = bindings.Count;
-
-            m_BindingOptions = new GUIContent[bindingCount];
-            m_BindingOptionValues = new string[bindingCount];
-            m_SelectedBindingOption = -1;
-
-            var currentBindingId = m_BindingIdProperty.stringValue;
-            for (var i = 0; i < bindingCount; ++i)
-            {
-                var binding = bindings[i];
-                var bindingId = binding.id.ToString();
-                var haveBindingGroups = !string.IsNullOrEmpty(binding.groups);
-
-                // If we don't have a binding groups (control schemes), show the device that if there are, for example,
-                // there are two bindings with the display string "A", the user can see that one is for the keyboard
-                // and the other for the gamepad.
-                var displayOptions =
-                    InputBinding.DisplayStringOptions.DontUseShortDisplayNames | InputBinding.DisplayStringOptions.IgnoreBindingOverrides;
-                if (!haveBindingGroups)
-                    displayOptions |= InputBinding.DisplayStringOptions.DontOmitDevice;
-
-                // Create display string.
-                var displayString = action.GetBindingDisplayString(i, displayOptions);
-
-                // If binding is part of a composite, include the part name.
-                if (binding.isPartOfComposite)
-                    displayString = $"{ObjectNames.NicifyVariableName(binding.name)}: {displayString}";
-
-                // Some composites use '/' as a separator. When used in popup, this will lead to to submenus. Prevent
-                // by instead using a backlash.
-                displayString = displayString.Replace('/', '\\');
-
-                // If the binding is part of control schemes, mention them.
-                if (haveBindingGroups)
-                {
-                    var asset = action.actionMap?.asset;
-                    if (asset != null)
-                    {
-                        var controlSchemes = string.Join(", ",
-                            binding.groups.Split(InputBinding.Separator)
-                                .Select(x => asset.controlSchemes.FirstOrDefault(c => c.bindingGroup == x).name));
-
-                        displayString = $"{displayString} ({controlSchemes})";
-                    }
-                }
-
-                m_BindingOptions[i] = new GUIContent(displayString);
-                m_BindingOptionValues[i] = bindingId;
-
-                if (currentBindingId == bindingId)
-                    m_SelectedBindingOption = i;
+                m_BindingUI.Refresh();
             }
         }
 
-        private SerializedProperty m_ActionProperty;
-        private SerializedProperty m_BindingIdProperty;
         private SerializedProperty m_BindingTextProperty;
         private SerializedProperty m_UpdateBindingUIEventProperty;
-        private SerializedProperty m_DisplayStringOptionsProperty;
 
-        private GUIContent m_BindingLabel = new GUIContent("Binding");
-        private GUIContent m_DisplayOptionsLabel = new GUIContent("Display Options");
         private GUIContent m_UILabel = new GUIContent("UI");
         private GUIContent m_EventsLabel = new GUIContent("Events");
-        private GUIContent[] m_BindingOptions;
-        private string[] m_BindingOptionValues;
-        private int m_SelectedBindingOption;
+        private BindingUI m_BindingUI;
 
         private static class Styles
         {

Assets/Samples/RebindingUI/Game/GameplayManager.cs

@@ -191,6 +191,9 @@
 
         private void Awake()
         {
+            // This game is designed for landscape orientation, so make sure we use it.
+            Screen.orientation = ScreenOrientation.LandscapeLeft;
+
             m_FeedbackController = GetComponent<FeedbackController>();
 
             m_EnemyPool = new ObjectPool<Enemy>(
@@ -256,7 +259,7 @@
             --m_EnemySpawnCount;
 
             // Rent an enemy from the enemy pool
-            var enemyComponent = m_EnemyPool.Get();
+            var enemyComponent = m_EnemyPool.Get(); // TODO Null reference here on domain reload
 
             // Make the enemy spawn on border of visible game area
             var orthoSize = gameCamera.orthographicSize;

Assets/Samples/RebindingUI/InputActionExtensions.cs

@@ -0,0 +1,24 @@
+using System;
+
+namespace UnityEngine.InputSystem.Samples.RebindUI
+{
+    /// <summary>
+    /// Extension methods to reduce code bloat of this example.
+    /// </summary>
+    public static class InputActionExtensions
+    {
+        /// <summary>
+        /// Attempts to find an action binding using its binding ID (GUID).
+        /// </summary>
+        /// <param name="action">The action instance, may be null.</param>
+        /// <param name="bindingId">The binding ID (GUID) represented by a string.</param>
+        /// <returns>Zero-based index of the binding or -1 if not found.</returns>
+        public static int FindBindingById(this InputAction action, string bindingId)
+        {
+            if (action == null || string.IsNullOrEmpty(bindingId))
+                return -1;
+            var id = new Guid(bindingId);
+            return action.bindings.IndexOf(x => x.id == id);
+        }
+    }
+}

Assets/Samples/RebindingUI/InputActionIndicator.cs

@@ -34,7 +34,9 @@
         private void OnEnable()
         {
             if (action != null && action.action != null)
-                action.action.performed += OnPerformed;
+            {
+                action.action.performed += OnPerformed; // TODO Problem here after domain reload, InputAction.addperformed(), CallbackArray.AddCallback,. InputArrayExtensions.Contains
+            }
         }
 
         private void OnDisable()

Assets/Samples/RebindingUI/README.md

@@ -1,10 +1,31 @@
-This sample demonstrates how to use the Input System APIs to set up a rebinding UI. The main file is [RebindActionUI](./RebindActionUI.cs) which, aside from serving as an example, contains a reusable `MonoBehaviour` component for composing rebinding UIs. The [RebindUIPrefab](./RebindUIPrefab.prefab) contains a ready-made prefab that can be used as a simple drop-in setup for rebinding an individual action.
+This sample demonstrates how to use the Input System APIs to set up a rebinding UI. The main file is 
+[RebindActionUI](./RebindActionUI.cs) which, aside from serving as an example, contains a reusable `MonoBehaviour` 
+component for composing rebinding UIs. The [RebindUIPrefab](./RebindUIPrefab.prefab) contains a ready-made prefab that 
+can be used as a simple drop-in setup for rebinding an individual action.
 
-To demonstrate how to use images instead of textual display strings, take a look at [GamepadIconsExample](./GamepadIconsExample.cs).
+To demonstrate how to use images instead of textual display strings, take a look at 
+[GamepadIconsExample](./GamepadIconsExample.cs).
 
-To demonstrate how to show dynamic texts based on input action bindings, see [ActionLabel](./ActionLabel.cs).
+To demonstrate how to show dynamic UI texts based on input action bindings, see [ActionLabel](./ActionLabel.cs).
 
- Finally, the [RebindSaveLoad](./RebindSaveLoad.cs) script demonstrates how to persist user rebinds in `PlayerPrefs` and how to restore them from there.
+[InputActionIndicator](./InputActionIndicator.cs) and [InputActionIndicator.prefab](./InputActionIndicator.prefab) 
+shows how to make a simple UI indicator that shows whether an associated input action is enabled, disabled or 
+performed. This behavior has been added to this sample to add observability of actions triggered within gameplay, 
+menu and rebind contexts.
 
- The icons used in the sample are taken from [Free Prompts Pack v4.0](https://opengameart.org/content/free-keyboard-and-controllers-prompts-pack) created by, and made available to public domain by Nicolae Berbece.
- Icons are licensed under [Creative Commons CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+The [RebindSaveLoad](./RebindSaveLoad.cs) script demonstrates how to persist user rebinds in `PlayerPrefs` and how 
+to restore them.
+
+In this sample, keyboard bindings for "Move" (default WASD) is rebound as a single composite. This means that 
+indivudual parts will get assigned one after the other. Another way of doing this is to set it up as four individual 
+button bindings and assign them individually as four partial bindings.
+
+In this sample it is possible to directly rebind gamepad sticks in the gamepad control scheme. In practice, you 
+probably don't want to set up rebinding the sticks like this but rather have a "swap sticks" kind of toggle instead. 
+In this sample we have both variants for demonstration purposes. See [RebindActionUI.SwapBinding](./RebindActionUI.cs) 
+for a method that swaps two bindings of similar type.
+
+The icons used in the sample are taken from 
+[Free Prompts Pack v4.0](https://opengameart.org/content/free-keyboard-and-controllers-prompts-pack) created by, 
+and made available to public domain by Nicolae Berbece. 
+Icons are licensed under [Creative Commons CC0](https://creativecommons.org/publicdomain/zero/1.0/).

Assets/Samples/RebindingUI/RebindActionEditor.cs

@@ -0,0 +1,146 @@
+#if UNITY_EDITOR
+
+using System;
+using System.Linq;
+using UnityEditor;
+
+namespace UnityEngine.InputSystem.Samples.RebindUI
+{
+    /// <summary>
+    /// Common binding UI helper to allow editor composition.
+    /// </summary>
+    internal class BindingUI
+    {
+        private readonly SerializedProperty m_ActionProperty;
+        private readonly SerializedProperty m_BindingIdProperty;
+        private readonly SerializedProperty m_DisplayStringOptionsProperty;
+
+        public BindingUI(SerializedObject serializedObject)
+            : this(serializedObject.FindProperty("m_Action"), serializedObject.FindProperty("m_BindingId"),
+            serializedObject.FindProperty("m_DisplayStringOptions"))
+        {}
+
+        public BindingUI(SerializedProperty actionProperty, SerializedProperty bindingIdProperty,
+                         SerializedProperty displayStringOptionsProperty = null)
+        {
+            m_ActionProperty = actionProperty;
+            m_BindingIdProperty = bindingIdProperty;
+            m_DisplayStringOptionsProperty = displayStringOptionsProperty;
+
+            Reset();
+            Refresh();
+        }
+
+        private void Reset()
+        {
+            bindingOptions = Array.Empty<GUIContent>();
+            bindingOptionValues = Array.Empty<string>();
+            selectedBindingIndex = -1;
+        }
+
+        public void Draw()
+        {
+            // Binding section.
+            EditorGUILayout.LabelField(m_BindingLabel);
+            using (new EditorGUI.IndentLevelScope())
+            {
+                EditorGUILayout.PropertyField(m_ActionProperty);
+
+                var newSelectedBinding = EditorGUILayout.Popup(m_BindingLabel, selectedBindingIndex, bindingOptions);
+                if (newSelectedBinding != selectedBindingIndex)
+                {
+                    var bindingId = bindingOptionValues[newSelectedBinding];
+                    m_BindingIdProperty.stringValue = bindingId;
+                    selectedBindingIndex = newSelectedBinding;
+                }
+
+                if (m_DisplayStringOptionsProperty != null)
+                {
+                    var optionsOld = (InputBinding.DisplayStringOptions)m_DisplayStringOptionsProperty.intValue;
+                    var optionsNew = (InputBinding.DisplayStringOptions)EditorGUILayout.EnumFlagsField(m_DisplayOptionsLabel, optionsOld);
+                    if (optionsOld != optionsNew)
+                        m_DisplayStringOptionsProperty.intValue = (int)optionsNew;
+                }
+            }
+        }
+
+        public bool Refresh()
+        {
+            if (action == null)
+            {
+                Reset();
+                return false;
+            }
+
+            var bindings = action.bindings;
+            var bindingCount = bindings.Count;
+
+            bindingOptions = new GUIContent[bindingCount];
+            bindingOptionValues = new string[bindingCount];
+            selectedBindingIndex = -1;
+
+            var currentBindingId = m_BindingIdProperty.stringValue;
+            for (var i = 0; i < bindingCount; ++i)
+            {
+                var binding = bindings[i];
+                var bindingId = binding.id.ToString();
+                var haveBindingGroups = !string.IsNullOrEmpty(binding.groups);
+
+                // If we don't have a binding groups (control schemes), show the device that if there are, for example,
+                // there are two bindings with the display string "A", the user can see that one is for the keyboard
+                // and the other for the gamepad.
+                var displayOptions =
+                    InputBinding.DisplayStringOptions.DontUseShortDisplayNames | InputBinding.DisplayStringOptions.IgnoreBindingOverrides;
+                if (!haveBindingGroups)
+                    displayOptions |= InputBinding.DisplayStringOptions.DontOmitDevice;
+
+                // Create display string.
+                var displayString = action.GetBindingDisplayString(i, displayOptions);
+
+                // If binding is part of a composite, include the part name.
+                if (binding.isPartOfComposite)
+                    displayString = $"{ObjectNames.NicifyVariableName(binding.name)}: {displayString}";
+
+                // Some composites use '/' as a separator. When used in popup, this will lead to to submenus. Prevent
+                // by instead using a backlash.
+                displayString = displayString.Replace('/', '\\');
+
+                // If the binding is part of control schemes, mention them.
+                if (haveBindingGroups)
+                {
+                    var asset = action.actionMap?.asset;
+                    if (asset != null)
+                    {
+                        var controlSchemes = string.Join(", ",
+                            binding.groups.Split(InputBinding.Separator)
+                                .Select(x => asset.controlSchemes.FirstOrDefault(c => c.bindingGroup == x).name));
+
+                        displayString = $"{displayString} ({controlSchemes})";
+                    }
+                }
+
+                bindingOptions[i] = new GUIContent(displayString);
+                bindingOptionValues[i] = bindingId;
+
+                if (currentBindingId == bindingId)
+                    selectedBindingIndex = i;
+            }
+
+            return true;
+        }
+
+        public string bindingId => m_BindingIdProperty.stringValue;
+        public int bindingIndex => action.FindBindingById(m_BindingIdProperty.stringValue);
+
+        public InputAction action => ((InputActionReference)m_ActionProperty.objectReferenceValue)?.action;
+
+        private GUIContent[] bindingOptions { get; set; }
+        private string[] bindingOptionValues { get; set; }
+        private int selectedBindingIndex { get; set; }
+
+        private readonly GUIContent m_BindingLabel = new GUIContent("Binding");
+        private readonly GUIContent m_DisplayOptionsLabel = new GUIContent("Display Options");
+    }
+}
+
+#endif // UNITY_EDITOR