Class Location

cadquery/occ_impl/geom.py:1022–1177

Location in 3D space. Depending on usage can be absolute or relative. This class wraps the TopLoc_Location class from OCCT. It can be used to move Shape objects in both relative and absolute manner. It is the preferred type to locate objects in CQ.

class Location(object):
    """Location in 3D space. Depending on usage can be absolute or relative.

    This class wraps the TopLoc_Location class from OCCT. It can be used to move Shape
    objects in both relative and absolute manner. It is the preferred type to locate objects
    in CQ.
    """

    wrapped: TopLoc_Location

    @multidispatch
    def __init__(self, t: VectorLike) -> None:
        """Location with translation t with respect to the original location."""

        T = gp_Trsf()
        T.SetTranslationPart(Vector(t).wrapped)

        self.wrapped = TopLoc_Location(T)

    @multidispatch
    def __init__(
        self,
        x: Real = 0,
        y: Real = 0,
        z: Real = 0,
        rx: Real = 0,
        ry: Real = 0,
        rz: Real = 0,
    ) -> None:
        """Location with translation (x,y,z) and 3 rotation angles."""

        if any((x, y, z, rx, ry, rz)):

            T = gp_Trsf()

            q = gp_Quaternion()
            q.SetEulerAngles(gp_Extrinsic_XYZ, radians(rx), radians(ry), radians(rz))

            T.SetRotation(q)
            T.SetTranslationPart(Vector(x, y, z).wrapped)

            loc = TopLoc_Location(T)
        else:
            # in this case location is flagged as identity
            loc = TopLoc_Location()

        self.wrapped = loc

    @multidispatch
    def __init__(self, t: Plane) -> None:
        """Location corresponding to the location of the Plane t."""

        T = gp_Trsf()
        T.SetTransformation(gp_Ax3(t.origin.toPnt(), t.zDir.toDir(), t.xDir.toDir()))
        T.Invert()

        self.wrapped = TopLoc_Location(T)