Description
Most appropriate sub-area of p5.js?
- AccessibilityColorCore/Environment/RenderingDataDOMEventsImageIOMathTypographyUtilitiesWebGLBuild processUnit testingInternationalizationFriendly errorsOther (specify if possible)
p5.js version
1.9.0
Web browser and version
122.0.6261.95 (Official Build) (64-bit) (cohort: Stable)
Operating system
Windows 10 Home Edition
Steps to reproduce this
Steps:
- Press and hold left mouse button
- Press and hold right mouse button
- Release left mouse button
- Expected: console logs
left
- Actual: console logs
right
- Expected: console logs
Snippet:
function setup() {
createCanvas(400, 400);
}
function mouseReleased() {
console.log(mouseButton);
}
function draw() {
background(220);
}
Additional Context
I discovered this issue when implementing the game of Minesweeper. In that game, pressing and releasing both mouse buttons at the same time is the way to uncover all unmarked neighbors of a cell, and I found that I could not detect this condition reliably using mouseButton
. I believe this is due to mouseButton
being updated in mousePressed
but not mouseReleased
.
https://github.com/processing/p5.js/blob/main/src/events/mouse.js#L657
https://github.com/processing/p5.js/blob/main/src/events/mouse.js#L733
I have a pull request (with associated unit test) that appears to resolve the issue. This bug was previously reported in #5733, but the submitter resolved that issue as they found a workaround.
Metadata
Metadata
Assignees
Type
Projects
Status
Activity
welcome commentedon Mar 12, 2024
Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, please make sure to fill out the inputs in the issue forms. Thank you!
Renatolo commentedon Apr 4, 2024
Hey, I would like to work on this bug, please!
Fix processing#6847: Update mouseButton value when one mouse button i…
limzykenneth commentedon May 28, 2024
This is more or less intended behavior documented and I'm not keen to change the behavior. There is probably room to have better support for simultaneous mouse button presses as currently having the context menu being brought up by the right mouse button can confuse things often.
There is a larger proposal here for better mouse event handling that I think can be explored in p5.js 2.0.
diyaayay commentedon Nov 27, 2024
In the PR: #7378, setting mouseButton on
_onmousedown()
works well but I noticed pointer events work differently than mouse events meaning_setMouseButton()
is only called when a single button is pressed asonpointerdown()
is not invoked multiple times on pressing simultaneous mouse buttons. Instead_onpointermove()
is triggered when multiple mouse buttons are clicked in pointer events: https://stackoverflow.com/questions/75030295/pointer-events-dont-support-simultaneous-mouse-buttons. So, I attempted to handle mouse buttons by checking which buttons are pressed currently, using the buttons property, which continuously changes as pointerdown, pointermove, and pointerup events occur. This approach clearly shows which buttons are currently pressed during simultaneous button presses. However, this would require updating the description of mouseButton accordingly. @limzykenneth @davepagurekdavepagurek commentedon Nov 27, 2024
I'm in favour of replacing the single variable with an object with
left
,right
, andcenter
properties like you're proposing, this seems like a useful breaking change to make.Do those pointer move events that update the buttons also come attached to a specific pointer ID? I wonder if, in addition to a single global
mouseButton
property for use in single-pointer sketches, we could also store this same info per pointer in ourtouches
array (or under whatever name we end up giving that.) So,touches[i].mouseButton.left
would represent whether the left button is down for a specific pointer, whilemouseButton.left
would represent whether any pointer has its left button down.limzykenneth commentedon Nov 27, 2024
@diyaayay Would the proposed approach means that if there are only
pointerdown
event but notpointermove
, pressing down on left mouse button followed by right mouse button without releasing the left will cause only left mouse button to be registered?I haven't quite use this part of things directly very much before but perhaps the
element.releasePointerCapture
described here may point to a potential solution? If you have a test sketch, do share and I can test it out locally as well.@davepagurek Pointer events do come with pointer ID so we can identify individual pointer.
diyaayay commentedon Nov 27, 2024
@limzykenneth Yes, that is what I've been seeing. So, for multiple mouse clicks only
mouseup
andmousedown
sets thebutton
that we have been using. You can see the values on multiple button clicks here in an mdn playground here. But, the same thing does not work forpointerup
andpointerdown
as seen in the pointer example.But subsequent mouse presses are recognised as
pointermove
event that match the mouse buttons Working pointer example. I've tested the same thing in sketches also.I'm not too sure though. I may be missing something. But
mouseButton
being an object seemed like something that gives more info to the user about pressed and released state of each button.Some pointer devices, such as mouse or pen, support multiple buttons. In the [UIEVENTS] Mouse Event model, each button press produces a mousedown and mouseup event. To better abstract this hardware difference and simplify cross-device input authoring, Pointer Events do not fire overlapping pointerdown and pointerup events for chorded button presses (depressing an additional button while another button on the pointer device is already depressed).
Instead, chorded button presses can be detected by inspecting changes to the button and buttons properties. The button and buttons properties are inherited from the MouseEvent interface, but with a change in semantics and values.
Ref:
diyaayay commentedon Nov 28, 2024
Untitled.design.7.mp4
For the sketch:
This is how
mouseButton
is displayed, but we can change it to not keep it as an object in order to maintain the current behavior.@davepagurek @limzykenneth
diyaayay commentedon Nov 28, 2024
I don't think so.
setPointerCapture()
andreleasePointerCapture()
takepointerId
as a parameter to continue receiving and stop receiving events for a particular pointer id. But multiple mouse button presses would have different ids. What we want is to keep receiving multiple pointer Ids on a particular event i.e.onpointerdown
.davepagurek commentedon Dec 1, 2024
An object sounds good to me, it lets us indicate when more than one button is pressed, which is something the current API isn't expressive enough for.
diyaayay commentedon Dec 1, 2024
https://editor.p5js.org/diya.solanki.31/sketches/KbLubzBoV
Here is a sketch that shows the same.