Wider edge operators support (#348)

* Wider edge operators support

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: martinRenou

examples/Notebook.ipynb

@@ -66,6 +66,26 @@
     "doc.add_cylinder(radius=0.5, position=[0, 0, 0.8]).fuse();"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "58b50fb3-e95a-409c-b12d-3b630bae7f27",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "doc = CadDocument()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9f4c257e-7093-4724-8474-435fdfaa70fe",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "doc.add_box().chamfer(edge=11, dist=0.3).fillet(radius=0.2, edge=8)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "e072569b-21b8-474c-b7b4-5bf042101e9f",
@@ -269,7 +289,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.13"
+   "version": "3.12.2"
   }
  },
  "nbformat": 4,

python/jupytercad_app/src/app/plugins/mainmenu/menuWidget.ts

@@ -127,6 +127,14 @@ export class MainMenu extends MenuBar {
       type: 'command',
       command: CommandIDs.union
     });
+    operatorMenu.addItem({
+      type: 'command',
+      command: CommandIDs.chamfer
+    });
+    operatorMenu.addItem({
+      type: 'command',
+      command: CommandIDs.fillet
+    });
     menu.addItem({
       type: 'submenu',
       submenu: operatorMenu

python/jupytercad_lab/jupytercad_lab/notebook/cad_document.py

@@ -23,6 +23,8 @@
     IFuse,
     IIntersection,
     ISphere,
+    IChamfer,
+    IFillet,
     ITorus,
     Parts,
     ShapeMetadata,
@@ -593,29 +595,101 @@ def intersect(
         self.set_visible(shape2, False)
         return self.add_object(OBJECT_FACTORY.create_object(data, self))
 
-    def _get_boolean_operands(self, shape1: str | int | None, shape2: str | int | None):
-        objects = self.objects
+    def chamfer(
+        self,
+        name: str = "",
+        shape: str | int = None,
+        edge: int = 0,
+        dist: float = 0.1,
+        position: List[float] = [0, 0, 0],
+        rotation_axis: List[float] = [0, 0, 1],
+        rotation_angle: float = 0,
+    ) -> CadDocument:
+        """
+        Apply a chamfer operation on an object.
+        If no objects are provided as input, the last created object will be used as operand.
 
+        :param name: The name that will be used for the object in the document.
+        :param shape: The input object used for the chamfer. Can be the name of the object or its index in the objects list.
+        :param edge: The edge index where to apply chamfer.
+        :param dist: The distance of the chamfer.
+        :param position: The shape 3D position.
+        :param rotation_axis: The 3D axis used for the rotation.
+        :param rotation_angle: The shape rotation angle, in degrees.
+        :return: The document itself.
+        """  # noqa E501
+        shape = self._get_operand(shape)
+
+        data = {
+            "shape": Parts.Part__Chamfer.value,
+            "name": name if name else self._new_name("Chamfer"),
+            "parameters": {
+                "Base": shape,
+                "Edge": edge,
+                "Dist": dist,
+                "Placement": {"Position": [0, 0, 0], "Axis": [0, 0, 1], "Angle": 0},
+            },
+        }
+        self.set_visible(shape, False)
+        return self.add_object(OBJECT_FACTORY.create_object(data, self))
+
+    def fillet(
+        self,
+        name: str = "",
+        shape: str | int = None,
+        edge: int = 0,
+        radius: float = 0.1,
+        position: List[float] = [0, 0, 0],
+        rotation_axis: List[float] = [0, 0, 1],
+        rotation_angle: float = 0,
+    ) -> CadDocument:
+        """
+        Apply a fillet operation on an object.
+        If no objects are provided as input, the last created object will be used as operand.
+
+        :param name: The name that will be used for the object in the document.
+        :param shape: The input object used for the fillet. Can be the name of the object or its index in the objects list.
+        :param edge: The edge index where to apply fillet.
+        :param radius: The radius of the fillet.
+        :param position: The shape 3D position.
+        :param rotation_axis: The 3D axis used for the rotation.
+        :param rotation_angle: The shape rotation angle, in degrees.
+        :return: The document itself.
+        """  # noqa E501
+        shape = self._get_operand(shape)
+
+        data = {
+            "shape": Parts.Part__Fillet.value,
+            "name": name if name else self._new_name("Fillet"),
+            "parameters": {
+                "Base": shape,
+                "Edge": edge,
+                "Radius": radius,
+                "Placement": {"Position": [0, 0, 0], "Axis": [0, 0, 1], "Angle": 0},
+            },
+        }
+        self.set_visible(shape, False)
+        return self.add_object(OBJECT_FACTORY.create_object(data, self))
+
+    def _get_operand(self, shape: str | int | None, default_idx: int = -1):
+        if isinstance(shape, str):
+            if shape not in self.objects:
+                raise ValueError(f"Unknown object {shape}")
+        elif isinstance(shape, int):
+            shape = self.objects[shape]
+        else:
+            shape = self.objects[default_idx]
+
+        return shape
+
+    def _get_boolean_operands(self, shape1: str | int | None, shape2: str | int | None):
         if len(self.objects) < 2:
             raise ValueError(
                 "Cannot apply boolean operator if there are less than two objects in the document."  # noqa E501
             )
 
-        if isinstance(shape1, str):
-            if shape1 not in objects:
-                raise ValueError(f"Unknown object {shape1}")
-        elif isinstance(shape1, int):
-            shape1 = objects[shape1]
-        else:
-            shape1 = objects[-2]
-
-        if isinstance(shape2, str):
-            if shape2 not in objects:
-                raise ValueError(f"Unknown object {shape2}")
-        elif isinstance(shape2, int):
-            shape2 = objects[shape2]
-        else:
-            shape2 = objects[-1]
+        shape1 = self._get_operand(shape1, -2)
+        shape2 = self._get_operand(shape2, -1)
 
         return shape1, shape2
 
@@ -676,6 +750,8 @@ class Config:
         IFuse,
         ISphere,
         ITorus,
+        IFillet,
+        IChamfer,
     ]
     metadata: Optional[ShapeMetadata]
     _caddoc = Optional[CadDocument]
@@ -742,3 +818,5 @@ def create_object(
 OBJECT_FACTORY.register_factory(Parts.Part__MultiFuse.value, IFuse)
 OBJECT_FACTORY.register_factory(Parts.Part__Sphere.value, ISphere)
 OBJECT_FACTORY.register_factory(Parts.Part__Torus.value, ITorus)
+OBJECT_FACTORY.register_factory(Parts.Part__Chamfer.value, IChamfer)
+OBJECT_FACTORY.register_factory(Parts.Part__Fillet.value, IFillet)

python/jupytercad_lab/jupytercad_lab/notebook/objects/__init__.py

@@ -8,3 +8,5 @@
 from ._schema.jcad import Parts, ShapeMetadata  # noqa
 from ._schema.sphere import ISphere  # noqa
 from ._schema.torus import ITorus  # noqa
+from ._schema.chamfer import IChamfer  # noqa
+from ._schema.fillet import IFillet  # noqa