compile_scene
Kind: Function
Domain: Scene and artifacts
Canonical import: from cadflow import compile_scene
Signature
def compile_scene(*, scene_id: 'str', roots: 'Sequence[SceneRoot]', source: 'SceneSource | ModelResult | None' = None, presentation: 'Any' = None, options: 'SceneCompileOptions | None' = None) -> 'CompiledScenePackage'
Description
Public function in the CadFlow scene and artifacts API.
Other public imports
from cadflow.scene import compile_scene
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
scene_id | 'str' | yes | - | Not explicitly described in the source docstring. |
roots | 'Sequence[SceneRoot]' | yes | - | Not explicitly described in the source docstring. |
source | 'SceneSource | ModelResult | None' | no | None | Not explicitly described in the source docstring. |
presentation | 'Any' | no | None | Not explicitly described in the source docstring. |
options | 'SceneCompileOptions | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'CompiledScenePackage'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import compile_scene