QA tabbed UI release (0.2.0)

This is a bucket list for QA that should be done for the next release, which I'll ship as 0.2, because it contains a fairly wide-reaching UI change that will also impact downstream tutorials, videos, etc.

An extremely large amount of code changes have happened over the last month or so in order to ready the UI architecture for the next batch of features, panels, and custom UIs.

These are the test scenarios that should be manually tested (automating this is non-trivial):

Top-level Checks

[ ] A fresh install has reasonable-ish panel locations
[ ] The tabbed UI doesn't screw with the panel locations
[ ] All user-facing tutorial documentation can be carried out end-to-end without any confusion, surprises, or crashes
[ ] Can edit the coordinates of an existing model without any issues
[ ] Can add any component type into the model without any obvious issues (having incorrect default values etc. is permissable because that's a backend issue that needs to be manually patched later)
[ ] All component actions (e.g. adding subcomponents, isolation, etc.) work as expected in the editor
[ ] Can simulate any model with a forward-dynamic simulator. All example models simulate fine.
[ ] The simulator can be stopped/cancelled by simply closing the simulation tab
[ ] The number of simulation reports is as-expected (inclusive time range, one report at start, one report per report interval, one report at end)
[ ] Can request to monitor model outputs, and they are then shown in the simulator tab
[ ] Can play with the EXPERIMENTAL muscle plotting feature
[ ] It's mentioned somewhere that this is experimental and is pending further support/feedback
[ ] The 3D viewers have the option to customize how muscles are visualized/decorated. This works in both the simulator and editor screen
[ ] All links in about, experimental screens, install dir, user dir, websites, etc. work
[ ] The "select muscle" part of the add muscle plot EXPERIMENTAL feature says "no muscles" if used on a model with no muscles
[ ] All experimental screens are exit-able with ESC
[ ] Any defaulted names (coord names, etc.) should be within expectations
[ ] Adding new components should default any weird property names to something sane
[ ] The "save coordinate edits" feature works as expected

Mesh Importer Checks

[ ] Can create a model in the mesh importer that contains cyclical joint graphs (e.g. robot model with multiple feet)
[ ] The mesh importer scene always exports 1:1 to an OpenSim model without moving/rotating anything in an unusual way
[ ] The mesh importer scene can always be exported into a mesh editor tab
[ ] The mesh importer scene can be exported to an osim
[ ] Exporting to an osim clears the dirty flag
[ ] All user-visible keybinds in the mesh importer work as expected
[ ] All user-visible buttons work as expected
[ ] Scene scale factors (e.g. for tiny insect models) are exported to the model editor screen
[ ] Visibility, interactivity, etc. buttons in the mesh importer all work as expected
[ ] It's possible to open multiple mesh importers (tabbed interface)
[ ] Doing anything in one mesh importer tab has no effect on the others. E.g. mouse interaction, keybinds, drag & drop should only affect the currently-open mesh importer tab

Model Editor Checks

[ ] All contextual actions work for common component types
[ ] Deletion kind of works for things like muscles, etc.
[ ] When deletion doesn't work, it prints an error to the log
[ ] Can add almost any component type via the UI buttons
[ ] Most components have a basic help tool-tip that explains what the component does
[ ] All buttons in the main menu work as expected
[ ] The coordinate editor works as expected
[ ] All modals have a clear cancellation button that works
[ ] Modal content is correct
[ ] Can have multiple 3D viewports open. They operate completely independently of eachover (ignoring scale fixups)

Simulator Checks

[ ] The hierarchy panel works as expected
[ ] The selection details panel works as expected
[ ] The outputs listing in the selection details panel allows for CSV (+open) support
[ ] The outputs listing also enables "watching" the output, which adds it to the outputs watch list
[ ] The simulation details panel works as expected
[ ] The walltime/step walltime values are within the expected range (i.e. perf hasn't tanked)
[ ] Any plot in the simulation details panel can be exported to CSV (+opened?)
[ ] All plots can be exported to a single CSV
[ ] 3D viewports in the simulator tab shows similar options to in the editor screen (i.e. the ones that make sense)
[ ] The simulator tab scrubber works mostly as expected (work in progress :wink:)
[ ] An STO file can be imported from OpenSim 4.0, 4.1, 4.2, 4.3, and 4.4 (beta)
[ ] The performance panel (advanced) works as expected
[ ] The simulator panel doesn't cause adjacent panel resizing/closing to misbehave (because it not contains more custom UI widgets)

All of these should also be done while running libasan to catch memory errors.

Linux /w libASAN:

Top-level Checks

[x] A fresh install has reasonable-ish panel locations
[x] The tabbed UI doesn't screw with the panel locations
[ ] All user-facing tutorial documentation can be carried out end-to-end without any confusion, surprises, or crashes
[x] Can edit the coordinates of an existing model without any issues
[x] Can add any component type into the model without any obvious issues (having incorrect default values etc. is permissable because that's a backend issue that needs to be manually patched later)
[x] All component actions (e.g. adding subcomponents, isolation, etc.) work as expected in the editor
[x] Can simulate any model with a forward-dynamic simulator. All example models simulate fine.
[x] The simulator can be stopped/cancelled by simply closing the simulation tab
[x] The number of simulation reports is as-expected (inclusive time range, one report at start, one report per report interval, one report at end)
[x] Can request to monitor model outputs, and they are then shown in the simulator tab
[x] Can play with the EXPERIMENTAL muscle plotting feature
[ ] It's mentioned somewhere that this is experimental and is pending further support/feedback
[x] The 3D viewers have the option to customize how muscles are visualized/decorated. This works in both the simulator and editor screen
[x] All links in about, experimental screens, install dir, user dir, websites, etc. work
[x] The "select muscle" part of the add muscle plot EXPERIMENTAL feature says "no muscles" if used on a model with no muscles
[x] All experimental screens are exit-able with ESC
[x] Any defaulted names (coord names, etc.) should be within expectations
[x] Adding new components should default any weird property names to something sane
[x] The "save coordinate edits" feature works as expected NOT APPLICABLE

Mesh Importer Checks

[x] Can create a model in the mesh importer that contains cyclical joint graphs (e.g. robot model with multiple feet)
[x] The mesh importer scene always exports 1:1 to an OpenSim model without moving/rotating anything in an unusual way
[x] The mesh importer scene can always be exported into a mesh editor tab
[x] The mesh importer scene can be exported to an osim
[x] Exporting to an osim clears the dirty flag
[x] All user-visible keybinds in the mesh importer work as expected
[x] All user-visible buttons work as expected
[x] Scene scale factors (e.g. for tiny insect models) are exported to the model editor screen
[x] Visibility, interactivity, etc. buttons in the mesh importer all work as expected
[x] It's possible to open multiple mesh importers (tabbed interface)
[x] Doing anything in one mesh importer tab has no effect on the others. E.g. mouse interaction, keybinds, drag & drop should only affect the currently-open mesh importer tab

Model Editor Checks

[x] All contextual actions work for common component types
[x] Deletion kind of works for things like muscles, etc.
[x] When deletion doesn't work, it prints an error to the log
[x] Can add almost any component type via the UI buttons
[x] Most components have a basic help tool-tip that explains what the component does
[x] All buttons in the main menu work as expected
[x] The coordinate editor works as expected
[x] All modals have a clear cancellation button that works
[x] Modal content is correct
[x] Can have multiple 3D viewports open. They operate completely independently of eachover (ignoring scale fixups)

Simulator Checks

[x] The hierarchy panel works as expected
[x] The selection details panel works as expected
[x] The outputs listing in the selection details panel allows for CSV (+open) support
[x] The outputs listing also enables "watching" the output, which adds it to the outputs watch list
[x] The simulation details panel works as expected
[x] The walltime/step walltime values are within the expected range (i.e. perf hasn't tanked)
[x] Any plot in the simulation details panel can be exported to CSV (+opened?)
[x] All plots can be exported to a single CSV
[x] 3D viewports in the simulator tab shows similar options to in the editor screen (i.e. the ones that make sense)
[x] The simulator tab scrubber works mostly as expected (work in progress :wink:)
[x] An STO file can be imported from OpenSim 4.0, 4.1, 4.2, 4.3, and 4.4 (beta)
[x] The performance panel (advanced) works as expected
[x] The simulator panel doesn't cause adjacent panel resizing/closing to misbehave (because it not contains more custom UI widgets)

A few minor bugs were found during Linux QA. Some of them (#290 #297 #300 #304 #305) have been put into separate tickets.

The entire Linux QA session was ran in debug mode with all assertions turned on and compiled with libASAN to ensure that the UI doesn't commit any obvious memory violations. Any memory leaks in OSC itself have been plugged and any upstream OpenSim memory leaks are to be upstreamed to OpenSim itself.

Mac checks

Top-level Checks

[x] A fresh install has reasonable-ish panel locations
[x] The tabbed UI doesn't screw with the panel locations
[ ] All user-facing tutorial documentation can be carried out end-to-end without any confusion, surprises, or crashes
[x] Can edit the coordinates of an existing model without any issues
[ ] Can add any component type into the model without any obvious issues (having incorrect default values etc. is permissable because that's a backend issue that needs to be manually patched later)
[ ] All component actions (e.g. adding subcomponents, isolation, etc.) work as expected in the editor
[ ] Can simulate any model with a forward-dynamic simulator. All example models simulate fine.
[x] The simulator can be stopped/cancelled by simply closing the simulation tab
[x] The number of simulation reports is as-expected (inclusive time range, one report at start, one report per report interval, one report at end)
[x] Can request to monitor model outputs, and they are then shown in the simulator tab
[x] Can play with the EXPERIMENTAL muscle plotting feature
[ ] It's mentioned somewhere that this is experimental and is pending further support/feedback
[x] The 3D viewers have the option to customize how muscles are visualized/decorated. This works in both the simulator and editor screen
[x] All links in about, experimental screens, install dir, user dir, websites, etc. work
[x] The "select muscle" part of the add muscle plot EXPERIMENTAL feature says "no muscles" if used on a model with no muscles
[x] All experimental screens are exit-able with ESC
[x] Any defaulted names (coord names, etc.) should be within expectations
[ ] Adding new components should default any weird property names to something sane
[ ] The "save coordinate edits" feature works as expected

Mesh Importer Checks

[x] Can create a model in the mesh importer that contains cyclical joint graphs (e.g. robot model with multiple feet)
[ ] The mesh importer scene always exports 1:1 to an OpenSim model without moving/rotating anything in an unusual way
[ ] The mesh importer scene can always be exported into a mesh editor tab
[ ] The mesh importer scene can be exported to an osim
[ ] Exporting to an osim clears the dirty flag
[ ] All user-visible keybinds in the mesh importer work as expected
[ ] All user-visible buttons work as expected
[ ] Scene scale factors (e.g. for tiny insect models) are exported to the model editor screen
[ ] Visibility, interactivity, etc. buttons in the mesh importer all work as expected
[ ] It's possible to open multiple mesh importers (tabbed interface)
[ ] Doing anything in one mesh importer tab has no effect on the others. E.g. mouse interaction, keybinds, drag & drop should only affect the currently-open mesh importer tab

Model Editor Checks

[ ] All contextual actions work for common component types
[ ] Deletion kind of works for things like muscles, etc.
[ ] When deletion doesn't work, it prints an error to the log
[ ] Can add almost any component type via the UI buttons
[ ] Most components have a basic help tool-tip that explains what the component does
[ ] All buttons in the main menu work as expected
[ ] The coordinate editor works as expected
[ ] All modals have a clear cancellation button that works
[ ] Modal content is correct
[x] Can have multiple 3D viewports open. They operate completely independently of eachover (ignoring scale fixups)

Simulator Checks

[x] The hierarchy panel works as expected
[x] The selection details panel works as expected
[x] The outputs listing in the selection details panel allows for CSV (+open) support
[x] The outputs listing also enables "watching" the output, which adds it to the outputs watch list
[x] The simulation details panel works as expected
[x] The walltime/step walltime values are within the expected range (i.e. perf hasn't tanked)
[x] Any plot in the simulation details panel can be exported to CSV (+opened?)
[x] All plots can be exported to a single CSV
[x] 3D viewports in the simulator tab shows similar options to in the editor screen (i.e. the ones that make sense)
[x] The simulator tab scrubber works mostly as expected (work in progress :wink:)
[x] An STO file can be imported from OpenSim 4.0, 4.1, 4.2, 4.3, and 4.4 (beta)
[x] The performance panel (advanced) works as expected
[x] The simulator panel doesn't cause adjacent panel resizing/closing to misbehave (because it not contains more custom UI widgets)

The mac build seems fine apart from #307 and #308 (minor). I'll fix #309 some other time

I left the best (Windows) to last ;)

Windows:

Top-level Checks

[x] A fresh install has reasonable-ish panel locations
[x] The tabbed UI doesn't screw with the panel locations
[ ] All user-facing tutorial documentation can be carried out end-to-end without any confusion, surprises, or crashes
[x] Can edit the coordinates of an existing model without any issues
[x] Can add any component type into the model without any obvious issues (having incorrect default values etc. is permissable because that's a backend issue that needs to be manually patched later)
[x] All component actions (e.g. adding subcomponents, isolation, etc.) work as expected in the editor
[x] Can simulate any model with a forward-dynamic simulator. All example models simulate fine.
[x] The simulator can be stopped/cancelled by simply closing the simulation tab
[x] The number of simulation reports is as-expected (inclusive time range, one report at start, one report per report interval, one report at end)
[x] Can request to monitor model outputs, and they are then shown in the simulator tab
[x] Can play with the EXPERIMENTAL muscle plotting feature
[ ] It's mentioned somewhere that this is experimental and is pending further support/feedback
[x] The 3D viewers have the option to customize how muscles are visualized/decorated. This works in both the simulator and editor screen
[x] All links in about, experimental screens, install dir, user dir, websites, etc. work
[x] The "select muscle" part of the add muscle plot EXPERIMENTAL feature says "no muscles" if used on a model with no muscles
[x] All experimental screens are exit-able with ESC
[x] Any defaulted names (coord names, etc.) should be within expectations
[x] Adding new components should default any weird property names to something sane
[x] The "save coordinate edits" feature works as expected

Mesh Importer Checks

[ ] Can create a model in the mesh importer that contains cyclical joint graphs (e.g. robot model with multiple feet)
[x] The mesh importer scene always exports 1:1 to an OpenSim model without moving/rotating anything in an unusual way
[x] The mesh importer scene can always be exported into a mesh editor tab
[x] The mesh importer scene can be exported to an osim
[ ] Exporting to an osim clears the dirty flag
[ ] All user-visible keybinds in the mesh importer work as expected
[ ] All user-visible buttons work as expected
[ ] Scene scale factors (e.g. for tiny insect models) are exported to the model editor screen
[ ] Visibility, interactivity, etc. buttons in the mesh importer all work as expected
[ ] It's possible to open multiple mesh importers (tabbed interface)
[ ] Doing anything in one mesh importer tab has no effect on the others. E.g. mouse interaction, keybinds, drag & drop should only affect the currently-open mesh importer tab

Model Editor Checks

[ ] All contextual actions work for common component types
[x] Deletion kind of works for things like muscles, etc.
[x] When deletion doesn't work, it prints an error to the log
[ ] Can add almost any component type via the UI buttons
[x] Most components have a basic help tool-tip that explains what the component does
[x] All buttons in the main menu work as expected
[x] The coordinate editor works as expected
[x] All modals have a clear cancellation button that works
[x] Modal content is correct
[x] Can have multiple 3D viewports open. They operate completely independently of eachover (ignoring scale fixups)

Simulator Checks

[x] The hierarchy panel works as expected
[x] The selection details panel works as expected
[x] The outputs listing in the selection details panel allows for CSV (+open) support
[x] The outputs listing also enables "watching" the output, which adds it to the outputs watch list
[x] The simulation details panel works as expected
[ ] The walltime/step walltime values are within the expected range (i.e. perf hasn't tanked)
[ ] Any plot in the simulation details panel can be exported to CSV (+opened?)
[ ] All plots can be exported to a single CSV
[ ] 3D viewports in the simulator tab shows similar options to in the editor screen (i.e. the ones that make sense)
[ ] The simulator tab scrubber works mostly as expected (work in progress :wink:)
[ ] An STO file can be imported from OpenSim 4.0, 4.1, 4.2, 4.3, and 4.4 (beta)
[ ] The performance panel (advanced) works as expected
[ ] The simulator panel doesn't cause adjacent panel resizing/closing to misbehave (because it not contains more custom UI widgets)

This was shipped and is fine

ComputationalBiomechanicsLab / opensim-creator