capture_sweep
Capture many viewport shots in one job, each with its own camera pose, lens, variant selections and timeline time, to inspect a scene's looks from many viewpoints at once.
Instructions
Capture many shots in one call, each with its own camera pose, lens, variant selections and timeline time, as a job: for checking a scene's looks and switches from many viewpoints, where one capture_viewport a picture costs a turn each. Answers the job's id and folder at once.
A shot is a position with yaw and pitch (yaw about the up axis, 0 along +X; pitch -90 looks straight down), a position with a target, or camera_path, a camera of the stage rendered as it is. Its lens is focal_length and the apertures in mm, the vertical one fitted to the image when left out; one that doesn't fit the image's shape is refused. selections switch variant sets for the shot alone, in the session layer, which no save writes; time sets the timeline. Every shot is checked before anything changes.
Kit writes each shot's PNG and a manifest.json, each shot's pose, lens, selections, time and file, into mcp_output/sweeps//. Read it with get_job(id, wait=100): shot 37 of 400 as it goes, then one line naming the folder and the shots that came out black or failed. A sweep's manifest.json given as shots_file takes the same shots again, given the first sweep's width and height, on this scene after a change or on another built from the same spec. Afterwards every layer, the timeline and the selections are as they were, after cancel_job too, which keeps the shots taken. A time repeats time-sampled animation; Replicator's walking agents move on each update whatever the time, so stop the timeline (sim_control) for shots of them that repeat. One size for all the shots; one job runs at a time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The sweep's folder in mcp_output/sweeps/: letters, digits, '.', '_', '-' and spaces; the time when empty. A folder that holds a sweep already is refused | |
| shots | No | The shots, in order, up to 2,000; give this or shots_file | |
| width | No | Every picture's width in pixels, up to 4096 | |
| height | No | Every picture's height in pixels, up to 4096 | |
| shots_file | No | A JSON file on this server's machine holding a list of shots, or a sweep's manifest.json to take its shots again; give this or shots |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |