Skip to content

[Merged by Bors] - Update MouseMotion and CursorMoved docs #5090

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

[Merged by Bors] - Update MouseMotion and CursorMoved docs #5090

wants to merge 3 commits into from

Conversation

Nilirad
Copy link
Contributor

@Nilirad Nilirad commented Jun 24, 2022 •
edited
Loading

Objective

Solution

I looked at the implementation of those events. I noticed that they both are adaptations of winit's DeviceEvent/WindowEvent enum variants. Therefore I based the description of the items on the documentation provided by the upstream crate. I also added a link to CursorMoved, just like MouseMotion already has.

Observations

  • Looking at the implementation of MouseMotion, I noticed the DeviceId field of the winit event is discarded by bevy_input. This means that in the case a machine has multiple pointing devices, it is impossible to distinguish to which one the event is referring to. EDIT: just tested, MouseMotion events are emitted for movement of both mice.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more A-Windowing Platform-agnostic interface layer to run your app in labels Jun 25, 2022
alice-i-cecile
alice-i-cecile requested changes Jun 25, 2022
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

These are a solid improvement. I would like to see:

  1. Links between these types, with an explanation of the differences.
  2. A note in the docs recording your observation about MouseMotion and multiple pointing devices.

@Nilirad
Copy link
Contributor Author

Nilirad commented Jun 25, 2022

I only added a link to MouseMotion because a MouseMotion → CursorMoved link would violate the dependency principle (bevy_input does not depend on bevy_winit, it's the other way around).

Weibye
Weibye approved these changes Jun 26, 2022
View reviewed changes
Copy link
Contributor

@Weibye Weibye left a comment

Choose a reason for hiding this comment

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

I think this looks good as is, see comments but those should not be blocking

@Weibye Weibye added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jun 26, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jun 26, 2022
@Nilirad
Update MouseMotion and CursorMoved docs (#5090)
056f122 
# Objective

- Fixes #5083 

## Solution

I looked at the implementation of those events. I noticed that they both are adaptations of `winit`'s `DeviceEvent`/`WindowEvent` enum variants. Therefore I based the description of the items on the documentation provided by the upstream crate. I also added a link to `CursorMoved`, just like `MouseMotion` already has.

## Observations

- Looking at the implementation of `MouseMotion`, I noticed the `DeviceId` field of the `winit` event is discarded by `bevy_input`. This means that in the case a machine has multiple pointing devices, it is impossible to distinguish to which one the event is referring to. **EDIT:** just tested, `MouseMotion` events are emitted for movement of both mice.
@bors
Copy link
Contributor

bors bot commented Jun 26, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Update MouseMotion and CursorMoved docs [Merged by Bors] - Update MouseMotion and CursorMoved docs Jun 26, 2022
@bors bors bot closed this Jun 26, 2022
@Nilirad Nilirad deleted the mouse_cursor_event_docs branch June 26, 2022 14:44
inodentry pushed a commit to IyesGames/bevy that referenced this pull request Aug 8, 2022
@Nilirad @inodentry
Update MouseMotion and CursorMoved docs (bevyengine#5090)
b2e273e 
# Objective

- Fixes bevyengine#5083 

## Solution

I looked at the implementation of those events. I noticed that they both are adaptations of `winit`'s `DeviceEvent`/`WindowEvent` enum variants. Therefore I based the description of the items on the documentation provided by the upstream crate. I also added a link to `CursorMoved`, just like `MouseMotion` already has.

## Observations

- Looking at the implementation of `MouseMotion`, I noticed the `DeviceId` field of the `winit` event is discarded by `bevy_input`. This means that in the case a machine has multiple pointing devices, it is impossible to distinguish to which one the event is referring to. **EDIT:** just tested, `MouseMotion` events are emitted for movement of both mice.
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@Nilirad @james7132
Update MouseMotion and CursorMoved docs (bevyengine#5090)
559b353 
# Objective

- Fixes bevyengine#5083 

## Solution

I looked at the implementation of those events. I noticed that they both are adaptations of `winit`'s `DeviceEvent`/`WindowEvent` enum variants. Therefore I based the description of the items on the documentation provided by the upstream crate. I also added a link to `CursorMoved`, just like `MouseMotion` already has.

## Observations

- Looking at the implementation of `MouseMotion`, I noticed the `DeviceId` field of the `winit` event is discarded by `bevy_input`. This means that in the case a machine has multiple pointing devices, it is impossible to distinguish to which one the event is referring to. **EDIT:** just tested, `MouseMotion` events are emitted for movement of both mice.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@Nilirad @ItsDoot
Update MouseMotion and CursorMoved docs (bevyengine#5090)
023477d 
# Objective

- Fixes bevyengine#5083 

## Solution

I looked at the implementation of those events. I noticed that they both are adaptations of `winit`'s `DeviceEvent`/`WindowEvent` enum variants. Therefore I based the description of the items on the documentation provided by the upstream crate. I also added a link to `CursorMoved`, just like `MouseMotion` already has.

## Observations

- Looking at the implementation of `MouseMotion`, I noticed the `DeviceId` field of the `winit` event is discarded by `bevy_input`. This means that in the case a machine has multiple pointing devices, it is impossible to distinguish to which one the event is referring to. **EDIT:** just tested, `MouseMotion` events are emitted for movement of both mice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Weibye Weibye Weibye approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-Input Player input via keyboard, mouse, gamepad, and more A-Windowing Platform-agnostic interface layer to run your app in C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Distinction between MouseMotion and CursorMoved events is unclear in docs
3 participants
@Nilirad @alice-i-cecile @Weibye