Skip to content

FIX: Pen touch input triggers UI/Click action two times (ISXB-1456) #2201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

jfreire-unity
Copy link
Collaborator

Description

Please fill this section with a description what the pull request is trying to address and what changes were made.

Testing status & QA

Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.

Overall Product Risks

Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.

  • Complexity:
  • Halo Effect:

Comments to reviewers

Please describe any additional information such as what to focus on, or historical info for the reviewers.

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.

@codecov-github-com
Copy link

codecov-github-com bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2201      +/-   ##
===========================================
- Coverage    68.10%   68.10%   -0.01%     
===========================================
  Files          367      367              
  Lines        53610    53601       -9     
===========================================
- Hits         36513    36504       -9     
  Misses       17097    17097              
Flag Coverage Δ
mac_2021.3_pkg 5.40% <0.00%> (+<0.01%) ⬆️
mac_2021.3_project 70.36% <100.00%> (-0.01%) ⬇️
mac_2022.3_pkg 5.18% <ø> (ø)
mac_2022.3_project 65.23% <100.00%> (-0.01%) ⬇️
mac_6000.0_pkg 5.19% <ø> (ø)
mac_6000.0_project 68.02% <100.00%> (-0.01%) ⬇️
mac_6000.1_pkg 5.19% <ø> (ø)
mac_6000.1_project 68.02% <100.00%> (-0.02%) ⬇️
mac_6000.2_pkg 5.19% <ø> (ø)
mac_6000.2_project 68.02% <100.00%> (-0.01%) ⬇️
mac_trunk_pkg 5.19% <ø> (ø)
mac_trunk_project 67.80% <100.00%> (-0.01%) ⬇️
win_2021.3_pkg 5.41% <0.00%> (+<0.01%) ⬆️
win_2021.3_project 70.44% <100.00%> (-0.01%) ⬇️
win_2022.3_pkg 5.18% <ø> (ø)
win_2022.3_project 65.30% <100.00%> (-0.01%) ⬇️
win_6000.0_pkg 5.19% <ø> (ø)
win_6000.0_project 68.10% <100.00%> (-0.01%) ⬇️
win_6000.1_pkg 5.19% <ø> (ø)
win_6000.1_project 68.10% <100.00%> (-0.01%) ⬇️
win_6000.2_pkg 5.19% <ø> (ø)
win_6000.2_project 68.10% <100.00%> (+<0.01%) ⬆️
win_trunk_pkg 5.19% <ø> (ø)
win_trunk_project 68.09% <100.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...InputSystem/Plugins/UI/InputSystemUIInputModule.cs 93.11% <100.00%> (-0.06%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jfreire-unity jfreire-unity requested a review from Copilot July 11, 2025 13:34
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses an issue where pen/touch input could generate duplicate UI/click actions by simplifying pointer cleanup logic and enhancing the UI pointer integration tests.

  • Removed special-case handling that delayed touch-pointer removal by one frame
  • Simplified FilterPointerStatesByType to only remove non–mouse/pen pointers
  • Expanded UI tests to cover simultaneous mouse and touch input and ensure single-click behavior

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs Commented out touch-delay block and changed pointer-filter condition
Assets/Tests/InputSystem/Plugins/UITests.cs Added new test scenario for concurrent mouse and touch clicks
Comments suppressed due to low confidence (2)

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs:2365

  • This simplified condition now removes touch pointers immediately, which may contradict the intended one-frame delay for touch cleanup. Verify that touch removal timing still matches expected input behavior and adjust the condition to retain touch pointers when needed.
                        if (m_PointerStates[i].pointerType != UIPointerType.MouseOrPen)

Assets/Tests/InputSystem/Plugins/UITests.cs:1464

  • The test calls EndTouch on ID 1, but no touch with ID 1 was started here. This mismatch may prevent proper cleanup of the previous touch and lead to false positives. Ensure EndTouch uses the same touch ID as the corresponding BeginTouch.
        EndTouch(1, secondPosition, screen: touch1);

Comment on lines +2075 to +2081
// // We don't want to release touch pointers on the same frame they are released (unpressed). They get cleaned up one frame later in Process()
// ref var state = ref GetPointerStateForIndex(index);
// if (state.pointerType == UIPointerType.Touch && (state.leftButton.isPressed || state.leftButton.wasReleasedThisFrame))
// {
// // The pointer was not removed
// return false;
// }
Copy link
Preview

Copilot AI Jul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The double-commented block clutters the cleanup logic. Consider removing these dead code lines or extracting them behind a clearly named feature flag to improve readability.

Suggested change
// // We don't want to release touch pointers on the same frame they are released (unpressed). They get cleaned up one frame later in Process()
// ref var state = ref GetPointerStateForIndex(index);
// if (state.pointerType == UIPointerType.Touch && (state.leftButton.isPressed || state.leftButton.wasReleasedThisFrame))
// {
// // The pointer was not removed
// return false;
// }
// Removed dead code block for clarity and readability.

Copilot uses AI. Check for mistakes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be removed, it's just to help with testing at the moment.

@jfreire-unity jfreire-unity force-pushed the isxb-1456-fix-pen-touch-double-ui-clicks branch from fb31fe7 to 96b6291 Compare July 11, 2025 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy