FEAT: Add magick method to EdgePrimitive (#6819)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: SMoraisAnsys

doc/changelog.d/6819.added.md

@@ -0,0 +1 @@
+Add magick method to EdgePrimitive

src/ansys/aedt/core/modeler/cad/elements_3d.py

@@ -31,11 +31,17 @@
 from ansys.aedt.core.modeler.geometry_operators import GeometryOperators
 
 
-class EdgeTypePrimitive(PyAedtBase):
-    """Provides common methods for EdgePrimitive and FacePrimitive."""
+class ModifiablePrimitive(PyAedtBase):
+    """Base class for geometric primitives that support modification operations.
+
+    Provides fillet and chamfer operations for:
+    - EdgePrimitive (3D designs only)
+    - VertexPrimitive (2D designs only)
+
+    """
 
     @pyaedt_function_handler()
-    def fillet(self, radius=0.1, setback=0.0):
+    def fillet(self, radius: float = 0.1, setback: float = 0.0) -> bool:
         """Add a fillet to the selected edges in 3D/vertices in 2D.
 
         Parameters
@@ -81,7 +87,9 @@ def fillet(self, radius=0.1, setback=0.0):
         return True
 
     @pyaedt_function_handler()
-    def chamfer(self, left_distance=1, right_distance=None, angle=45, chamfer_type=0):
+    def chamfer(
+        self, left_distance: float = 1, right_distance: float | None = None, angle: float = 45, chamfer_type: int = 0
+    ) -> bool:
         """Add a chamfer to the selected edges in 3D/vertices in 2D.
 
         Parameters
@@ -179,7 +187,7 @@ def chamfer(self, left_distance=1, right_distance=None, angle=45, chamfer_type=0
         return True
 
 
-class VertexPrimitive(EdgeTypePrimitive, PyAedtBase):
+class VertexPrimitive(ModifiablePrimitive, PyAedtBase):
     """Contains the vertex object within the AEDT Desktop Modeler.
 
     Parameters
@@ -234,7 +242,7 @@ def __repr__(self):
         return str(self.id)
 
 
-class EdgePrimitive(EdgeTypePrimitive, PyAedtBase):
+class EdgePrimitive(ModifiablePrimitive, PyAedtBase):
     """Contains the edge object within the AEDT Desktop Modeler.
 
     Parameters
@@ -251,6 +259,78 @@ def __init__(self, object3d, edge_id):
         self._object3d = object3d
         self.oeditor = object3d._oeditor
 
+    def __str__(self):
+        return str(self.id)
+
+    def __repr__(self):
+        return str(self.id)
+
+    def __iter__(self):
+        """Return an iterator for the vertices of the edge.
+
+        Returns
+        -------
+        iterator
+            Iterator over the vertices of the edge.
+
+        Examples
+        --------
+        >>> for vertex in edge:
+        ...     print(f"Vertex ID: {vertex.id}, Position: {vertex.position}")
+        """
+        return iter(self.vertices)
+
+    def __getitem__(self, index):
+        """Get a vertex by index.
+
+        Parameters
+        ----------
+        index : int
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modeler.cad.elements_3d.VertexPrimitive`
+            Vertex at the specified index.
+
+        Examples
+        --------
+        >>> first_vertex = edge[0]
+        >>> last_vertex = edge[-1]
+        """
+        return self.vertices[index]
+
+    def __contains__(self, item: int | VertexPrimitive) -> bool:
+        """Check if a vertex is contained in the edge.
+
+        Parameters
+        ----------
+        item : :class:`ansys.aedt.core.modeler.cad.elements_3d.VertexPrimitive` or int
+            Vertex object or vertex ID to check for containment.
+
+        Returns
+        -------
+        bool
+            ``True`` if the item is part of this edge, ``False`` otherwise.
+
+        Examples
+        --------
+        >>> edge = obj.edges[0]
+        >>> vertex = obj.vertices[0]
+        >>> if vertex in edge:
+        ...     print("Vertex is part of this edge")
+
+        >>> # Check by vertex ID
+        >>> vertex_id = 123
+        >>> if vertex_id in edge:
+        ...     print("Vertex ID is part of this edge")
+        """
+        if isinstance(item, VertexPrimitive):
+            item_id = item.id
+            return any(v.id == item_id for v in self)
+        elif isinstance(item, int):
+            return any(v.id == item for v in self)
+        return False
+
     @property
     def name(self):
         """Name of the object."""
@@ -364,12 +444,6 @@ def length(self):
         except Exception:
             return False
 
-    def __str__(self):
-        return str(self.id)
-
-    def __repr__(self):
-        return str(self.id)
-
     @pyaedt_function_handler()
     def create_object(self, non_model=False):
         """Return a new object from the selected edge.
@@ -412,6 +486,150 @@ def move_along_normal(self, offset=1.0):
             return False
         return self._object3d._primitives.move_edge(self, offset)
 
+    @pyaedt_function_handler()
+    def fillet(self, radius=0.1, setback=0.0):
+        """Add a fillet to the selected edges in 3D/vertices in 2D.
+
+        Parameters
+        ----------
+        radius : float, optional
+            Radius of the fillet. The default is ``0.1``.
+        setback : float, optional
+            Setback value for the file. The default is ``0.0``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+        >>> oEditor.Fillet
+
+        """
+        edge_id_list = []
+        vertex_id_list = []
+
+        if isinstance(self, VertexPrimitive):
+            vertex_id_list = [self.id]
+        else:
+            if self._object3d.is3d:
+                edge_id_list = [self.id]
+            else:
+                self._object3d.logger.error("Fillet is possible only on a vertex in 2D designs.")
+                return False
+
+        vArg1 = ["NAME:Selections", "Selections:=", self._object3d.name, "NewPartsModelFlag:=", "Model"]
+        vArg2 = ["NAME:FilletParameters"]
+        vArg2.append("Edges:="), vArg2.append(edge_id_list)
+        vArg2.append("Vertices:="), vArg2.append(vertex_id_list)
+        vArg2.append("Radius:="), vArg2.append(self._object3d._primitives._app.value_with_units(radius))
+        vArg2.append("Setback:="), vArg2.append(self._object3d._primitives._app.value_with_units(setback))
+        self._object3d._oeditor.Fillet(vArg1, ["NAME:Parameters", vArg2])
+        if self._object3d.name in list(self._object3d._oeditor.GetObjectsInGroup("UnClassified")):
+            self._object3d._primitives._odesign.Undo()
+            self._object3d.logger.error("Operation failed, generating an unclassified object. Check and retry.")
+            return False
+        return True
+
+    @pyaedt_function_handler()
+    def chamfer(self, left_distance=1, right_distance=None, angle=45, chamfer_type=0):
+        """Add a chamfer to the selected edges in 3D/vertices in 2D.
+
+        Parameters
+        ----------
+        left_distance : float, optional
+            Left distance from the edge. The default is ``1``.
+        right_distance : float, optional
+            Right distance from the edge. The default is ``None``.
+        angle : float, optional.
+            Angle value for chamfer types 2 and 3. The default is ``0``.
+        chamfer_type : int, optional
+            Type of the chamfer. Options are:
+                * 0 - Symmetric
+                * 1 - Left Distance-Right Distance
+                * 2 - Left Distance-Angle
+                * 3 - Right Distance-Angle
+
+            The default is ``0``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+        >>> oEditor.Chamfer
+
+        """
+        edge_id_list = []
+        vertex_id_list = []
+
+        if isinstance(self, VertexPrimitive):
+            vertex_id_list = [self.id]
+        else:
+            if self._object3d.is3d:
+                edge_id_list = [self.id]
+            else:
+                self._object3d.logger.error("chamfer is possible only on Vertex in 2D Designs ")
+                return False
+        vArg1 = ["NAME:Selections", "Selections:=", self._object3d.name, "NewPartsModelFlag:=", "Model"]
+        vArg2 = ["NAME:ChamferParameters"]
+        vArg2.append("Edges:="), vArg2.append(edge_id_list)
+        vArg2.append("Vertices:="), vArg2.append(vertex_id_list)
+        if right_distance is None:
+            right_distance = left_distance
+        if chamfer_type == 0:
+            if left_distance != right_distance:
+                self._object3d.logger.error(
+                    "Do not set right distance or ensure that left distance equals right distance."
+                )
+            (
+                vArg2.append("LeftDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(left_distance)),
+            )
+            (
+                vArg2.append("RightDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(right_distance)),
+            )
+            vArg2.append("ChamferType:="), vArg2.append("Symmetric")
+        elif chamfer_type == 1:
+            (
+                vArg2.append("LeftDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(left_distance)),
+            )
+            (
+                vArg2.append("RightDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(right_distance)),
+            )
+            vArg2.append("ChamferType:="), vArg2.append("Left Distance-Right Distance")
+        elif chamfer_type == 2:
+            (
+                vArg2.append("LeftDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(left_distance)),
+            )
+            # NOTE: Seems like there is a bug in the API as Angle can't be used
+            vArg2.append("RightDistance:="), vArg2.append(f"{angle}deg")
+            vArg2.append("ChamferType:="), vArg2.append("Left Distance-Angle")
+        elif chamfer_type == 3:
+            # NOTE: Seems like there is a bug in the API as Angle can't be used
+            vArg2.append("LeftDistance:="), vArg2.append(f"{angle}deg")
+            (
+                vArg2.append("RightDistance:="),
+                vArg2.append(self._object3d._primitives._app.value_with_units(right_distance)),
+            )
+            vArg2.append("ChamferType:="), vArg2.append("Right Distance-Angle")
+        else:
+            self._object3d.logger.error("Wrong chamfer_type provided. Value must be an integer from 0 to 3.")
+            return False
+        self._object3d._oeditor.Chamfer(vArg1, ["NAME:Parameters", vArg2])
+        if self._object3d.name in list(self._object3d._oeditor.GetObjectsInGroup("UnClassified")):
+            self._object3d.odesign.Undo()
+            self._object3d.logger.error("Operation Failed generating Unclassified object. Check and retry")
+            return False
+        return True
+
 
 class FacePrimitive(PyAedtBase):
     """Contains the face object within the AEDT Desktop Modeler.

src/ansys/aedt/core/modeler/cad/object_3d.py

@@ -24,9 +24,8 @@
 
 """
 This module contains these classes: `Components3DLayout`,`CircuitComponent',
-`EdgePrimitive`, `EdgeTypePrimitive`, `FacePrimitive`, `Geometries3DLayout`,
-`Nets3DLayout`, `Object3DLayout`, `Object3d`, `Padstack`, `PDSHole`, `PDSLayer`,
-`Pins3DLayout', and `VertexPrimitive`.
+`Geometries3DLayout`, `Nets3DLayout`, `Object3DLayout`, `Object3d`, `Padstack`,
+`PDSHole`, `PDSLayer` and `Pins3DLayout'.
 
 This module provides methods and data structures for managing all properties of
 objects (points, lines, sheets, and solids) within the AEDT 3D Modeler.

tests/system/general/test_02_3D_modeler.py

@@ -32,6 +32,7 @@
 from ansys.aedt.core.generic.numbers_utils import decompose_variable_value
 from ansys.aedt.core.generic.quaternion import Quaternion
 from ansys.aedt.core.modeler.cad.elements_3d import FacePrimitive
+from ansys.aedt.core.modeler.cad.elements_3d import VertexPrimitive
 from ansys.aedt.core.modeler.cad.modeler import FaceCoordinateSystem
 from ansys.aedt.core.modeler.cad.object_3d import Object3d
 from ansys.aedt.core.modeler.cad.primitives import CoordinateSystem as cs
@@ -1311,3 +1312,32 @@ def test_project_sheet_failure(self):
 
         assert not self.aedtapp.modeler.project_sheet(rect, box_0, 5, "10deg")
         self.aedtapp.modeler.delete(self.aedtapp.modeler.object_names)
+
+    def test_edge_primitives_getitem(self):
+        """Test EdgePrimitive __getitem__ method."""
+        box = self.aedtapp.modeler.create_box([0, 0, 0], [10, 10, 10], "box_edge_primitive_getitem")
+        edge = box.edges[0]
+
+        vertex_0, vertex_1 = edge[0], edge[1]
+
+        assert isinstance(vertex_0, VertexPrimitive)
+        assert isinstance(vertex_1, VertexPrimitive)
+
+    def test_edge_primitives_iter(self):
+        """Test EdgePrimitive __iter__ method."""
+        box = self.aedtapp.modeler.create_box([0, 0, 0], [10, 10, 10], "box_edge_primitive_iter")
+        edge = box.edges[0]
+
+        for vertex in edge:
+            assert isinstance(vertex, VertexPrimitive)
+
+    def test_edge_primitives_contains(self):
+        """Test EdgePrimitive __contains__ method."""
+        box = self.aedtapp.modeler.create_box([0, 0, 0], [10, 10, 10], "box_edge_primitive_contains")
+        edge = box.edges[0]
+        vertex_0, vertex_1 = edge[0], edge[1]
+
+        assert vertex_0 in edge
+        assert vertex_0.id in edge
+        assert vertex_1 in edge
+        assert vertex_1.id in edge