March 21, 2023
Note: The add-on provides comprehensive documentation as well. You can find it in Unity in path: MindPort → VR Builder → Add-ons → ProcessMenu → Documentation
This add-on provides examples on how to build a menu that allows to control the process execution in VR Builder. The menu allows to display the current step and its description, skip it by choosing a transition, switch chapters or restart the process.
Two prefabs are included. One displays the menu on the desktop screen, allowing an external person to control the process. This can be useful for example in training scenarios with a trainee in VR and a trainer at the computer. The other displays the menu in VR, floating in front of the user. This can be useful for standalone headsets, which lack a flat screen view, or in cases where the user is supposed to control the process themselves.
This add-on requires VR Builder version 2.3.1 or later to work.
Drag one of the prefabs in the Prefabs folder in your process scene. The menu will appear when pressing Play. Feel free to try it out with the demo scene included in VR Builder!
The process starts automatically in VR Builder. If you want the process to be started from the menu, you will have to provide a custom [PROCESS_CONTROLLER]. You can find more information on how to do so here.
The desktop process menu is laid out as follows.
The desktop menu can be used by clicking with the mouse on the desired option.
The standalone process menu is laid out as follows.
By default, the standalone menu will stay where it is placed in the scene. Alternatively, it is possible for it to appear next to the user at the press of a button. To do so, add the Standalone Menu Handler component to the menu prefab.
In the inspector, it is possible to select which button can be used to open and close the menu. The Standalone Menu Handler also takes care of repositioning the menu in front of the user every time it is opened.
The standalone menu can be interacted with by pointing at it with a ray and pressing the trigger button.
The process controller can be configured on the [PROCESS_CONTROLLER] game object in a VR Builder scene. This object handles running the process and a few configuration parameters. The Process Controller Setup script lets you choose which process controller prefab is spawned when the scene runs.
It is possible to select one of the default process controller prefabs, or use a custom one by ticking the Use custom prefab box.
Both default process controllers automatically start the process when the scene runs. If you want to avoid that, so the process can be started from the menu, you'll have to create a custom process controller prefab. You can use one of the default ones found in Assets\MindPort\VR Builder\Core\Source\Basic-UI-Component\Runtime\ProcessController\Resources\Prefabs as a baseline.
The Basic Process Loader component ensures the process runs on scene start. To prevent this behavior, do not include this script in your custom controller.