Method union

cadquery/cq.py:3306–3354

Unions all of the items on the stack of toUnion with the current solid. If there is no current solid, the items in toUnion are unioned together. :param toUnion: a solid object, or a Workplane object having a solid :param clean: call :meth:`clean` afterwards to have

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

        return self.newObject([s])

    def union(
        self: T,
        toUnion: Optional[Union["Workplane", Solid, Compound]] = None,
        clean: bool = True,
        glue: bool = False,
        tol: Optional[float] = None,
    ) -> T:
        """
        Unions all of the items on the stack of toUnion with the current solid.
        If there is no current solid, the items in toUnion are unioned together.

        :param toUnion: a solid object, or a Workplane object having a solid
        :param clean: call :meth:`clean` afterwards to have a clean shape (default True)
        :param glue: use a faster gluing mode for non-overlapping shapes (default False)
        :param tol: tolerance value for fuzzy bool operation mode (default None)
        :raises: ValueError if there is no solid to add to in the chain
        :return: a Workplane object with the resulting object selected
        """

        # first collect all of the items together
        newS: List[Shape]
        if isinstance(toUnion, Workplane):
            newS = cast(List[Shape], toUnion.solids().vals())
            if len(newS) < 1:
                raise ValueError(
                    "Workplane object must have at least one solid on the stack to union!"
                )
            self._mergeTags(toUnion)
        elif isinstance(toUnion, (Solid, Compound)):
            newS = [toUnion]
        elif toUnion is None:
            newS = []
        else:
            raise ValueError("Cannot union type '{}'".format(type(toUnion)))

        # now combine with existing solid, if there is one
        # look for parents to cut from
        solidRef = self._findType((Solid,), searchStack=True, searchParents=True)
        if solidRef is not None:
            r = solidRef.fuse(*newS, glue=glue, tol=tol)
        elif len(newS) > 1:
            r = newS.pop(0).fuse(*newS, glue=glue, tol=tol)
        else:
            r = newS[0]

        if clean:
            r = r.clean()

        return self.newObject([r])

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