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

benoitalain · 2024-07-03T20:48:31Z

Description

Fixes ISXB-808. Based on recently landed trunk PR.

Details of what was changed and the thought process can be found in these Google Documents:

Changes made

This PR makes scroll delta values reaching UI Toolkit as uniform as possible between different platforms and between editor or runtime. The standard used is that of the Windows Editor, i.e. the same text in an TextField should scroll by the same amount in an EditorWindow than in a runtime panel, with or without uGUI interoperability.

Since legacy input is still supported in Unity 6, we make the InputSystem match the scaling of the legacy input by default. However, we also introduce a new scrollDeltaPerTick property API to allow users to fall back on the scroll factor that we had in InputSystem package version <= 1.4, by setting it to a value of 6.

Testing

Manually tested the changes. Modified existing unit test and added one for the newly introduced API.

Risk

This PR yet again changes the scroll factor for existing user projects without any notification about it. Fortunately, they can very easily tweak it back to whatever they had, but this may still come as a surprise to them. On the other hand, the new setup is much much better for new projects, and for existing projects it's probably better too, allowing users to remove their workaround for the previously bad scroll factors.

Checklist

Before review:

Changelog entry added.
- Explains the change in Changed, Fixed, Added sections.
- For API change contains an example snippet and/or migration example.
- JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
- Jira port for the next release set as "Resolved".
Tests added/changed, if applicable.
- Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
- Performance tests.
- Integration tests.
Docs for new/changed API's.
- Xmldoc cross references are set correctly.
- Added explanation how the API works.
- Usage code examples added.
- The manual is updated, if needed.

During merge:

Commit message for squash-merge is prefixed with one of the list:
- NEW: ___.
- FIX: ___.
- DOCS: ___.
- CHANGE: ___.
- RELEASE: 1.1.0-preview.3.

After merge:

Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

…08-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md # Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

…om:Unity-Technologies/InputSystem into isxb-704-scrollwheelwindowsrawvaluesupport # Conflicts: # Packages/com.unity.inputsystem/InputSystem/Editor/Settings/InputSettingsProvider.cs

…08-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md # Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

…08-scrollwheeleventsystemdifferentthanuibuilder

unity-cla-assistant · 2024-07-03T20:48:36Z

All committers have signed the CLA.

…nto isxb-808-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Assets/Tests/InputSystem/Plugins/UITests.cs # Assets/Tests/InputSystem/Unity.InputSystem.Tests.asmdef # Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs # Packages/com.unity.inputsystem/InputSystem/Unity.InputSystem.asmdef

…smdef.

…Tick.

…nto isxb-808-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md

…hanuibuilder

…of github.com:Unity-Technologies/InputSystem into isxb-808-scrollwheeleventsystemdifferentthanuibuilder

benoitalain · 2024-07-17T15:37:39Z

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 adjust the scroll wheel speed sent to uGUI (Unity UI) components.


that allows you adjust

that allows you to adjust

duckets

Approved with docs amendments

benoitalain and others added 22 commits June 5, 2024 11:35

Fixed ISXB-766, ISXB-808, ISXB-704, conditional to trunk PR #49932.

30b1383

Updated for latest trunk PR changes (5f81a20).

a9f9001

Reverted fix for ISXB-808 and partly ISXB-766. Kept ISBX-704 fix.

3f6fb44

Added scroll wheel normalization tests for UI and InputForUI.

a9df122

Recommended changes from @ekcoh. Added more #if UNITY_6000_0_OR_NEWER.

8bb47fd

Added missing #if UNITY_6000_0_OR_NEWER in InputForUITests

3bb8c4a

Added changes to CHANGELOG.md

8d81713

Merge branch 'develop' into isxb-704-scrollwheelwindowsrawvaluesupport

0084249

Override BaseInputModule.scrollWheelDeltaPerTick to 6 for InputSystem.

64b7e18

Improved Scroll Wheel Delta UI tooltip text

4c2f553

Improved API docs for ScrollDeltaBehavior

a824b02

fixed bad xml tag

0ff0f79

Merge branch 'isxb-704-scrollwheelwindowsrawvaluesupport' into isxb-8…

b7d26ea

…08-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md # Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

Replaced UNITY_6000_0_OR_NEWER by asmdef versionDefines >= 6000.0.9

8251776

Merge branch 'isxb-704-scrollwheelwindowsrawvaluesupport' of github.c…

40a5cbc

…om:Unity-Technologies/InputSystem into isxb-704-scrollwheelwindowsrawvaluesupport # Conflicts: # Packages/com.unity.inputsystem/InputSystem/Editor/Settings/InputSettingsProvider.cs

Merge branch 'isxb-704-scrollwheelwindowsrawvaluesupport' into isxb-8…

0e529ec

…08-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md # Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

Merge branch 'develop' into isxb-704-scrollwheelwindowsrawvaluesupport

b66e70c

Added InputSystemUIInputModule.scrollDeltaPerTick for more flexibility.

319bca7

Fixed missed #if replacement in UITests.

cf9452e

Merge branch 'isxb-704-scrollwheelwindowsrawvaluesupport' into isxb-8…

f161ed2

…08-scrollwheeleventsystemdifferentthanuibuilder

formatting

7d83c63

Merge branch 'isxb-704-scrollwheelwindowsrawvaluesupport' into isxb-8…

86c2419

…08-scrollwheeleventsystemdifferentthanuibuilder

benoitalain added 4 commits July 4, 2024 11:08

Fixed UNITY_INPUT_SYSTEM_INPUT_MODULE_SCROLL_DELTA unity version in a…

0c0496c

…smdef.

Added changelog entry for new InputSystemUIInputModule.scrollDeltaPer…

9916c37

…Tick.

Added changelog entry for ISXB-766 fix.

22aa831

benoitalain requested review from jfreire-unity and duckets July 10, 2024 14:27

Added safety against division by 0 for scrollDeltaPerTick. Added test.

b7e5c3f

benoitalain added 2 commits July 16, 2024 08:18

formatting

8efab6b

Merge branch 'develop' of github.com:Unity-Technologies/InputSystem i…

26a3c6d

…nto isxb-808-scrollwheeleventsystemdifferentthanuibuilder # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md

benoitalain changed the title ~~Isxb 808 scrollwheeleventsystemdifferentthanuibuilder~~ FIX: ISXB-808 scroll wheel event system different than ui builder Jul 16, 2024

jfreire-unity approved these changes Jul 16, 2024

View reviewed changes

benoitalain and others added 5 commits July 16, 2024 09:11

Recommended change from @Joao-Freire. Adjust minimal delta per tick.

b26550a

Fixed compile error in InputSystemProvider when not on >= 6000.0.11f1.

3b37025

Merge branch 'develop' into isxb-808-scrollwheeleventsystemdifferentt…

fb48732

…hanuibuilder

Improved docs for scrollDeltaPerTick

3e441c1

Merge branch 'isxb-808-scrollwheeleventsystemdifferentthanuibuilder' …

74de0c9

…of github.com:Unity-Technologies/InputSystem into isxb-808-scrollwheeleventsystemdifferentthanuibuilder

benoitalain commented Jul 17, 2024

View reviewed changes

fixed typo

c4f63cd

duckets approved these changes Jul 17, 2024

View reviewed changes

benoitalain added 3 commits July 17, 2024 12:42

formatting

29878d8

Moved fixes in changelog to match [Unreleased] tag

3781e91

Bump version to 1.10.0

9d54366

benoitalain force-pushed the isxb-808-scrollwheeleventsystemdifferentthanuibuilder branch from 68a9289 to 9d54366 Compare July 17, 2024 19:36

Fixed Editor_HelpUrlsPointToCurrentVersion

f185d72

benoitalain merged commit 230cfd6 into develop Jul 17, 2024
77 of 79 checks passed

benoitalain deleted the isxb-808-scrollwheeleventsystemdifferentthanuibuilder branch July 17, 2024 20:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

benoitalain commented Jul 3, 2024 •

edited

Loading

unity-cla-assistant commented Jul 3, 2024 •

edited

Loading

benoitalain Jul 17, 2024 •

edited

Loading

duckets left a comment

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

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

Conversation

benoitalain commented Jul 3, 2024 • edited Loading

Description

Changes made

Testing

Risk

Checklist

unity-cla-assistant commented Jul 3, 2024 • edited Loading

benoitalain Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

duckets left a comment

Choose a reason for hiding this comment

benoitalain commented Jul 3, 2024 •

edited

Loading

unity-cla-assistant commented Jul 3, 2024 •

edited

Loading

benoitalain Jul 17, 2024 •

edited

Loading