Skip to content

Workflows Configuration

ProStream's Workflows control how specific types of objects (like instance objects and colliders) are processed and converted into streaming subscenes. This guide explains how to enable, disable, and configure these workflows within the ProStream Editor.

Accessing the Workflows Panel

To view and manage your workflows:

  1. Open the ProStream Editor (Tools | instance.id | ProStream | ProStream Editor).
  2. Navigate to the Scene Setup tab.
  3. Scroll down to the Workflows or Workflow Settings section.

Here, you will see a list of all available WorkflowAssets in your project.

Enabling and Disabling Workflows

Each workflow has two primary toggles:

  • Activate Workflow: If disabled, the workflow is completely ignored by the current scene. No component will be created, and it will not participate in the Prepare Scene or Create SubScenes processes.
  • Enable Workflow: Often used as a secondary toggle within an active workflow to temporarily suspend its processing logic without removing it from the scene's tracked components.

When you toggle Activate Workflow to true, ProStream automatically instantiates a WorkflowComponent under the SceneConnector's WorkflowContainer in your active scene.

InstanceObjectsWorkflow Settings

The InstanceObjectsWorkflow is the primary workflow for spatial organization. It is responsible for generating the QuadTree grid that determines the physical boundaries of your SubScenes.

See the InstanceObjects Workflow guide for the full end-to-end process.

QuadTree Configuration

When configuring the InstanceObjectsWorkflow, you will see settings specifically for the QuadTree. Unlike traditional grid systems, ProStream automatically determines the total bounds of your QuadTree based on the objects in your scene. You do not need to manually configure grid widths or cell sizes.

Instead, the QuadTree is built dynamically based on how you want objects distributed:

  • Use QuadTree: Ensure this is enabled (true) if you want ProStream to automatically slice your scene into spatial chunks.
  • Max Objects Per Node: The target threshold for how many objects should be allowed in a single QuadTree cell before it attempts to subdivide further.
  • Max QuadTree Depth: How many times a cell is allowed to subdivide recursively. A higher depth allows for smaller cells.
  • Auto Adjust Max Depth: If enabled, ProStream will automatically calculate and increase the QuadTree depth until the average number of objects per node falls below your Max Objects Per Node threshold. This is the recommended setting for most scenes.

Real-Time QuadTree Updates

One of the powerful features of ProStream's workflow settings is real-time visualization. When you adjust the QuadTree settings (like dragging the Max Objects Per Node value or toggling Auto depth), ProStream automatically and instantly recalculates the QuadTree in the background.

If you have the visualization options turned on (via the menu icon next to the setting), you will see the QuadTree grid adapt in the Scene View immediately as you change the values. You do not need to manually re-run Calculate Positions just to see the updated grid boundaries.

ColliderObjectsWorkflow Settings

The ColliderObjectsWorkflow targets physics colliders, but it is typically activated by enabling the Collider modification rather than by treating it as a standalone authoring path.

The workflow component exposes its own settings for:

  • Use QuadTree
  • Max Objects Per Node
  • Max QuadTree Depth
  • Auto Adjust Max Depth
  • Use Jobified Collider Builder
  • Scene Quadtree Divisor
  • Collider Processing Configuration

INFO

The collider workflow and the Collider modification work together. In practice, you configure the workflow's spatial behavior here, and you use the modification to decide whether collider-only scenes should be produced and whether the original colliders should also be removed from the Entity copies.

See the ColliderObjects Workflow guide for the full process and activation flow.

Note: DataObjectWorkflow and RemoteSceneWorkflow configurations will be documented in a future release.

ProStream - High-performance scene streaming for Unity