Function plot

src/ifcquery/ifcquery/plot.py:148–284

Plot IFC model as SVG (via ifcopenshell.draw) or PNG/base64 (via CairoSVG). Args: model: In-memory IFC model. output_format: 'svg' | 'png' | 'base64' - 'svg' -> returns SVG bytes - 'png' -> returns PNG bytes - 'base64'-> returns dict:

(
    model: ifcopenshell.file,
    *,
    output_format: str = "png",
    selector: str | None = None,
    element_ids: list[int] | None = None,
    view: str = "floorplan",
    # SVG / page sizing (draw works in mm coordinates)
    width_mm: float = 297.0,
    height_mm: float = 420.0,
    scale: float = 1.0 / 100.0,
    merge_projection: bool = True,
    # PNG sizing (only for output_format png/base64)
    png_width: int = 1024,
    png_height: int = 1024,
)

def plot(
    model: ifcopenshell.file,
    *,
    output_format: str = "png",
    selector: str | None = None,
    element_ids: list[int] | None = None,
    view: str = "floorplan",
    # SVG / page sizing (draw works in mm coordinates)
    width_mm: float = 297.0,
    height_mm: float = 420.0,
    scale: float = 1.0 / 100.0,
    merge_projection: bool = True,
    # PNG sizing (only for output_format png/base64)
    png_width: int = 1024,
    png_height: int = 1024,
) -> bytes | dict[str, Any]:
    """
    Plot IFC model as SVG (via ifcopenshell.draw) or PNG/base64 (via CairoSVG).

    Args:
        model: In-memory IFC model.
        output_format: 'svg' | 'png' | 'base64'
            - 'svg'   -> returns SVG bytes
            - 'png'   -> returns PNG bytes
            - 'base64'-> returns dict: {mime, png_b64, width, height, view}
        selector: ifcopenshell selector query to restrict plotted elements.
        element_ids: STEP ids to highlight; non-highlighted geometry is faded.
        view: One of VIEWS ('floorplan', 'elevation', 'section', 'auto').
        width_mm, height_mm: Page size in mm.
        scale: Model-to-paper scale (0.01 means 1:100).
        merge_projection: Passed through to ifcopenshell.draw.main.
        png_width, png_height: Raster size in pixels for png/base64 outputs.

    Raises:
        ImportError: if ifcopenshell.draw or CairoSVG is not available (as required).
        ValueError: invalid args or selector matches nothing.
    """
    if output_format not in OUTPUT_FORMATS:
        raise ValueError(f"output_format must be one of {OUTPUT_FORMATS}, got {output_format!r}")
    if view not in VIEWS:
        raise ValueError(f"view must be one of {VIEWS}, got {view!r}")
    if not _HAS_DRAW:
        raise ImportError("ifcopenshell.draw is not available in this environment.")

    # Configure draw settings
    settings = ifcopenshell.draw.draw_settings(
        auto_floorplan=(view in ("floorplan", "auto")),
        auto_elevation=(view in ("elevation", "auto")),
        auto_section=(view in ("section", "auto")),
        width=width_mm,
        height=height_mm,
        scale=scale,
        css="",
    )

    # Optional highlight CSS overlay
    if element_ids:
        settings.css = _highlight_css_from_ids(model, element_ids)