APP-538: Make base key and mouse events more robust #1528
Conversation
micheal-parks
requested review from
mrloureed,
stevebriskin,
DTCurrie and
anjinai
micheal-parks
changed the title
| import type { ServiceError } from '../gen/proto/stream/v1/stream_pb_service.esm'; | ||
|
|
||
| interface Props { | ||
| name: string; | ||
| resources: Resource[]; | ||
| } | ||
|
|
||
| // eslint-disable-next-line no-shadow |
There was a problem hiding this comment.
Hmm, for some reason ESLint thinks that we're shadowing another variable with const enums. That's weird, we'll need to investigate more.
| @@ -45,16 +53,14 @@ const angle = ref(0); | |||
| const videoStreamStates = new Map<string, boolean>(); | |||
| const selectCameras = ref(''); | |||
|
|
|||
| const pressed = new Set<Keys>(); | |||
There was a problem hiding this comment.
We now add all pressed keys to a stack of unique items, and then digest those items from oldest to newest input. The key is deleted from the stack when a keyup / mouseup event occurs. This allows us to better handle multiple keys pressed at the same time by a keyboard, or even a touchscreen!
| let linearValue = 0; | ||
| let angularValue = 0; | ||
|
|
||
| for (const item of pressed) { |
There was a problem hiding this comment.
Here we loop through the stack of pressed keys, and apply weights for each key. We don't need to worry about values growing larger than 1, because all items in a Set can be guaranteed to be unique.
The result of this behavior is that pressing the left and right keys (or the up and down keys) will cancel each other out.
| new commonApi.Vector3(), | ||
| displayError | ||
| ); | ||
| const req = new baseApi.SetVelocityRequest(); |
There was a problem hiding this comment.
BaseControlHelper isn't providing much abstraction value anymore since we've componentized everything, so I've moved all methods into the component. Switching to protobuf-ts will simplify this even more.
| /> | ||
| </div> | ||
| <KeyboardInput | ||
| @keydown="handleKeyDown" |
There was a problem hiding this comment.
I've simplified the internals of <KeyboardInput> so that it's now just emitting keydown and keyup events with normalized input.
|
|
||
| const handleKeyDown = (key: Keys) => { | ||
| pressed.add(key); | ||
| digestInput(); |
There was a problem hiding this comment.
We re-digest input whenever a keydown happens, or a keyup happens and the length of pressed keys is still greater than zero.
micheal-parks
added
the
safe to test
|
|
||
| const handlePointerDown = (key: Keys) => { | ||
| emitKeyDown(key); | ||
| window.addEventListener('pointerup', () => emitKeyUp(key), { once: true }); |
There was a problem hiding this comment.
This specifically fixes one of the issues people are encountering: dragging a mouse away from a button and releasing the mouse button causes the robot to drive forever, off into the sunset, never to be seen again.
If we instead apply the keyup event to the window, the mouse can be anywhere and the input will still be canceled.
viambot
removed
the
safe to test
micheal-parks
added
the
safe to test
viambot
removed
the
safe to test
micheal-parks
added
the
safe to test
|
This PR refactors how we handle mouse and key events from the
<KeyboardInput>component, making them behave more predictably, with fewer cases in which a stop signal will not be sent if the user is not interacting anymore. More details in comments.