luminarycloud 0.19.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

luminarycloud/volume_selection.py

@@ -30,7 +30,7 @@ from .params.geometry import (
     Volume,
 )
 from .types import Matrix3, Vector3, Vector3Like
-from .types.vector3 import _to_vector3
+from .types.vector3 import _to_vector3, _to_vector3_ad_proto
 
 if TYPE_CHECKING:
     from .geometry import Geometry
@@ -182,7 +182,7 @@ class VolumeSelection:
             )
         )
 
-    def union(self, *, feature_name: str = "Union") -> None:
+    def union(self, keep: bool = False, *, feature_name: str = "Union") -> None:
         """
         Merge the selected volumes.
 
@@ -190,6 +190,8 @@ class VolumeSelection:
 
         Parameters
         ----------
+        keep : bool
+            Whether to keep the original bodies.
         feature_name : str
             The name of the feature.
         """
@@ -199,6 +201,7 @@ class VolumeSelection:
                 boolean=gpb.Boolean(
                     reg_union=booleanpb.RegularUnion(
                         bodies=self.__volume_ids,
+                        keep_source_bodies=keep,
                     )
                 ),
             )
@@ -207,6 +210,8 @@ class VolumeSelection:
     def subtract(
         self,
         tool_volumes: Iterable[Volume],
+        keep_source_bodies: bool = False,
+        keep_tool_bodies: bool = False,
         *,
         propagate_tags: bool = False,
         feature_name: str = "Subtract",
@@ -220,6 +225,10 @@ class VolumeSelection:
         ----------
         tool_volumes : Iterable[Volume]
             The volumes to subtract from the selected volumes.
+        keep_source_bodies : bool
+            Whether to keep the original bodies.
+        keep_tool_bodies : bool
+            Whether to keep the tool bodies.
         propagate_tags : bool
             Whether to propagate the tool volume tags to the surfaces created by the subtraction.
         feature_name : str
@@ -232,13 +241,15 @@ class VolumeSelection:
                     reg_subtraction=booleanpb.RegularSubtraction(
                         bodies=self.__volume_ids,
                         tools=[int(v.id) for v in tool_volumes],
+                        keep_source_bodies=keep_source_bodies,
+                        keep_tool_bodies=keep_tool_bodies,
                         propagate_tool_tags=propagate_tags,
                     )
                 ),
             )
         )
 
-    def intersection(self, *, feature_name: str = "Intersection") -> None:
+    def intersection(self, keep: bool = False, *, feature_name: str = "Intersection") -> None:
         """
         Create an intersection of the selected volumes.
 
@@ -246,6 +257,8 @@ class VolumeSelection:
 
         Parameters
         ----------
+        keep : bool
+            Whether to keep the original bodies.
         feature_name : str
             The name of the feature.
         """
@@ -255,6 +268,7 @@ class VolumeSelection:
                 boolean=gpb.Boolean(
                     reg_intersection=booleanpb.RegularIntersection(
                         bodies=self.__volume_ids,
+                        keep_source_bodies=keep,
                     )
                 ),
             )
@@ -263,6 +277,8 @@ class VolumeSelection:
     def chop(
         self,
         tool_volumes: Iterable[Volume],
+        keep_source_bodies: bool = False,
+        keep_tool_bodies: bool = False,
         *,
         propagate_tags: bool = False,
         feature_name: str = "Chop",
@@ -277,6 +293,10 @@ class VolumeSelection:
         ----------
         tool_volumes : Iterable[Volume]
             The volumes to chop the selected volumes with.
+        keep_source_bodies : bool
+            Whether to keep the original bodies.
+        keep_tool_bodies : bool
+            Whether to keep the tool bodies.
         propagate_tags : bool
             Whether to propagate the tool volume tags to the surfaces created by the chop.
         feature_name : str
@@ -289,38 +309,38 @@ class VolumeSelection:
                     reg_chop=booleanpb.RegularChop(
                         bodies=self.__volume_ids,
                         tools=[int(v.id) for v in tool_volumes],
+                        keep_source_bodies=keep_source_bodies,
+                        keep_tool_bodies=keep_tool_bodies,
                         propagate_tool_tags=propagate_tags,
                     )
                 ),
             )
         )
 
-    def translate(self, displacement: Vector3Like, *, feature_name: str = "Translate") -> None:
+    def translate(
+        self, displacement: Vector3Like, *, keep: bool = False, feature_name: str = "Translate"
+    ) -> None:
         """
         Translate the selected volumes.
 
-        The selected volumes are modified in-place.
-
         Parameters
         ----------
         displacement : Vector3Like
             The displacement to translate the selected volumes by.
+        keep : bool, default False
+            Whether to keep a copy of the original bodies.
         feature_name : str
             The name of the feature.
         """
-        displacement = _to_vector3(displacement)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
                 transform=gpb.Transform(
                     body=self.__volume_ids,
                     translation=transformationpb.Translation(
-                        vector=basepb.Vector3(
-                            x=displacement.x,
-                            y=displacement.y,
-                            z=displacement.z,
-                        ),
+                        vector=_to_vector3_ad_proto(displacement),
                     ),
+                    keep=keep,
                 ),
             )
         )
@@ -331,13 +351,12 @@ class VolumeSelection:
         axis: Vector3Like,
         origin: Vector3Like,
         *,
+        keep: bool = False,
         feature_name: str = "Rotate",
     ) -> None:
         """
         Rotate the selected volumes.
 
-        The selected volumes are modified in-place.
-
         Parameters
         ----------
         angle : float
@@ -346,31 +365,24 @@ class VolumeSelection:
             The axis to rotate the selected volumes around.
         origin : Vector3Like
             The origin to rotate the selected volumes around.
+        keep : bool, default False
+            Whether to keep a copy of the original bodies.
         feature_name : str
             The name of the feature.
         """
-        axis = _to_vector3(axis)
-        origin = _to_vector3(origin)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
                 transform=gpb.Transform(
                     body=self.__volume_ids,
                     rotation=transformationpb.Rotation(
-                        angle=angle,
-                        arbitrary=transformationpb.AnchoredVector3(
-                            origin=basepb.Vector3(
-                                x=origin.x,
-                                y=origin.y,
-                                z=origin.z,
-                            ),
-                            direction=basepb.Vector3(
-                                x=axis.x,
-                                y=axis.y,
-                                z=axis.z,
-                            ),
+                        angle=_to_ad_proto(angle),
+                        arbitrary=transformationpb.AnchoredAdVector3(
+                            origin=_to_vector3_ad_proto(origin),
+                            direction=_to_vector3_ad_proto(axis),
                         ),
                     ),
+                    keep=keep,
                 ),
             )
         )
@@ -380,36 +392,71 @@ class VolumeSelection:
         factor: float,
         origin: Vector3Like,
         *,
+        keep: bool = False,
         feature_name: str = "Scale",
     ) -> None:
         """
         Isotropically scale the selected volumes.
 
-        The selected volumes are modified in-place.
-
         Parameters
         ----------
         factor : float
             The scaling factor.
         origin : Vector3Like
             The origin to scale the selected volumes from.
+        keep : bool, default False
+            Whether to keep a copy of the original bodies.
         feature_name : str
             The name of the feature.
         """
-        origin = _to_vector3(origin)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
                 transform=gpb.Transform(
                     body=self.__volume_ids,
                     scaling=transformationpb.Scaling(
-                        isotropic=factor,
-                        arbitrary=basepb.Vector3(
-                            x=origin.x,
-                            y=origin.y,
-                            z=origin.z,
-                        ),
+                        isotropic=_to_ad_proto(factor),
+                        arbitrary=_to_vector3_ad_proto(origin),
                     ),
+                    keep=keep,
+                ),
+            )
+        )
+
+    def mirror(
+        self,
+        origin: Vector3Like,
+        normal: Vector3Like,
+        *,
+        keep: bool = True,
+        feature_name: str = "Mirror",
+    ) -> None:
+        """
+        Mirror the selected volumes across a plane.
+
+        Parameters
+        ----------
+        origin : Vector3Like
+            A point on the reflection plane.
+        normal : Vector3Like
+            The normal of the reflection plane.
+        keep : bool, default True
+            Whether to keep a copy of the original bodies.
+        feature_name : str
+            The name of the feature.
+        """
+        self.__create_feature(
+            gpb.Feature(
+                feature_name=feature_name,
+                transform=gpb.Transform(
+                    body=self.__volume_ids,
+                    reflection=transformationpb.Reflection(
+                        arbitrary=transformationpb.AnchoredAdVector3(
+                            origin=_to_vector3_ad_proto(origin),
+                            direction=_to_vector3_ad_proto(normal),
+                        )
+                    ),
+                    keep=keep,
                 ),
             )
         )
@@ -419,36 +466,61 @@ class VolumeSelection:
         transform: Matrix3,
         translation: Vector3Like,
         *,
+        keep: bool = False,
         feature_name: str = "Transform",
     ) -> None:
         """
         Transform the selected volumes.
 
-        The selected volumes are modified in-place.
-
         Parameters
         ----------
         transform : Matrix3
             The linear transformation to apply to the selected volumes.
         translation : Vector3Like
             The translation to apply to the selected volumes.
+        keep : bool, default False
+            Whether to keep a copy of the original bodies.
         feature_name : str
             The name of the feature.
         """
-        translation = _to_vector3(translation)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
                 transform=gpb.Transform(
                     body=self.__volume_ids,
                     matrix=transformationpb.AugmentedMatrix(
-                        affine=transform._to_proto(),
-                        translation=basepb.Vector3(
-                            x=translation.x,
-                            y=translation.y,
-                            z=translation.z,
-                        ),
+                        affine=transform._to_ad_proto(),
+                        translation=_to_vector3_ad_proto(translation),
                     ),
+                    keep=keep,
+                ),
+            )
+        )
+
+    def stitch(
+        self,
+        tolerance: float,
+        *,
+        feature_name: str = "Stitch",
+    ) -> None:
+        """
+        Stitch the selected volumes using a strictly positive tolerance.
+
+        Parameters
+        ----------
+        tolerance : float
+            Strictly positive length tolerance used for stitching.
+        feature_name : str
+            The name of the feature.
+        """
+        if tolerance <= 0:
+            raise ValueError("tolerance must be a strictly positive value")
+        self.__create_feature(
+            gpb.Feature(
+                feature_name=feature_name,
+                stitch=gpb.Stitch(
+                    body=self.__volume_ids,
+                    tolerance=_to_ad_proto(tolerance),
                 ),
             )
         )
@@ -526,7 +598,6 @@ class VolumeSelection:
         feature_name : str
             The name of the feature.
         """
-        vector = _to_vector3(vector)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
@@ -534,11 +605,7 @@ class VolumeSelection:
                     body=self.__volume_ids,
                     direction=gpb.Pattern.Direction(
                         linear_spacing=transformationpb.Translation(
-                            vector=basepb.Vector3(
-                                x=vector.x,
-                                y=vector.y,
-                                z=vector.z,
-                            ),
+                            vector=_to_vector3_ad_proto(vector),
                         ),
                         quantity=quantity,
                     ),
@@ -581,6 +648,8 @@ class VolumeSelection:
         axis: Vector3Like,
         origin: Vector3Like,
         quantity: int,
+        symmetric: bool = False,
+        full_rotation: bool = False,
         *,
         feature_name: str = "Circular Pattern",
     ) -> None:
@@ -590,19 +659,20 @@ class VolumeSelection:
         Parameters
         ----------
         angle : float
-            The angle of the circular arc, in degrees. If the angle is 360, the volumes are evenly
-            distributed around a full circle.
+            The angle of the circular arc, in degrees.
         axis : Vector3Like
             The axis of the circular arc.
         origin : Vector3Like
             The origin of the circular arc.
         quantity : int
             The number of times to repeat the selected volumes.
+        symmetric : bool, default False
+            Whether the pattern is symmetric.
+        full_rotation : bool, default False
+            Whether it's a full rotation: invalidates the angle.
         feature_name : str
             The name of the feature.
         """
-        axis = _to_vector3(axis)
-        origin = _to_vector3(origin)
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
@@ -611,23 +681,16 @@ class VolumeSelection:
                     direction=gpb.Pattern.Direction(
                         circular_distribution=gpb.Pattern.Direction.Circular(
                             rotation=transformationpb.Rotation(
-                                angle=angle,
-                                arbitrary=transformationpb.AnchoredVector3(
-                                    origin=basepb.Vector3(
-                                        x=origin.x,
-                                        y=origin.y,
-                                        z=origin.z,
-                                    ),
-                                    direction=basepb.Vector3(
-                                        x=axis.x,
-                                        y=axis.y,
-                                        z=axis.z,
-                                    ),
+                                angle=_to_ad_proto(angle),
+                                arbitrary=transformationpb.AnchoredAdVector3(
+                                    origin=_to_vector3_ad_proto(origin),
+                                    direction=_to_vector3_ad_proto(axis),
                                 ),
                             ),
-                            full=(angle == 360.0),  # set to true if angle is exactly 360
+                            full=full_rotation,
                         ),
                         quantity=quantity,
+                        symmetric=symmetric,
                     ),
                 ),
             )

{luminarycloud-0.19.0.dist-info → luminarycloud-0.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.19.0
+Version: 0.22.0
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/