render_step_components_rpath
Kind: Function
Domain: Assembly
Canonical import: from cadflow.inspect.brep import render_step_components_rpath
Signature
def render_step_components_rpath(step_path: 'str | Path', component_names: 'Sequence[str]', output_path: 'str | Path', *, with_context: 'bool' = True, title: 'str | None' = None, views: 'Sequence[tuple[float, float, str]]' = ((28.0, -45.0, 'isometric'), (90.0, -90.0, 'top / X-Y'), (0.0, -90.0, 'front / X-Z'), (0.0, 0.0, 'side / Y-Z')), image_size: 'tuple[float, float]' = (18.0, 12.0), dpi: 'int' = 180, linear_deflection: 'float' = 0.12, angular_deflection: 'float' = 0.18) -> 'Path'
Description
Render named XCAF component occurrences, optionally in assembly context.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
step_path | 'str | Path' | yes | - | Not explicitly described in the source docstring. |
component_names | 'Sequence[str]' | yes | - | Not explicitly described in the source docstring. |
output_path | 'str | Path' | yes | - | Not explicitly described in the source docstring. |
with_context | 'bool' | no | True | Not explicitly described in the source docstring. |
title | 'str | None' | no | None | Not explicitly described in the source docstring. |
views | 'Sequence[tuple[float, float, str]]' | no | ((28.0, -45.0, 'isometric'), (90.0, -90.0, 'top / X-Y'), (0.0, -90.0, 'front / X-Z'), (0.0, 0.0, 'side / Y-Z')) | Not explicitly described in the source docstring. |
image_size | 'tuple[float, float]' | no | (18.0, 12.0) | Not explicitly described in the source docstring. |
dpi | 'int' | no | 180 | Not explicitly described in the source docstring. |
linear_deflection | 'float' | no | 0.12 | Not explicitly described in the source docstring. |
angular_deflection | 'float' | no | 0.18 | Not explicitly described in the source docstring. |
Returns
Type: 'Path'
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.inspect.brep import render_step_components_rpath