Method cut

cadquery/cq.py:3379–3413

Cuts the provided solid from the current solid, IE, perform a solid subtraction. :param toCut: a solid object, or a Workplane object having a solid :param clean: call :meth:`clean` afterwards to have a clean shape :param tol: tolerance value for fuzzy bool operation

(
        self: T,
        toCut: Union["Workplane", Solid, Compound],
        clean: bool = True,
        tol: Optional[float] = None,
    )

        return self.union(other)

    def cut(
        self: T,
        toCut: Union["Workplane", Solid, Compound],
        clean: bool = True,
        tol: Optional[float] = None,
    ) -> T:
        """
        Cuts the provided solid from the current solid, IE, perform a solid subtraction.

        :param toCut: a solid object, or a Workplane object having a solid
        :param clean: call :meth:`clean` afterwards to have a clean shape
        :param tol: tolerance value for fuzzy bool operation mode (default None)
        :raises ValueError: if there is no solid to subtract from in the chain
        :return: a Workplane object with the resulting object selected
        """

        # look for parents to cut from
        solidRef = self.findSolid(searchStack=True, searchParents=True)

        solidToCut: Sequence[Shape]

        if isinstance(toCut, Workplane):
            solidToCut = _selectShapes(toCut.vals())
            self._mergeTags(toCut)
        elif isinstance(toCut, (Solid, Compound)):
            solidToCut = (toCut,)
        else:
            raise ValueError("Cannot cut type '{}'".format(type(toCut)))

        newS = solidRef.cut(*solidToCut, tol=tol)

        if clean:
            newS = newS.clean()

        return self.newObject([newS])

    def __sub__(self: T, other: Union["Workplane", Solid, Compound]) -> T:
        """