API Browser Revamp: Search Feedback

[aaronventure]

Since the API browser is getting some love, here are my search suggestions:

the order of the results is a bit weird. it seems to follow the class names alphabetically, even though some results are irrevelavnt.

if I want to isolate just the class, I would add a . after the input. This sometimes works

and sometimes it doesn't

Should the API browser have a consistent and reliable search/filtering behavior?

[Christoph Hart]

@aaronventure Yeah good idea. I've changed it so that it prioritizes exact matches over occurences somewhere in the class name, so typing Sample will show the Sample and Sampler class before the other classes and methods that contain this string (eg. AudioSampleProcessor`).

I've also added a few other polishes:

• the font size of the doc popup scales with the font size of the code editor
• Pressing escape will close the popup and move the focus back to the code editor
• you can right or left click now to show the popup (since it's the single function). The code insertion is now only triggered by hitting return as using the double click cause many accidental triggers of that function which was super annoying.

[d.healey]

@Christoph-Hart said in API Browser Revamp: Search Feedback:

The code insertion is now only triggered by hitting return

Just did a quick test and it's inserting the code at the top of the editor rather than at the cursor position.

Also the module tree looks weird.

Also why did you remove the module browser? I use it often to look up magic numbers, what is the replacement?

[Christoph Hart]

Just did a quick test and it's inserting the code at the top of the editor rather than at the cursor position.

Ah yes, that's a glitch that I could not reliably reproduce, but I think once you have more than one line it works.

Also why did you remove the module browser?

Because I noticed that with a fresh HISE installation it builds up a database by loading each module once, reads out the elements then deletes it again which crashed my system once I've run it again and the idea that this is the first time experience of HISE users made me go nuclear on the entire thing.

I use it often to look up magic numbers, what is the replacement?

We definitely need a replacement as I was using it for the exact same feature, but I think we can move that functionality into a context menu of the patch browser as you will only use it with modules that you have already loaded, right?

Also the module tree looks weird.

That's your fault why are you using so many global connections? Jokes aside, it might be a good idea to remove that visualisation once the connection amount exceeds sane numbers...

[d.healey]

@Christoph-Hart said in API Browser Revamp: Search Feedback:

Ah yes, that's a glitch that I could not reliably reproduce, but I think once you have more than one line it works.

I tested this in the middle of one of my scripts and it jumps up to the top.

@Christoph-Hart said in API Browser Revamp: Search Feedback:

We definitely need a replacement as I was using it for the exact same feature, but I think we can move that functionality into a context menu of the patch browser as you will only use it with modules that you have already loaded, right?

That would work, the only other time I find it useful is when using Synth.getIdList() and I can't remember the exact name I need to pass as a parameter, for example is it MidiMuter, MIDI Muter, MIDIMuter... I'm sure it's one of those :)

@Christoph-Hart said in API Browser Revamp: Search Feedback:

It might be a good idea to remove that visualisation once the connection amount exceeds sane numbers

Yeah I never really benefited from them anyway. If you only have a few connections then you don't need the lines to tell you that, and if you have a lot of connections the lines become a mess. Maybe a better solution would be something similar to the broadcaster map.

Also this grey on grey is a little hard to read for my not-so-old eyes.

[Christoph Hart]

@d-healey said in API Browser Revamp: Search Feedback:

Yeah I never really benefited from them anyway. If you only have a few connections then you don't need the lines to tell you that, and if you have a lot of connections the lines become a mess.

Yup, in the spirit of removing stuff that isn't very useful, be gone global mod connection display!

[Christoph Hart]

@Christoph-Hart Oh and I've added the parameter dump function. Just right click on the patch browser (when it's not in edit mode), then choose Dump Parameter IDs & values to see this:

That should give you the magic numbers you need (plus it might come handy in other use cases, who knows)...

[d.healey]

@Christoph-Hart Nice!

[aaronventure]

@d-healey said in API Browser Revamp: Search Feedback:

I tested this in the middle of one of my scripts and it jumps up to the top.

Still happens.

Maybe a we could get a way to copy it to clipboard as well/instead.

macOS

[d.healey]

@aaronventure Yeah it's strange because in versions of HISE gone by it worked fine with a double click.

[Christoph Hart]

@d-healey should be fixed now.

[d.healey]

@Christoph-Hart Yep, working here, thanks!