The Predict Engine overlay is a texture containing the Predict Engine render and appearing in front of the Unity render in the Game view. It is best fitted to be included in applications or to work with scripted user interactions. It works in the following way :
(1) : The 3D scene (cameras, geometries, lights, environments) is defined and constructed entirely in Unity,
(2) : Additional settings specific to Predict Engine can be defined using specific components,
(3) : The overlay mode is enabled via the menu "PredictSuite/Engine/Game Overlay/Enabled", and the application is started as usual in Unity, Predict Engine is started in the background and starts loading the scene,
(4) : When the scene is loaded, the Predict Engine simulation appears in front of the Unity render in the Game tab. If the Game camera moves or if interactive settings are edited by script or manually, the Predict Engine render will be updated automatically.
The Predict Engine overlay can also be enabled and disabled via scripting.
When using the Predict Engine overlay, a "Screen Overlay" component is added on the camera. The component contains shortcuts to the overlay preferences and a button to toggle the overlay visibility.