Details

Reviewers

William Reynish (billreynish)
Brecht Van Lommel (brecht)
Bastien Montagne (mont29)
Julian Eisel (Severin)

Maniphest Tasks

T40537: Holding down "R" causes rapid switching between rotate and trackball rotate

Summary

This patch adds is_repeat member to an event and an option for key-map items to handle repeat events.

The keymap author can choose if they want press events to activate when the key is held (this patch enables for text editing and frame changes, otherwise repeat events aren't acted on).

This resolves T40537: Holding down "R" causes rapid switching between rotate and trackball rotate.

Notes

Not proposing this for 2.80.
Currently only X11 is supported.
Uses ghost to track of the last held key which has auto-repeat enabled (using XKB when supported).
This isn't fool proof, once a non-blender window is active we can't tell the key state. Currently the held key is cleared when the window is activated.

Diff Detail

Repository

rB Blender

Branch

TEMP-EVENT-KEY-REPEAT-SUPPORT (branched from master)

Build Status

Buildable 3950
Build 3950: arc lint + arc unit

Event Timeline

Campbell Barton (campbellbarton) created this revision.Jun 30 2019, 8:14 AM

Harbormaster completed remote builds in B3930: Diff 16122.Jun 30 2019, 8:14 AM

Campbell Barton (campbellbarton) retitled this revision from Event system & keymap support for key repeat events to Event system & keymap support for key detecting/ignoring key repeat events.Jun 30 2019, 8:32 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)

Add Event.is_repeat to RNA

Harbormaster completed remote builds in B3931: Diff 16123.Jun 30 2019, 8:33 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 8:34 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 9:04 AM

Campbell Barton (campbellbarton) added a task: T40537: Holding down "R" causes rapid switching between rotate and trackball rotate.

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 9:06 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 9:11 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 9:17 AM

KiJeon (0o00o0oo) added a subscriber: KiJeon (0o00o0oo).Jun 30 2019, 11:43 AM

Use ghost to detect key repeat events

Harbormaster completed remote builds in B3932: Diff 16128.Jun 30 2019, 3:41 PM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 3:42 PM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 3:51 PM

Clear keys when a window is activated

Harbormaster completed remote builds in B3933: Diff 16129.Jun 30 2019, 3:59 PM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jun 30 2019, 4:00 PM

Use xkb, remove use of set to stored held keys

Harbormaster completed remote builds in B3949: Diff 16150.Jul 2 2019, 4:04 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jul 2 2019, 4:06 AM

Remove testing code

Harbormaster completed remote builds in B3950: Diff 16151.Jul 2 2019, 4:10 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Jul 2 2019, 4:12 AM

Sync w/ master

Harbormaster completed remote builds in B4137: Diff 16550.Jul 22 2019, 8:37 AM

Campbell Barton (campbellbarton) mentioned this in T66625: When "Pie Menu on Drag" is enabled in user prefs, Ctrl + Z has a tendency to open the shading menu by accident.Jul 22 2019, 12:14 PM

Sync with master

Harbormaster completed remote builds in B4751: Diff 17804.Sep 4 2019, 1:21 PM

Campbell Barton (campbellbarton) added a reviewer: Julian Eisel (Severin).Sep 4 2019, 1:21 PM

Asher (ThatAsherGuy) added a subscriber: Asher (ThatAsherGuy).Sep 4 2019, 3:38 PM

Merge branch 'master' into arcpatch-D5153 (withouth this I got an ASan crash on startup)
Fix changing "Repeat" in keymap item through Preferences not working
Fix resetting key map item not resetting "Repeat" property

Harbormaster completed remote builds in B5180: Diff 18656.Sep 30 2019, 5:08 PM

First off, sorry for taking so long to check on this. I actually did check earlier and noticed the following issue with the prefs which I wanted to investigate, but then the file browser stuff got in the way...

Noticed that changing the repeat property through the prefs doesn't do anything. Fixed the keymap side of this, but there are some further issues making this fail (see following).
The XKB implementation seems to always allow key repeat events on arrow keys, space bar, etc. Not too sure what the rationale behind that is and if that's the behavior we want too.
- As a result, for a good amount of keymap items, the repeat property doesn't have an effect. E.g. text cursor move items. I don't have a strong opinion on if that's fine, but should be checked on.
I guess the industry compatible keymap should be updated too?

Just to test my fixes, you can use the backspace text.delete item, that works despite the XKB issue.

Also, do you have plans to check on other distros?

source/blender/editors/transform/transform.c
1371	Hmm, would be nice if this could actually respect the keymap item property, would have to look into how simple/complicated that is though.

This revision now requires changes to proceed.Sep 30 2019, 5:12 PM

Fix bitfield array check.
Fix clearing repeat when non-repeat key released.

Harbormaster completed remote builds in B5213: Diff 18736.Oct 2 2019, 6:20 PM

Tested quickly, works fine now :)

The only thing stopping me from accepting it is that it's unclear what the plans for other OSes are. I could look into the Win32 implementation myself, but it'll have to wait a few days then.

For other OS's we could do something we have in the X11 under the comment:

/* No XKB support (filter by modifier). */

If they don't have the repeat information available, although ideally we could access this information.

Campbell Barton (campbellbarton) mentioned this in T69992: Shortcuts for Tools (design task).Oct 30 2019, 8:47 AM

Asher (ThatAsherGuy) mentioned this in T69323: Remove/Update "Emulate Middle Mouse" preference.Jan 20 2020, 9:26 PM

Asher (ThatAsherGuy) mentioned this in T68970: Slower response of Blender due to click event in "left click" keymap..Jan 22 2020, 10:15 PM

Sync with master

Harbormaster completed remote builds in B6910: Diff 22318.Mar 3 2020, 11:37 AM

Fix compile errors when building with SDL, NDOF or on macOS
Add Windows support

Harbormaster completed remote builds in B6953: Diff 22395.Mar 4 2020, 7:17 PM

On Windows we don't actually get repeat events for modifier keys, so we don't need to do any manual filtering. Character keys, arrow keys and the like work fine (i.e. send repeat events).
In older Win32 APIs, keyboard messages contain a flag for repeat events (see https://docs.microsoft.com/en-us/windows/win32/learnwin32/keyboard-input#key-down-and-key-up-messages). This is not the case for the WM_INPUT message API we use, so we have to keep track of repeat events ourselves. That is of course easily done, although it has the same issue with activating windows as Linux.

I guess macOS support is a TODO. But I'm fine with committing this.

This revision is now accepted and ready to land.Mar 4 2020, 7:23 PM

Note that I ended up changing the flag to be off by default so as not to interfere with existing keymaps.

Committed rB5be0e3430d13341feddee739997130239daf71d5 closing.

Event system & keymap support for key detecting/ignoring key repeat events
AbandonedPublic
Actions

Details

Notes

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 16151

intern/ghost/GHOST_Types.h

intern/ghost/intern/GHOST_EventKey.h

intern/ghost/intern/GHOST_SystemX11.h

intern/ghost/intern/GHOST_SystemX11.cpp

release/scripts/modules/rna_keymap_ui.py

release/scripts/presets/keyconfig/keymap_data/blender_default.py

source/blender/editors/interface/interface_handlers.c

source/blender/editors/transform/transform.c

source/blender/makesdna/DNA_windowmanager_types.h

source/blender/makesrna/intern/rna_wm.c

source/blender/makesrna/intern/rna_wm_api.c

source/blender/windowmanager/WM_types.h

source/blender/windowmanager/intern/wm_event_system.c

Event system & keymap support for key detecting/ignoring key repeat eventsAbandonedPublicActions

Details

Notes

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 16151

intern/ghost/GHOST_Types.h

intern/ghost/intern/GHOST_EventKey.h

intern/ghost/intern/GHOST_SystemX11.h

intern/ghost/intern/GHOST_SystemX11.cpp

release/scripts/modules/rna_keymap_ui.py

release/scripts/presets/keyconfig/keymap_data/blender_default.py

source/blender/editors/interface/interface_handlers.c

source/blender/editors/transform/transform.c

source/blender/makesdna/DNA_windowmanager_types.h

source/blender/makesrna/intern/rna_wm.c

source/blender/makesrna/intern/rna_wm_api.c

source/blender/windowmanager/WM_types.h

source/blender/windowmanager/intern/wm_event_system.c

Event system & keymap support for key detecting/ignoring key repeat events
AbandonedPublic
Actions

Revision Contents
Changeset List