yapcad.boolean package

Submodules

yapcad.boolean.native module

Native boolean engine extracted from yapcad.geom3d.

yapcad.boolean.native.invalidate_surface_octree(s)

yapcad.boolean.native.solid_boolean(a, b, operation, tol=1e-07, *, stitch=False)

yapcad.boolean.native.solid_contains_point(sld, p, tol=1e-07)

yapcad.boolean.native.solids_intersect(a, b, tol=1e-07)

yapcad.boolean.native.stitch_open_edges(triangles, tol)

Experimental: attempt to close open edge loops by triangulating them.

Parameters:

• triangles (Iterable) – A sequence of triangle coordinate lists [[x, y, z, w], ...] describing a mesh with potential boundary edges.

• tol (float) – Tolerance used when deduplicating vertices and detecting shared edges. Typically reuse _DEFAULT_RAY_TOL.

Returns:

A new list of triangles with any stitched faces appended.

Return type:

list

yapcad.boolean.native.stitch_solid(sld, tol=1e-07)

Experimental helper that runs stitch_open_edges() on a solid.

yapcad.boolean.native.surface_octree(s, rebuild=False)

yapcad.boolean.occ_engine module

OCC-backed boolean engine operating on BrepSolid metadata.

yapcad.boolean.occ_engine.is_available() → bool

yapcad.boolean.occ_engine.solid_boolean(a, b, operation: str)

Perform an OCC boolean, falling back to mesh engine if BREP unavailable.

Handles both single-solid results and compound results (e.g., union of disconnected solids produces a compound containing multiple solids).

For union operations, includes sanity check: if the result volume is significantly less than expected (more than 10% loss), falls back to creating a simple compound containing both shapes. This works around OCC boolean issues with certain lofted/swept shapes.

If either solid lacks BREP metadata, automatically falls back to the native mesh boolean engine rather than raising an error.

yapcad.boolean.trimesh_engine module

Trimesh-backed boolean engine for yapCAD solids.

This engine is optional. It converts yapCAD solids to trimesh.Trimesh instances, dispatches boolean operations via trimesh.boolean, and converts the resulting mesh back into a yapCAD solid.

Availability depends on both the trimesh package and at least one boolean backend supported by trimesh (e.g. Blender, OpenSCAD, Cork).

yapcad.boolean.trimesh_engine.engines_available() → set[str]

Return the set of trimesh boolean backends that are operational.

yapcad.boolean.trimesh_engine.is_available(backend: str | None = None) → bool

Check whether the engine can run (trimesh + backend present).

yapcad.boolean.trimesh_engine.solid_boolean(a, b, operation: str, tol=1e-07, *, stitch: bool = False, backend: str | None = None)

Perform a boolean between a and b using trimesh.

Module contents

yapcad.boolean.get_engine(name: str)