Add harmonic keywheel ui #1695

poelzi · 2018-05-31T19:40:07Z

Add a Dialog with the harmonic keywheel as a cheat sheet.
Clicking on the wheel will cycle through the different notations.

This is very useful on B2B cases when both DJs are using different notations.
Also it helps when using pitching to lookup the next key.

TODO:

Some of the styling I used in the SVG is not supported by the qt svg support. Would be good if someone from the skinning team would give it some polishing.
Maybe fix the aspect ratio but does not work

Be-ing · 2018-05-31T20:55:56Z

Neat idea. Can you post a screenshot?

poelzi · 2018-05-31T21:23:07Z

Open Key Notation

Be-ing · 2018-05-31T21:27:26Z

It looks odd to me to put F at the top. Every other diagram of the circle of fifths I have seen puts C at the top.

poelzi · 2018-06-01T11:49:53Z

Updated version. TAB + Shift TAB now also works

Be-ing · 2018-06-01T20:36:50Z

I don't think the window needs its own Close button. There is already the window manager's close button.

poelzi · 2018-06-01T21:05:01Z

Not all window managers have a close button. Awesome for example does have one. Dialogs without close buttons are strange even stranger. It's existence also ensures the window handles key events correctly.

Be-ing · 2018-06-01T21:09:04Z

You could make the dialog close when clicking on it like the cover art dialog.

It's existence also ensures the window handles key events correctly.

What key events would this simple dialog need to handle?

esbrandt · 2018-06-03T12:41:00Z

Thanks for working on this feature.

I had not the chance to test the live code ( can´t build master with qt5 yet), so for now just some comments from looking at the screenshoot.

For Open Key Notation, we should not try to establish our own color set in the key wheel, lets use the established colors instead.

The color palette below is derived from the Open Key Notation, and already used in Traktor, Scratch Pro etc...
The palette might be useful later , when displaying keys in the library in different colors, or when displaying key changes in the waveform.
Just save as *.gpl for use with Inkscape / Gimp. *.ase palette available upon request.

GIMP Palette
Name: Open Key Notation colors
Columns: 1
# Created for <https://mixxx.org/>
# Based upon Open Key Notation
# <https://www.beatunes.com/en/open-key-notation.html>
# licensed under CC0 1.0 Universal (CC0 1.0)
# <https://creativecommons.org/publicdomain/zero/1.0/>

252  73  73	1d/1m #FC4949
254 100  45	2d/2m #FE642D
249 140  39	3d/3m #F98C27
254 214   0	4d/4m #FED600
153 254   0	5d/5m #99FE00
 66 254  62	6d/6m #42FE3E
 10 213 143	7d/7m #0AD58F
 10 231 231	8d/8m #0AE7E7
  4 201 254	9d/9m #04C9FE
 61 138 253	10d/10m #3D8AFD
172 100 254	11d/11m #AC64FE
253  63 234	12d/12m #FD3FEA

Should the modal key widget really overlay the application widget? We only allow it for the preferences, dev console, and properties editor - all of them usually not open during performance.
I understand the keywheel is meant to be a cheat sheet, but someone might have it open pretty often, if mixing by key ( and Mixxx not having a related-key feature yet). It has the potential to grow into a even more powerful feature.

daschuer · 2018-06-03T16:09:01Z

It can be a feature in the new three column library.It was designed exactly for such additional infos.

Be-ing · 2018-06-11T21:09:40Z

I think we should be removing items from the menu bar so we can remove the menu bar entirely. Perhaps the place to this image would be somewhere in the library, but I don't want to make this little branch depend on the library redesign branch. So I think adding this design debt is okay for now.

Be-ing · 2018-06-11T21:16:41Z

There are a few oddities with traditional notation. The keys are displayed twice per sector. Also, D sharp minor/E flat minor does not fit in the allocated space.

Be-ing · 2018-06-11T21:17:54Z

I don't think the window needs its own Close button. There is already the window manager's close button.

I didn't realize that the dialog responds to click events already. So I think the Close button is okay.

Be-ing · 2018-06-23T21:39:11Z

@poelzi could you take care of the above issues in the next week? If so I think we could merge this for 2.2.

poelzi · 2018-06-25T01:42:23Z

Did not know there were official color wheel colors, thanks. I changed the svg to match those.

@Be-ing The text is a simple replacement of the body in the template. I removed the traditional display so only on the custom setting something strange could be displayed. I don't see a way to easily ensure the text will fit the box.

Be-ing · 2018-06-27T17:47:21Z

I'm confused. The last commit doesn't seem to change the behavior for me. However, I don't think it's a good approach. I want to see the diagram with traditional notation -- I just don't want to see all the keys listed multiple times in each sector. Thinking about it more, I'm a bit confused why this feature is even helpful with the numbered key notations because it is so easy to think of how keys are related with those notations.

poelzi · 2018-06-27T18:48:09Z

@Be-ing I think your custom settings are like traditional ?
Of coures custom is always shown, I'm not testing if the settings are identical to traditional and in this case I'm skipping custom as well.

The reason for having also numbered wheel on it is to look up for example openkey or lancelot if you need it (b2b setting with someone using different notation). Also calculating the key pitch up/down will be in is not something I'm always 100% certain of while 140 bpm is hammering on your head.

Ok, so, you want a extra layout just for traditional view without the static information used for orientation ?

Be-ing · 2018-06-27T19:48:35Z

@Be-ing I think your custom settings are like traditional ?

No, I checked that I am not using a custom notation.

Ok, so, you want a extra layout just for traditional view without the static information used for orientation ?

Yes.

Holzhaus · 2020-02-14T13:57:08Z

Could this be used as editor for a KeyDelegate that opens when trying to edit the Key column in the Track table view?

Be-ing · 2021-01-24T17:27:46Z

clazy failed on Qt's autogenerated ui header??

poelzi · 2021-01-24T20:09:04Z

Looks like it. Im changing it to a normal button now.

daschuer · 2021-01-25T00:01:55Z

A conflict has developed. Please merge upstream/main and resolve the conflict.

…-wheel

poelzi · 2021-01-25T09:59:36Z

@daschuer fixed

daschuer · 2021-01-25T18:26:59Z

src/dialog/dlgkeywheel.cpp

+    }
+    m_domDocument.setContent(&xmlFile);
+
+    // FIXME(poelzi): try to prevent aspect ratio. This fails unfortunatelly


This is still an issue. I guess the close button shrinks the wheel too an egg.

daschuer

I don't see the View menu entry, F2 works.

I have left some more comments inline.

src/dialog/dlgkeywheel.cpp

daschuer · 2021-01-25T18:55:33Z

src/dialog/dlgkeywheel.cpp

+
+    m_domDocument.save(stream, QDomNode::EncodingFromDocument);
+
+    ui->graphic->load(str.toUtf8());


You can omit the toUtf8()

no, because a QString means load the file and we have the content here. I added a comment

src/dialog/dlgkeywheel.cpp

daschuer · 2021-01-25T20:10:27Z

src/dialog/dlgkeywheel.cpp

+    QDomElement domElement;
+
+    QDomNodeList node_list = m_domDocument.elementsByTagName(QStringLiteral("text"));
+    for (int i = 0; i < node_list.count(); i++) {


Can this become a range based loop?

no, the QDomNodeList API is very rudimentary.

src/dialog/dlgkeywheel.h

src/mixxx.cpp

poelzi · 2021-01-25T23:02:17Z

@daschuer I moved the entry into the help menu, because it is more of a help then some feature that is switched in the view menu.

daschuer · 2021-01-27T10:27:34Z

The wheel still starts as flat. Once you grep the edge of it, it snaps into a round shape. I assume this happens, because the svg is loaded after the size is set. Maybe it is fixed if you swap it?

daschuer · 2021-01-27T10:29:32Z

Or maybe it helps to call resizeEvent() manually ...?

poelzi · 2021-02-04T23:24:35Z

@daschuer I tried that, does not work. I tried calling it on show(), after initialzation. I tried to actually resize the window on first show but this behaviour persists. I also don't understand why the left spacer only works when the window is very large, but not when the window is small. I think the SVG widget is just buggy in multiple places.
I consider this: as good as it gets without rewriting the complete thing or someone with better QT understanding fixes it.

poelzi · 2021-02-04T23:48:47Z

I found one combination for at least 5.15 that seems to work

daschuer

LGTM, Thank you for this nice addition.
Hopefully the users find the new menu entry.

ronso0 · 2021-02-06T10:09:36Z

we could put a color wheel icon in the tollbars so this is quickly available, also once we have switched to the hideable toolbar.

poelzi · 2021-02-06T12:16:47Z

If someone has time and willingness, the SVG could be replaced by a custom widget that draws the cicle and text. This way, it could become clickable and we could use it as a delegate in the key column. I found no way todetect which element was clicked.

esbrandt · 2021-02-07T11:19:22Z

The keywheel widget is displayed blank.
images/keywheel/keywheel.svg gets called,
but is missing from https://github.com/mixxxdj/mixxx/blob/main/res/mixxx.qrc

tested with 2.4.0-alpha-pre (build main r7757) macOS

esbrandt · 2021-02-07T11:40:38Z

src/widget/wmainmenubar.cpp

+    m_pViewKeywheel->setShortcut(
+            QKeySequence(m_pKbdConfig->getValue(
+                    ConfigKey("[KeyboardShortcuts]", "ViewMenu_ShowKeywheel"),
+                    tr("F2", "Menubar|View|Show Keywheel"))));


This shortcut clashes with the existing shortcut for [Channel1],rate_perm_up, see https://github.com/mixxxdj/mixxx/blob/main/res/keyboard/en_US.kbd.cfg#L43

poelzi · 2021-02-08T00:54:07Z

thanks @esbrandt , fixes in pr

Be-ing added the ui label Jun 23, 2018

poelzi force-pushed the feature/keywheel branch from df831c0 to 5725d84 Compare June 25, 2018 01:41

Be-ing added this to the 2.2.0 milestone Jun 27, 2018

Be-ing modified the milestones: 2.2.0, 2.3.0 Oct 19, 2018

Be-ing removed this from the 2.3.0 milestone Feb 7, 2019

Holzhaus marked this pull request as draft September 1, 2020 17:55

Holzhaus added this to the stalled milestone Sep 1, 2020

uklotzde added 3 commits October 23, 2020 17:30

Merge branch '2.3' of [email protected]:mixxxdj/mixxx.git

6c6c3ab

Merge branch 'main'

4340e24

Merge branch 'main' of [email protected]:mixxxdj/mixxx.git

06b28b6

Be-ing changed the base branch from master to main October 23, 2020 23:50

Fix clazy problem with buttonbox

e455161

Merge branch 'main' into harmonic-wheel

abd0c1d

poelzi closed this Jan 25, 2021

poelzi reopened this Jan 25, 2021

Merge branch 'main' of https://github.com/mixxxdj/mixxx into harmonic…

e7cfb5a

…-wheel

daschuer reviewed Jan 25, 2021

View reviewed changes

daschuer requested changes Jan 25, 2021

View reviewed changes

Cleanup Keywheel code

cd3fc10

Add workaround for wrong SVG size after loading

a3544c5

daschuer modified the milestones: stalled, 2.4.0 Feb 5, 2021

daschuer approved these changes Feb 5, 2021

View reviewed changes

daschuer merged commit 4b1c574 into mixxxdj:main Feb 5, 2021

esbrandt reviewed Feb 7, 2021

View reviewed changes

poelzi mentioned this pull request Feb 8, 2021

keywheel fixes: Add keywheel to qrc file, change shortcut to F12 #3622

Merged

mixxxbot mentioned this pull request Aug 23, 2022

some way to pick the right track harmonically #9896

Open

macrophone mentioned this pull request Sep 9, 2023

add a link to the camelot wheel in the interface #11950

Closed


		m_domDocument.save(stream, QDomNode::EncodingFromDocument);

		ui->graphic->load(str.toUtf8());

Add harmonic keywheel ui #1695

Add harmonic keywheel ui #1695

Conversation

poelzi commented May 31, 2018

Be-ing commented May 31, 2018

poelzi commented May 31, 2018

Be-ing commented May 31, 2018

poelzi commented Jun 1, 2018

Be-ing commented Jun 1, 2018

poelzi commented Jun 1, 2018

Be-ing commented Jun 1, 2018

esbrandt commented Jun 3, 2018 • edited Loading

daschuer commented Jun 3, 2018

Be-ing commented Jun 11, 2018

Be-ing commented Jun 11, 2018

Be-ing commented Jun 11, 2018

Be-ing commented Jun 23, 2018

poelzi commented Jun 25, 2018

Be-ing commented Jun 27, 2018

poelzi commented Jun 27, 2018 • edited Loading

Be-ing commented Jun 27, 2018

Holzhaus commented Feb 14, 2020

Be-ing commented Jan 24, 2021

poelzi commented Jan 24, 2021

daschuer commented Jan 25, 2021

poelzi commented Jan 25, 2021

daschuer Jan 25, 2021 • edited Loading

Choose a reason for hiding this comment

daschuer left a comment

Choose a reason for hiding this comment

daschuer Jan 25, 2021

Choose a reason for hiding this comment

poelzi Jan 25, 2021

Choose a reason for hiding this comment

daschuer Jan 25, 2021

Choose a reason for hiding this comment

poelzi Jan 25, 2021

Choose a reason for hiding this comment

poelzi commented Jan 25, 2021

daschuer commented Jan 27, 2021

daschuer commented Jan 27, 2021

poelzi commented Feb 4, 2021

poelzi commented Feb 4, 2021

daschuer left a comment

Choose a reason for hiding this comment

ronso0 commented Feb 6, 2021

poelzi commented Feb 6, 2021

esbrandt commented Feb 7, 2021

esbrandt Feb 7, 2021

Choose a reason for hiding this comment

poelzi commented Feb 8, 2021

esbrandt commented Jun 3, 2018 •

edited

Loading

poelzi commented Jun 27, 2018 •

edited

Loading

daschuer Jan 25, 2021 •

edited

Loading