Skip to content
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

Change offsetX and offsetY calculations in PointerEventManager #2938

Merged
merged 2 commits into from
Jun 14, 2024

Conversation

m-bert
Copy link
Contributor

@m-bert m-bert commented Jun 11, 2024

Description

While working on PointerTracker refactor and adding relativeCoords to it, I've noticed that offsetX/offsetY in PointerEventManager use PointerEvent.offsetX (and offsetY respectively) while TouchEventManager calculates this property by calculating the difference between clientX and bounding box (event.clientX - rect.left). I've decided to unify this behavior so that offset is now calculated in PointerEventManager the same way as in TouchEventManager.

As. you can see in the videos below, those 2 values may have different results - that is the main reason behind unifying them. offset property is used only in relativeCoords which have been recently introduced, so it won't be a breaking change.

Test plan

Tested by adding console.table in onPointerMove inside PanGestureHandler

div with Pan

image

Before

Nagranie.z.ekranu.2024-06-11.o.12.08.55.mov

After

Nagranie.z.ekranu.2024-06-11.o.12.11.00.mov

Copy link
Contributor

@latekvo latekvo left a comment

Choose a reason for hiding this comment

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

lgtm :shipit:

@m-bert m-bert merged commit fcc32c9 into main Jun 14, 2024
2 checks passed
@m-bert m-bert deleted the @mbert/unify-events branch June 14, 2024 11:43
m-bert added a commit that referenced this pull request Jun 14, 2024
## Description

Changes made in #2938 and #2939 allowed us to calculate `x` and `y` relative to given `View` with the same method on `PointerEvents` and `TouchEvents`. This PR changes logic in `GestureHandler` base class, so that now it sends relative coordinates calculated by tracker.

This change, combined with the one from #2943, makes handlers send correct relative coords.

> [!NOTE]
> New coords may not be correct if the `view` is rotated, or some of its ancestors are scaled. These cases will be handled in different PRs.

## Test plan

Copy snippet below and paste it into `transformNativeEvent` in `GestureHandler.ts`

<details>
<summary> Logs snippet </summary>

```jsx

    const rect = this.delegate.measureView();
    const old = {
      x: lastCoords.x - rect.pageX,
      y: lastCoords.y - rect.pageY,
    };

    console.table({
      oldX: old.x,
      oldY: old.y,
      newX: lastRelativeCoords.x,
      newY: lastRelativeCoords.y,
      dx: old.x - lastRelativeCoords.x,
      dy: old.y - lastRelativeCoords.y,
    });

```

</details>

Here's example video that shows difference between those calculations:


https://github.com/software-mansion/react-native-gesture-handler/assets/63123542/d3a0575c-3821-4d2a-ac96-a0c3a870a1f5
github-merge-queue bot pushed a commit to valora-inc/wallet that referenced this pull request Jun 26, 2024
…5575)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[react-native-gesture-handler](https://togithub.com/software-mansion/react-native-gesture-handler)
| [`^2.16.2` ->
`^2.17.1`](https://renovatebot.com/diffs/npm/react-native-gesture-handler/2.16.2/2.17.1)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-native-gesture-handler/2.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-native-gesture-handler/2.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-native-gesture-handler/2.16.2/2.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-native-gesture-handler/2.16.2/2.17.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>software-mansion/react-native-gesture-handler
(react-native-gesture-handler)</summary>

###
[`v2.17.1`](https://togithub.com/software-mansion/react-native-gesture-handler/releases/tag/2.17.1)

[Compare
Source](https://togithub.com/software-mansion/react-native-gesture-handler/compare/2.17.0...2.17.1)

#### 🐛 Bug fixes

- Don't register `checkIntegrityBetweenArchitectures` task when
installed as a dependency by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[#&#8203;2953](https://togithub.com/software-mansion/react-native-gesture-handler/issues/2953)

**Full Changelog**:
software-mansion/react-native-gesture-handler@2.17.0...2.17.1

###
[`v2.17.0`](https://togithub.com/software-mansion/react-native-gesture-handler/releases/tag/2.17.0)

[Compare
Source](https://togithub.com/software-mansion/react-native-gesture-handler/compare/2.16.2...2.17.0)

#### ❗ Important changes

- Add `ref` property to `Buttons` by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2903
- Unify touch events callbacks on `web` with respect to `Android` by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2923
- Add `touchType` to `TouchEvent` by
[@&#8203;latekvo](https://togithub.com/latekvo) in
[software-mansion/react-native-gesture-handler#2941

#### 👍 Improvements

- Refactor `GestureDetector` by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2901
- Remove lodash by [@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2916
- `PointerTracker` refactor. by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2931
- Change `offsetX` and `offsetY` calculations in `PointerEventManager`
by [@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2938

#### 🐛 Bug fixes

- Make `RootViewGestureHandler` handler cancel awaiting gestures by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2900
- Get right bridge by
[@&#8203;piaskowyk](https://togithub.com/piaskowyk) in
[software-mansion/react-native-gesture-handler#2886
- Fix buttons getting stuck after scrolling on them by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2693
- Fix Detector creating and attaching all gestures twice on first mount
by [@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2914
- Fix GestureDetector not working when its children change by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2921
- Fix GestureDetector not working correctly with suspense and recycling
by [@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2925
- Fix nested buttons on the new architecture by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2926
- Unify scaled coordinates between `web` and `native` side. by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2943
- \[Web] Send relative coords in event. by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2944

#### 🔢 Miscellaneous

- Add information about `GestureHandlerRootView` area and change
component name in quick start section in docs. by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2899
- Add Hire us section to docs by
[@&#8203;patrycjakalinska](https://togithub.com/patrycjakalinska) in
[software-mansion/react-native-gesture-handler#2904
- Bump ejs from 3.1.7 to 3.1.10 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2888
- Bump tar from 6.2.0 to 6.2.1 in /e2e/web-tests by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2859
- docs: add
[@&#8203;swmansion/t-rex-ui](https://togithub.com/swmansion/t-rex-ui) by
[@&#8203;kacperkapusciak](https://togithub.com/kacperkapusciak) in
[software-mansion/react-native-gesture-handler#2895
- Change navbar and footer to a reusable component by
[@&#8203;patrycjakalinska](https://togithub.com/patrycjakalinska) in
[software-mansion/react-native-gesture-handler#2902
- Add dark mode to button in `Hire us` section by
[@&#8203;patrycjakalinska](https://togithub.com/patrycjakalinska) in
[software-mansion/react-native-gesture-handler#2908
- Setup example app to use Expo by
[@&#8203;bohdanprog](https://togithub.com/bohdanprog) in
[software-mansion/react-native-gesture-handler#2905
- Revert "docs: add
[@&#8203;swmansion/t-rex-ui](https://togithub.com/swmansion/t-rex-ui)"
by [@&#8203;kacperkapusciak](https://togithub.com/kacperkapusciak) in
[software-mansion/react-native-gesture-handler#2909
- Bump [@&#8203;sideway/formula](https://togithub.com/sideway/formula)
from 3.0.0 to 3.0.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2910
- docs: add
[@&#8203;swmansion/t-rex-ui](https://togithub.com/swmansion/t-rex-ui) by
[@&#8203;patrycjakalinska](https://togithub.com/patrycjakalinska) in
[software-mansion/react-native-gesture-handler#2911
- Fix symlink loop during pods installation by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2917
- Bump rexml from 3.2.6 to 3.2.8 in /FabricExample by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2915
- Add animated header to the example app by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2913
- Add option to auto-open last example in the example app by
[@&#8203;j-piasecki](https://togithub.com/j-piasecki) in
[software-mansion/react-native-gesture-handler#2918
- Replace current theme components with `@swmansion/t-rex-ui` by
[@&#8203;patrycjakalinska](https://togithub.com/patrycjakalinska) in
[software-mansion/react-native-gesture-handler#2906
- Bump rexml from 3.2.6 to 3.2.8 in /MacOSExample by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2924
- Bump rexml from 3.2.6 to 3.2.8 in /example by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2930
- feat: automatically copy codegen artifacts to paper by
[@&#8203;maciekstosio](https://togithub.com/maciekstosio) in
[software-mansion/react-native-gesture-handler#2933
- Add swipeable example rewritten to new API by
[@&#8203;latekvo](https://togithub.com/latekvo) in
[software-mansion/react-native-gesture-handler#2934
- Fix new swipeable using useMemo with incomplete dependency list by
[@&#8203;latekvo](https://togithub.com/latekvo) in
[software-mansion/react-native-gesture-handler#2937
- docs: update Hire us links to directly lead to contact form by
[@&#8203;kacperkapusciak](https://togithub.com/kacperkapusciak) in
[software-mansion/react-native-gesture-handler#2935
- chore(types): add missing pointerType to GestureTouchEvent by
[@&#8203;mgcrea](https://togithub.com/mgcrea) in
[software-mansion/react-native-gesture-handler#2928
- Bump braces from 3.0.2 to 3.0.3 in /example by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2945
- Bump braces from 3.0.2 to 3.0.3 in /e2e/web-tests by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2946
- Bump ws from 6.2.2 to 6.2.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2947
- Bump ws from 6.2.2 to 6.2.3 in /e2e/web-tests by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[software-mansion/react-native-gesture-handler#2948
- Add `relativeCoords` average to `PointerTracker` by
[@&#8203;m-bert](https://togithub.com/m-bert) in
[software-mansion/react-native-gesture-handler#2939
- Add missing import in docs by
[@&#8203;piaskowyk](https://togithub.com/piaskowyk) in
[software-mansion/react-native-gesture-handler#2950

#### New Contributors

- [@&#8203;bohdanprog](https://togithub.com/bohdanprog) made their first
contribution in
[software-mansion/react-native-gesture-handler#2905
- [@&#8203;maciekstosio](https://togithub.com/maciekstosio) made their
first contribution in
[software-mansion/react-native-gesture-handler#2933
- [@&#8203;mgcrea](https://togithub.com/mgcrea) made their first
contribution in
[software-mansion/react-native-gesture-handler#2928

**Full Changelog**:
software-mansion/react-native-gesture-handler@2.16.2...2.17.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone
America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone
America/Los_Angeles.

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/valora-inc/wallet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjQxMy4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJucG0iLCJyZW5vdmF0ZSJdfQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: valora-bot <valorabot@valoraapp.com>
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.

3 participants