FIX: ISXB-808 scroll wheel event system different than ui builder (#1959)

benoitalain · duckets · web-flow · commit 230cfd669445 · 2024-07-17T16:56:59.000-04:00
* Fixed ISXB-766, ISXB-808, ISXB-704, conditional to trunk PR #49932. * Updated for latest trunk PR changes (5f81a20). * Reverted fix for ISXB-808 and partly ISXB-766. Kept ISBX-704 fix. * Added scroll wheel normalization tests for UI and InputForUI. * Recommended changes from @ekcoh. Added more #if UNITY_6000_0_OR_NEWER. * Added missing #if UNITY_6000_0_OR_NEWER in InputForUITests * Added changes to CHANGELOG.md * Override BaseInputModule.scrollWheelDeltaPerTick to 6 for InputSystem. * Improved Scroll Wheel Delta UI tooltip text * Improved API docs for ScrollDeltaBehavior * fixed bad xml tag * Replaced UNITY_6000_0_OR_NEWER by asmdef versionDefines >= 6000.0.9 * Added InputSystemUIInputModule.scrollDeltaPerTick for more flexibility. * Fixed missed #if replacement in UITests. * formatting * Fixed UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA unity version in asmdef. * Added changelog entry for new InputSystemUIInputModule.scrollDeltaPerTick. * Added changelog entry for ISXB-766 fix. * Added safety against division by 0 for scrollDeltaPerTick. Added test. * formatting * Recommended change from @Joao-Freire. Adjust minimal delta per tick. * Fixed compile error in InputSystemProvider when not on >= 6000.0.11f1. * Improved docs for scrollDeltaPerTick * fixed typo * formatting * Moved fixes in changelog to match [Unreleased] tag * Bump version to 1.10.0 * Fixed Editor_HelpUrlsPointToCurrentVersion --------- Co-authored-by: Ben Pitt <benp@unity3d.com>
diff --git a/Assets/Samples/InGameHints/InGameHintsActions.cs b/Assets/Samples/InGameHints/InGameHintsActions.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from Assets/Samples/InGameHints/InGameHintsActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Assets/Samples/SimpleDemo/SimpleControls.cs b/Assets/Samples/SimpleDemo/SimpleControls.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from Assets/Samples/SimpleDemo/SimpleControls.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Assets/Tests/InputSystem/InputActionCodeGeneratorActions.cs b/Assets/Tests/InputSystem/InputActionCodeGeneratorActions.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from Assets/Tests/InputSystem/InputActionCodeGeneratorActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Assets/Tests/InputSystem/Plugins/UITests.cs b/Assets/Tests/InputSystem/Plugins/UITests.cs
@@ -1037,7 +1037,7 @@ public IEnumerator UI_CanDriveUIFromPointer(string deviceLayout, UIPointerType p
             Assert.That(scene.rightChildReceiver.events[0].pointerData.pointerId, Is.EqualTo(pointerId));
             Assert.That(scene.rightChildReceiver.events[0].pointerData.position, Is.EqualTo(thirdScreenPosition).Using(Vector2EqualityComparer.Instance));
             Assert.That(scene.rightChildReceiver.events[0].pointerData.delta, Is.EqualTo(Vector2.zero));
-            Assert.That(scene.rightChildReceiver.events[0].pointerData.scrollDelta, Is.EqualTo(Vector2.one).Using(Vector2EqualityComparer.Instance));
+            Assert.That(scene.rightChildReceiver.events[0].pointerData.scrollDelta, Is.EqualTo(Vector2.one * scene.uiModule.scrollDeltaPerTick).Using(Vector2EqualityComparer.Instance));
             Assert.That(scene.rightChildReceiver.events[0].pointerData.pointerEnter, Is.SameAs(scene.rightGameObject));
             Assert.That(scene.rightChildReceiver.events[0].pointerData.pointerDrag, Is.Null);
             Assert.That(scene.rightChildReceiver.events[0].pointerData.pointerPress, Is.Null);
@@ -1201,16 +1201,40 @@ public IEnumerator UI_ReceivesNormalizedScrollWheelDelta(float scrollWheelDeltaP
         Set(mouse.scroll, new Vector2(0, scrollWheelDeltaPerTick));
         yield return null;
 
-        // UI should receive scroll delta in the [-1, 1] range.
+        // UI should receive scroll delta in the range defined by InputSystemUIInputModule.
         Assert.That(scene.leftChildReceiver.events,
             EventSequence(
                 OneEvent("type", EventType.Scroll),
                 AllEvents("position", scene.From640x480ToScreen(100, 100)),
-                AllEvents("scrollDelta", Vector2.up)
+                AllEvents("scrollDelta", Vector2.up * scene.uiModule.scrollDeltaPerTick)
             )
         );
     }
 
+#endif
+
+#if UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA
+    [TestCase(1)]
+    [TestCase(2)]
+    [Category("UI")]
+    public void UI_ConvertPointerEventScrollDeltaToTicks_AppliesScrollWheelMultiplier(float multiplier)
+    {
+        var scene = CreateTestUI();
+        scene.uiModule.scrollDeltaPerTick = multiplier;
+        var ticks = scene.uiModule.ConvertPointerEventScrollDeltaToTicks(Vector2.one);
+        Assert.That(ticks, Is.EqualTo(Vector2.one / multiplier).Within(0.001f));
+    }
+
+    [TestCase(0)]
+    [TestCase(1)]
+    [Category("UI")]
+    public void UI_ConvertPointerEventScrollDeltaToTicks_ReturnsZeroIfScrollDeltaPerTickIsZero(float delta)
+    {
+        var scene = CreateTestUI();
+        scene.uiModule.scrollDeltaPerTick = 0;
+        Assert.That(scene.uiModule.ConvertPointerEventScrollDeltaToTicks(Vector2.one * delta), Is.EqualTo(Vector2.zero));
+    }
+
 #endif
 
     [UnityTest]
diff --git a/Assets/Tests/InputSystem/Unity.InputSystem.Tests.asmdef b/Assets/Tests/InputSystem/Unity.InputSystem.Tests.asmdef
@@ -50,6 +50,11 @@
             "name": "Unity",
             "expression": "6000.0.9",
             "define": "UNITY_INPUT_SYSTEM_PLATFORM_SCROLL_DELTA"
+        },
+        {
+            "name": "Unity",
+            "expression": "6000.0.11",
+            "define": "UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA"
         }
     ],
     "noEngineReferences": false
diff --git a/Packages/com.unity.inputsystem/CHANGELOG.md b/Packages/com.unity.inputsystem/CHANGELOG.md
@@ -10,6 +10,12 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Fixed
+- Fixed default scroll speed in uGUI being slower than before. [ISXB-766](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-766)
+
+### Added
+- Added `InputSystemUIInputModule.scrollDeltaPerTick` property, a customizable multiplicative factor applied to the scroll wheel speed before it is sent to UI components. Note that this has no effect on UI Toolkit content, only uGUI.
+
 ## [1.9.0] - 2024-07-15
 
 ### Changed
@@ -40,16 +46,13 @@ however, it has to be formatted properly to pass verification tests.
 - Fixed deletion of last composite part raising an exception. [ISXB-804](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-804)
 - Fixed an issue related to Visualizers sample where exceptions would be thrown by InputActionVisualizer and InputControlVisualizer when entering play-mode if added as components to a new `GameObject`.
 - Fixed an issue with InputAction Asset editor where invalid ControlScheme names with only spaces could be entered. [ISXB-547](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-547).
+- Fixed deletion of last composite part raising an exception. [ISXB-804](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-804)
 
 ### Added
 - Added additional device information when logging the error due to exceeding the maximum number of events processed
   set by `InputSystem.settings.maxEventsBytesPerUpdate`. This additional information is available in development builds
   only.
-- Fixed deletion of last composite part raising an exception. [ISXB-804](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-804)
 - Expanded editor and build insight analytics to cover ``.inputactions` asset editor usage, `InputSettings` and common component configurations.
-
-### Changed
-- Changed `DualSenseHIDInputReport` from internal to public visibility
 - Added Input Setting option allowing to keep platform-specific scroll wheel input values instead of automatically converting them to a normalized range.
 
 ## [1.8.2] - 2024-04-29
diff --git a/Packages/com.unity.inputsystem/InputSystem/AssemblyInfo.cs b/Packages/com.unity.inputsystem/InputSystem/AssemblyInfo.cs
@@ -16,7 +16,7 @@ public static partial class InputSystem
         // Keep this in sync with "Packages/com.unity.inputsystem/package.json".
         // NOTE: Unfortunately, System.Version doesn't use semantic versioning so we can't include
         //       "-preview" suffixes here.
-        internal const string kAssemblyVersion = "1.9.1";
-        internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.9";
+        internal const string kAssemblyVersion = "1.10.0";
+        internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.10";
     }
 }
diff --git a/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastKeyboard.cs b/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastKeyboard.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputLayoutCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from "Keyboard" layout
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastMouse.cs b/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastMouse.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputLayoutCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from "Mouse" layout
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastTouchscreen.cs b/Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastTouchscreen.cs
@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputLayoutCodeGenerator
-//     version 1.9.1
+//     version 1.10.0
 //     from "Touchscreen" layout
 //
 //     Changes to this file may cause incorrect behavior and will be lost if
diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/InputForUI/InputSystemProvider.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/InputForUI/InputSystemProvider.cs
@@ -45,7 +45,11 @@ internal class InputSystemProvider : IEventProviderImpl
         NavigationEventRepeatHelper m_RepeatHelper = new();
         bool m_ResetSeenEventsOnUpdate;
 
+#if UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA
+        const float kScrollUGUIScaleFactor = UIElements.WheelEvent.scrollDeltaPerTick;
+#else
         const float kScrollUGUIScaleFactor = 3.0f;
+#endif
 
         static Action<InputActionAsset> s_OnRegisterActions;
 
diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs
@@ -116,6 +116,24 @@ internal GameObject localMultiPlayerRoot
             set => m_LocalMultiPlayerRoot = value;
         }
 
+        /// <summary>
+        /// A multiplier value that allows you to adjust the scroll wheel speed sent to uGUI (Unity UI) components.
+        /// </summary>
+        /// <remarks>
+        /// This value controls the magnitude of the PointerEventData.scrollDelta value, when the scroll wheel is rotated one tick. It acts as a multiplier, so a value of 1 passes through the original value and behaves the same as the legacy Standalone Input Module.
+        ///
+        /// A value larger than one increases the scrolling speed per tick, and a value less than one decreases the speed.
+        ///
+        /// You can set this to a negative value to invert the scroll direction. A value of zero prevents mousewheel scrolling from working at all.
+        ///
+        /// Note: this has no effect on UI Toolkit content, only uGUI components.
+        /// </remarks>
+        public float scrollDeltaPerTick
+        {
+            get => m_ScrollDeltaPerTick;
+            set => m_ScrollDeltaPerTick = value;
+        }
+
         /// <summary>
         /// Called by <c>EventSystem</c> when the input module is made current.
         /// </summary>
@@ -2070,10 +2088,10 @@ private void OnScrollCallback(InputAction.CallbackContext context)
 
             ref var state = ref GetPointerStateForIndex(index);
 
-            state.scrollDelta = context.ReadValue<Vector2>();
+            var scrollDelta = context.ReadValue<Vector2>();
 
             // ISXB-704: convert input value to BaseInputModule convention.
-            state.scrollDelta *= (1.0f / InputSystem.scrollWheelDeltaPerTick);
+            state.scrollDelta = (scrollDelta / InputSystem.scrollWheelDeltaPerTick) * scrollDeltaPerTick;
 
 #if UNITY_2022_3_OR_NEWER
             state.eventData.displayIndex = GetDisplayIndexFor(context.control);
@@ -2217,6 +2235,18 @@ public override int ConvertUIToolkitPointerId(PointerEventData sourcePointerData
                 : base.ConvertUIToolkitPointerId(sourcePointerData);
         }
 
+#endif
+
+#if UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA
+        const float kSmallestScrollDeltaPerTick = 0.00001f;
+        public override Vector2 ConvertPointerEventScrollDeltaToTicks(Vector2 scrollDelta)
+        {
+            if (Mathf.Abs(scrollDeltaPerTick) < kSmallestScrollDeltaPerTick)
+                return Vector2.zero;
+
+            return scrollDelta / scrollDeltaPerTick;
+        }
+
 #endif
 
         private void HookActions()
@@ -2352,6 +2382,10 @@ public InputActionAsset actionsAsset
         [SerializeField] private UIPointerBehavior m_PointerBehavior = UIPointerBehavior.SingleMouseOrPenButMultiTouchAndTrack;
         [SerializeField, HideInInspector] internal CursorLockBehavior m_CursorLockBehavior = CursorLockBehavior.OutsideScreen;
 
+        // See ISXB-766 for a history of where the 6.0f value comes from
+        // (we used to have 120 per tick on Windows and divided it by 20.)
+        [SerializeField] private float m_ScrollDeltaPerTick = 6.0f;
+
         private static Dictionary<InputAction, InputActionReferenceState> s_InputActionReferenceCounts = new Dictionary<InputAction, InputActionReferenceState>();
 
         private struct InputActionReferenceState
diff --git a/Packages/com.unity.inputsystem/InputSystem/Unity.InputSystem.asmdef b/Packages/com.unity.inputsystem/InputSystem/Unity.InputSystem.asmdef
@@ -86,6 +86,11 @@
             "name": "Unity",
             "expression": "6000.0.9",
             "define": "UNITY_INPUT_SYSTEM_PLATFORM_SCROLL_DELTA"
+        },
+        {
+            "name": "Unity",
+            "expression": "6000.0.11",
+            "define": "UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA"
         }
     ],
     "noEngineReferences": false
diff --git a/Packages/com.unity.inputsystem/Tests/TestFixture/AssemblyInfo.cs b/Packages/com.unity.inputsystem/Tests/TestFixture/AssemblyInfo.cs
@@ -4,7 +4,7 @@
 // Keep this in sync with "Packages/com.unity.inputsystem/package.json".
 // NOTE: Unfortunately, System.Version doesn't use semantic versioning so we can't include
 //       "-preview" suffixes here.
-[assembly: AssemblyVersion("1.9.1")]
+[assembly: AssemblyVersion("1.10.0")]
 [assembly: InternalsVisibleTo("Unity.InputSystem.Tests.Editor")]
 [assembly: InternalsVisibleTo("Unity.InputSystem.Tests")]
 [assembly: InternalsVisibleTo("Unity.InputSystem.IntegrationTests")]
diff --git a/Packages/com.unity.inputsystem/package.json b/Packages/com.unity.inputsystem/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "com.unity.inputsystem",
 	"displayName": "Input System",
-	"version": "1.9.1",
+	"version": "1.10.0",
 	"unity": "2019.4",
 	"description": "A new input system which can be used as a more extensible and customizable alternative to Unity's classic input system in UnityEngine.Input.",
 	"keywords": [

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public static partial class InputSystem`
`16`	`16`	`// Keep this in sync with "Packages/com.unity.inputsystem/package.json".`
`17`	`17`	`// NOTE: Unfortunately, System.Version doesn't use semantic versioning so we can't include`
`18`	`18`	`// "-preview" suffixes here.`
`19`		`- internal const string kAssemblyVersion = "1.9.1";`
`20`		`- internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.9";`
	`19`	`+ internal const string kAssemblyVersion = "1.10.0";`
	`20`	`+ internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.10";`
`21`	`21`	`}`
`22`	`22`	`}`