render_region_rpath
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import render_region_rpath
Signature
def render_region_rpath(model_or_path: 'BRepModel | TopoDS_Shape | str | Path', entity_ids: 'Sequence[str]', output_path: 'str | Path', *, neighborhood_depth: 'int' = 0, title: 'str' = 'Highlighted BREP region', 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, edge_samples: 'int' = 96, highlight_edge_width: 'float' = 6.0, highlight_point_size: 'float' = 18.0) -> 'Path'
Description
Highlight stable entities and their optional topology neighborhood.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
model_or_path | 'BRepModel | TopoDS_Shape | str | Path' | yes | - | Not explicitly described in the source docstring. |
entity_ids | 'Sequence[str]' | yes | - | Not explicitly described in the source docstring. |
output_path | 'str | Path' | yes | - | Not explicitly described in the source docstring. |
neighborhood_depth | 'int' | no | 0 | Not explicitly described in the source docstring. |
title | 'str' | no | 'Highlighted BREP region' | 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. |
edge_samples | 'int' | no | 96 | Not explicitly described in the source docstring. |
highlight_edge_width | 'float' | no | 6.0 | Not explicitly described in the source docstring. |
highlight_point_size | 'float' | no | 18.0 | 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_region_rpath