Skip to content
brep-conformancegithub

difference

Booleans · api.md § difference · all operations

difference(a: Solid, b: Solid) -> Solid

Cuts one solid from another. Returns the regularized a ∖ b, where a ∖ b is what a holds and b does not.

Example. Solid 1 is a 10 × 20 × 30 mm box with one corner at the origin. Solid 2 is a cylinder of radius 5 and height 20 on the z axis.

> {"cmd": "difference", "a": 1, "b": 2}
< {"ok": 3}

Every boolean returns the regularized set operation, which is the closure of the interior of the set result. The result may be empty. It may also be several pieces, touching as Types allows. Pieces that share an area of boundary are returned as one. The operands are left as they were.

FunctionFieldsReturns
uniona, bSolid
intersectiona, bSolid
differencea, bSolid
union_allsolidsSolid
difference_alltarget, toolsSolid