Files
make-cad/docs/api/render_entity_map_rpath.md
T
Ni Jingzhe 8621f3d870 Add replayable surface modeling APIs (#4)
* Fix workplane replay and BREP entity maps

* feat: add replayable surface modeling APIs
2026-08-05 21:34:10 +08:00

1.3 KiB

render_entity_map_rpath

API Definition

def render_entity_map_rpath(model_or_path: BRepModel | TopoDS_Shape | str | Path, entity_ids: Sequence[str], output_path: str | Path, *, title: str = 'BREP entity map', views: Sequence[tuple[float, float, str]] = DEFAULT_VIEWS, highlight_edge_width: float = 6.0, highlight_point_size: float = 18.0, 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, context_opacity: float = 1.0, label_mode: Literal['auto', 'callout', 'legend', 'none'] = 'legend', max_callouts: int = 4, legend_columns: int = 3) -> Path

Source: inspect/brep/render.py

Import Surface

  • inspection namespace: from simplecadapi.inspect import brep then brep.render_entity_map_rpath(...); unavailable inside GraphSession/@model

Description

Render stable BREP entity IDs without flattening model depth.

The base model stays opaque by default and keeps its true BREP edges. Bodies use colored topology edges, faces use a restrained translucent tint plus boundary edges, edges use thick curves, and vertices use colored points. highlight_edge_width and highlight_point_size make selected edges and vertices visually dominant. A dedicated ID/type key is the safe default; callouts remain available for focused selections.