Expose the Scene Navigation progress bar to the API allowing developers to display percentage progress for various long-running actions.

[aaclayton]

Originally in GitLab by @adamoresten

Feature Summary

In some cases, module creators may be executing large scale operations in Foundry, and it would be useful to be able to display a progress bar to let the user know how the operation is progressing. Extending this further to supporting multiple progress bars would perhaps be useful as well, so that the progress of multiple operations can be communicated.

User Experience

A module would instantiate a ProgressBar class, which would create a progress bar that's displayed at the top of the canvas, in addition to any others already there. This class would have simple functions such as setPercentage (accepting a single percentage value) and setPercentageFromTotal (accepting current value and total value).

If a class such as this would be out of scope, a simple static interface would also suffice, though one could argue that the interface in place (however "private") captures the feature already.

Priority/Importance

Low. This interface is a definite low priority as it might be useful for only a small demographic of module creators.

[aaclayton]

I agree this is a nice suggestion and would be helpful to allow module developers to reuse this progress bar for other things.

[aaclayton]

Simple solution for now leaving room for a more sophisticated interface in the future:

SceneNavigation.displayProgressBar({label, pct});