Skip to main content

render_shape_views_rpath

Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import render_shape_views_rpath

Signature

def render_shape_views_rpath(shape: 'TopoDS_Shape', output_path: 'str | Path', *, title: 'str' = 'BREP views', 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, show_brep_edges: 'bool' = True) -> 'Path'

Description

Render smooth shaded BREP views with true topology edges by default.

Render smooth shaded BREP views with true topology edges by default.

show_brep_edges draws exact topological edges sampled from the BREP; it never exposes the internal triangle edges used by the GPU.

Parameters

NameTypeRequiredDefaultSource description
shape'TopoDS_Shape'yes-Not explicitly described in the source docstring.
output_path'str | Path'yes-Not explicitly described in the source docstring.
title'str'no'BREP views'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'no180Not explicitly described in the source docstring.
linear_deflection'float'no0.12Not explicitly described in the source docstring.
angular_deflection'float'no0.18Not explicitly described in the source docstring.
show_brep_edges'bool'noTrueNot 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_shape_views_rpath

See also