sgio.plot_pyvista_local_axes#

sgio.plot_pyvista_local_axes(vtm_file: str | Path, *, max_local_axes: int = 500, output_html: str | Path | None = None, show: bool = False) → pyvista.Plotter#

Plot a VTM mesh scene with sampled element local-axis glyphs.

Parameters:

  • vtm_file (str or pathlib.Path) – VTM file created by create_pyvista_local_axis_multiblock(). It must contain mesh, local_y1, local_y2, and local_y3 blocks.

  • max_local_axes (int, optional) – Maximum number of source cells rendered as local-axis glyphs. The VTM remains complete; this limit applies only to this interactive scene. Default is 500.

  • output_html (str or pathlib.Path, optional) – Write a self-contained interactive HTML file. The output includes browser-native local-axis legend and interaction help.

  • show (bool, optional) – Open PyVista’s desktop window before returning. Default is False.

Returns:

Plotter containing the mesh and sampled red, green, and blue glyphs.

Return type:

pyvista.Plotter

Raises:

  • ImportError – If the optional pyvista dependency is not installed.

  • FileNotFoundError – If vtm_file does not exist.

  • ValueError – If the VTM scene or local-axis limit is invalid.