feat: Support ContactRect in X11 and Windows platform #16498

lindexi · 2024-07-27T08:44:03Z

What does the pull request do?

Adding the touch size support, which know as ContactRect in X11 and Windows platform.

What is the current behavior?

Miss the touch size feature.

What is the updated/expected behavior with this PR?

We can get the touch size from X11 and Windows.

I test the Avalonia Windows version by my two demo, the TouchSizeAvalonia demo and the WinUI demo.

I use the same physics for touch, and I can get the same result from TouchSizeAvalonia demo and the WinUI demo. That means this PR can have the same implementation as WinUI. Here's a video I recorded on my phone:

7685EE57C31474648644D744B87A8AE0.mp4

How was the solution implemented (if it's not obvious)?

Checklist

Added unit tests (if possible)? I test pass with my demo
Added XML documentation to any related classes?
Consider submitting a PR to https://github.com/AvaloniaUI/avalonia-docs with user documentation

Breaking changes

Add the ContactRect property to PointerPointProperties and changed the argument list in the constructor of PointerPointProperties.

Obsoletions / Deprecations

Fixed issues

Reference: #1477

kekekeks · 2024-07-27T09:24:15Z

src/Avalonia.Base/Input/PointerPoint.cs

@@ -155,17 +160,18 @@ public PointerPointProperties(RawInputModifiers modifiers, PointerUpdateKind kin
        }

        public PointerPointProperties(RawInputModifiers modifiers, PointerUpdateKind kind,
-            float twist, float pressure, float xTilt, float yTilt
+            float twist, float pressure, float xTilt, float yTilt, Rect contactRect


Why do we need to extend the API? Can't relevant XI2 properties be converted to existing ones? How other platforms expose the same information? How browsers are handling that?

How is the same info exposed by UWP?

@kekekeks

Why do we need to extend the API?

As a touch application, the touch area is an indispensable parameter.

Can't relevant XI2 properties be converted to existing ones?

Sorry, I can not find any existing ones can be converted to.

How other platforms expose the same information?

It can be implemented in Windows platform, see https://learn.microsoft.com/en-us/windows-hardware/design/component-guidelines/touchscreen-required-hid-top-level-collections

How is the same info exposed by UWP?

See https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.ui.input.pointerpointproperties.contactrect?view=windows-app-sdk-1.5

And we can get this info from WM_Pointer.

Also, we can get the touch size in wpf by StylusPointProperties.Width and StylusPointProperties.Height

How other platforms expose the same information? How browsers are handling that?

I support the windows platform now. And I test my demo, and I find the behavior of Avalonia is same as WinUI and UWP.

src/Avalonia.Base/Input/PointerPoint.cs

kekekeks · 2024-07-27T09:37:26Z

Also, according to https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.ui.input.pointerpointproperties.contactrect?view=windows-app-sdk-1.5 the contact rect is supposed to be reported in DIPs

src/Avalonia.X11/XI2Manager.cs

AvaloniaUI/Avalonia#16498

maxkatz6 · 2024-08-09T08:41:31Z

src/Avalonia.Base/Input/Raw/RawPointerEventArgs.cs

+        /// <inheritdoc cref="PointerPointProperties.ContactRect" />
+        public Rect ContactRect
+        {
+            get => _contactRect ?? new Rect(Position, new Size());


it should be new Size(1,1) by default I believe

@maxkatz6 Sorry, I do not think so. I think the size should be zero here as the WinUI do.

src/Avalonia.Base/Input/PointerPoint.cs

…ange

lindexi · 2024-08-24T07:14:18Z

Thanks #16705

I can call the _platform.Screens.ScreenFromPoint.

avaloniaui-bot · 2024-08-24T07:27:53Z

You can test this PR using the following package version. 11.2.999-cibuild0051457-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

src/Windows/Avalonia.Win32/WindowImpl.AppWndProc.cs

avaloniaui-bot · 2024-08-24T09:09:07Z

You can test this PR using the following package version. 11.2.999-cibuild0051461-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-bot · 2024-08-26T02:42:34Z

You can test this PR using the following package version. 11.2.999-cibuild0051475-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-bot · 2024-08-26T07:05:47Z

You can test this PR using the following package version. 11.2.999-cibuild0051477-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

The XIValuatorClassInfo is struct, so the FirstOrDefault will return the default struct when not found.

avaloniaui-bot · 2024-09-10T03:53:02Z

You can test this PR using the following package version. 11.2.999-cibuild0051730-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

maxkatz6 · 2024-09-12T05:34:51Z

src/Windows/Avalonia.Win32/WindowImpl.AppWndProc.cs

@@ -436,14 +436,46 @@ protected virtual unsafe IntPtr AppWndProc(IntPtr hWnd, uint msg, IntPtr wParam,
                        {
                            foreach (var touchInput in touchInputs)
                            {
+                                var position = PointToClient(new PixelPoint(touchInput.X / 100, touchInput.Y / 100));


Feel free to drop WM_TOUCH handling for ContactRect, as it's not going to be used anywhere on modern devices. WM_POINTER is the main way we handle touch/pen input.

@maxkatz6 There is the other issues in avalonia, that the RegisterTouchWindow will be call event enable the WM_POINTER.

And the win7 system still use the WM_TOUCH now.

We don't support win7 at this point.

To clarify, we try to keep Avalonia compatible with Win7, but we don't go extra miles to support some specific features. And if some code is only used on Win7, we don't really need it, as it only adds maintenance cost.

maxkatz6

Aside from unnecessary WM_TOUCH handling, Windows implementation and API looks good to me.

maxkatz6 · 2024-10-06T21:25:32Z

Merging for 11.3 master branch. I will try to push more implementations over next months before 11.3 release.

lindexi · 2024-10-08T06:11:17Z

Thank you @maxkatz6

lindexi · 2024-10-21T02:36:29Z

src/Windows/Avalonia.Win32/WindowImpl.AppWndProc.cs

+
+                // Why not use ptPixelLocationX and ptPixelLocationY to as leftTopPosition?
+                // Because ptPixelLocationX and ptPixelLocationY will be the center of the contact area.
+                pointerPoint.ContactRect = new Rect(leftTopPosition, bottomRightPosition);


Addition: The behavior here is identical to that of WinUI 3, even when the DPI is not set to 100%.

* feat: Support ContactRect in X11 platform * Provide compat value for ContactRect property * Using touch position to get the screen. * Try get the correct screen * Remove the code of log. * Improve performance avoid the GC stress. * Add a second overload in PointerPointProperties to avoid break API change * Support touch size in WM_Touch * Support get ContactRect in WM_POINTER * Fix the coordinate of touch contact area * Fix the calcuate of WM_Touch contact area * Fix the X11 area contact * Fix the touch major and minor default value is not null. The XIValuatorClassInfo is struct, so the FirstOrDefault will return the default struct when not found.

kekekeks reviewed Jul 27, 2024

View reviewed changes

src/Avalonia.Base/Input/PointerPoint.cs Show resolved Hide resolved

kekekeks reviewed Jul 27, 2024

View reviewed changes

src/Avalonia.X11/XI2Manager.cs Outdated Show resolved Hide resolved

lindexi added a commit to lindexi/lindexi_gd that referenced this pull request Jul 27, 2024

Test touch size

4c5a4b0

AvaloniaUI/Avalonia#16498

lindexi added 6 commits July 30, 2024 16:46

feat: Support ContactRect in X11 platform

c15f9a1

Provide compat value for ContactRect property

5942d37

Using touch position to get the screen.

6ad31f4

Try get the correct screen

f62d790

Remove the code of log.

95c2ad8

Improve performance avoid the GC stress.

d050f20

lindexi force-pushed the t/lindexi/TouchMajor branch from 8fd3083 to d050f20 Compare July 30, 2024 08:46

maxkatz6 added enhancement feature os-linux labels Jul 30, 2024

maxkatz6 reviewed Aug 9, 2024

View reviewed changes

src/Avalonia.Base/Input/PointerPoint.cs Outdated Show resolved Hide resolved

lindexi added 2 commits August 24, 2024 15:00

Add a second overload in PointerPointProperties to avoid break API ch…

f772973

…ange

Merge remote-tracking branch 'origin/master' into t/lindexi/TouchMajor

29fe3c1

lindexi added 3 commits August 24, 2024 16:20

Support touch size in WM_Touch

eed1ecd

Support get ContactRect in WM_POINTER

0c29c8d

Fix the coordinate of touch contact area

6817142

lindexi changed the title ~~feat: Support ContactRect in X11 platform~~ feat: Support ContactRect in X11 and Windows platform Aug 24, 2024

lindexi commented Aug 24, 2024

View reviewed changes

src/Windows/Avalonia.Win32/WindowImpl.AppWndProc.cs Outdated Show resolved Hide resolved

Fix the calcuate of WM_Touch contact area

5eeb7df

Fix the X11 area contact

4c745d0

Fix the touch major and minor default value is not null.

75d6dbf

The XIValuatorClassInfo is struct, so the FirstOrDefault will return the default struct when not found.

maxkatz6 reviewed Sep 12, 2024

View reviewed changes

maxkatz6 approved these changes Sep 12, 2024

View reviewed changes

maxkatz6 enabled auto-merge October 6, 2024 21:25

maxkatz6 disabled auto-merge October 6, 2024 21:25

maxkatz6 merged commit 3532889 into AvaloniaUI:master Oct 6, 2024
8 of 10 checks passed

lindexi commented Oct 21, 2024

View reviewed changes

This was referenced Oct 22, 2024

Fix the known valuator do not update. #17321

Merged

Fix the known valuator do not update. dotnet-campus/Avalonia#3

Closed

Uh oh!

feat: Support ContactRect in X11 and Windows platform #16498

feat: Support ContactRect in X11 and Windows platform #16498

Uh oh!

Conversation

lindexi commented Jul 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does the pull request do?

What is the current behavior?

What is the updated/expected behavior with this PR?

How was the solution implemented (if it's not obvious)?

Checklist

Breaking changes

Obsoletions / Deprecations

Fixed issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kekekeks Jul 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lindexi Jul 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lindexi Aug 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kekekeks commented Jul 27, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lindexi commented Aug 24, 2024

Uh oh!

avaloniaui-bot commented Aug 24, 2024

Uh oh!

Uh oh!

avaloniaui-bot commented Aug 24, 2024

Uh oh!

avaloniaui-bot commented Aug 26, 2024

Uh oh!

avaloniaui-bot commented Aug 26, 2024

Uh oh!

avaloniaui-bot commented Sep 10, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maxkatz6 left a comment

Choose a reason for hiding this comment

Uh oh!

maxkatz6 commented Oct 6, 2024

Uh oh!

Uh oh!

lindexi commented Oct 8, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lindexi commented Jul 27, 2024 •

edited

Loading

kekekeks Jul 27, 2024 •

edited

Loading

lindexi Jul 27, 2024 •

edited

Loading

lindexi Aug 24, 2024 •

edited

Loading