render_screenshot_rpath
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import render_screenshot_rpath
Signature
def render_screenshot_rpath(shapes: 'Union[Solid, Sequence[Solid]]', output_path: 'str', highlight_tags: 'Optional[Sequence[str]]' = None, tag_labels: 'Optional[Dict[str, str]]' = None, image_size: 'Tuple[int, int]' = (1400, 900), view: 'Union[Tuple[float, float], str]' = 'auto', show_axes: 'bool' = True, show_legend: 'bool' = True, zoom: 'float' = 4.0, show_callouts: 'bool' = True, tag_colors: 'Optional[Dict[str, Tuple[float, float, float]]]' = None, background_color: 'Optional[Tuple[float, float, float]]' = None, show_edges: 'bool' = True) -> 'str'
Description
Render SDK solids through the shared OCCT/VTK BREP renderer.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
shapes | 'Union[Solid, Sequence[Solid]]' | yes | - | Not explicitly described in the source docstring. |
output_path | 'str' | yes | - | Not explicitly described in the source docstring. |
highlight_tags | 'Optional[Sequence[str]]' | no | None | Not explicitly described in the source docstring. |
tag_labels | 'Optional[Dict[str, str]]' | no | None | Not explicitly described in the source docstring. |
image_size | 'Tuple[int, int]' | no | (1400, 900) | Not explicitly described in the source docstring. |
view | 'Union[Tuple[float, float], str]' | no | 'auto' | Not explicitly described in the source docstring. |
show_axes | 'bool' | no | True | Not explicitly described in the source docstring. |
show_legend | 'bool' | no | True | Not explicitly described in the source docstring. |
zoom | 'float' | no | 4.0 | Not explicitly described in the source docstring. |
show_callouts | 'bool' | no | True | Not explicitly described in the source docstring. |
tag_colors | 'Optional[Dict[str, Tuple[float, float, float]]]' | no | None | Not explicitly described in the source docstring. |
background_color | 'Optional[Tuple[float, float, float]]' | no | None | Not explicitly described in the source docstring. |
show_edges | 'bool' | no | True | Not explicitly described in the source docstring. |
Returns
Type: 'str'
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
- This operation writes an external artifact. Validate the returned path or output file before delivery.
Import check
from cadflow import render_screenshot_rpath