Function clash

src/ifcquery/ifcquery/clash.py:98–180

Check element for geometric clashes against other elements. :param model: The IFC model. :param element: The element to check. :param clearance: Minimum clearance distance; if provided, runs clearance check. :param tolerance: Intersection tolerance in meters (default 0.002). :pa

(
    model: ifcopenshell.file,
    element: ifcopenshell.entity_instance,
    clearance: float | None = None,
    tolerance: float = 0.002,
    scope: str = "storey",
)

def clash(
    model: ifcopenshell.file,
    element: ifcopenshell.entity_instance,
    clearance: float | None = None,
    tolerance: float = 0.002,
    scope: str = "storey",
) -> dict[str, Any]:
    """Check element for geometric clashes against other elements.

    :param model: The IFC model.
    :param element: The element to check.
    :param clearance: Minimum clearance distance; if provided, runs clearance check.
    :param tolerance: Intersection tolerance in meters (default 0.002).
    :param scope: Which elements to check against: "storey" or "all".
    :return: Dict with clash results suitable for JSON serialization.
    """
    result: dict[str, Any] = {"element": _ref(element)}

    # Get scope elements
    scope_elements, effective_scope = _get_scope_elements(model, element, scope)
    result["scope"] = effective_scope

    if not scope_elements:
        result["pass"] = True
        result["checks"] = {"intersection": {"pass": True, "tolerance": tolerance, "clashes": []}}
        if clearance is not None:
            result["checks"]["clearance"] = {"pass": True, "clearance": clearance, "clashes": []}
        return result

    # Build geometry tree for target element + scope elements
    all_elements = scope_elements | {element}
    geom_tree = _build_tree(model, all_elements)

    if geom_tree is None:
        result["pass"] = None
        result["error"] = f"No geometry for element #{element.id()}"
        return result

    # Run intersection check
    intersection_clashes = geom_tree.clash_intersection_many(
        [element], list(scope_elements), tolerance=tolerance, check_all=True
    )
    intersection_results = [_format_clash(c, geom_tree, model) for c in intersection_clashes]
    checks: dict[str, Any] = {
        "intersection": {
            "pass": len(intersection_results) == 0,
            "tolerance": tolerance,
            "clashes": intersection_results,
        }
    }

    all_pass = len(intersection_results) == 0

    # Run clearance check if requested
    if clearance is not None:
        clearance_clashes = geom_tree.clash_clearance_many(
            [element], list(scope_elements), clearance=clearance, check_all=True
        )