final cleanup, add example

Author: jonahrb

doc/source/_static/thumbnails/chamfer.png

@@ -293,6 +293,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "examples/03_modeling/design_tree": "_static/thumbnails/design_tree.png",
     "examples/03_modeling/service_colors": "_static/thumbnails/service_colors.png",
     "examples/03_modeling/surface_bodies": "_static/thumbnails/quarter_sphere.png",
+    "examples/03_modeling/chamfer": "_static/thumbnails/chamfer.png",
     "examples/04_applied/01_naca_airfoils": "_static/thumbnails/naca_airfoils.png",
     "examples/04_applied/02_naca_fluent": "_static/thumbnails/naca_fluent.png",
 }

doc/source/conf.py

@@ -48,6 +48,7 @@ These examples demonstrate service-based modeling operations.
     examples/03_modeling/design_tree.mystnb
     examples/03_modeling/service_colors.mystnb
     examples/03_modeling/surface_bodies.mystnb
+    examples/03_modeling/chamfer.mystnb
 
 Applied examples
 ----------------

doc/source/examples.rst

@@ -0,0 +1,63 @@
+---
+jupytext:
+  text_representation:
+    extension: .mystnb
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.16.4
+kernelspec:
+  display_name: Python 3 (ipykernel)
+  language: python
+  name: python3
+---
+
+# Modeling: Chamfer edges and faces
+A chamfer is an angled cut on an edge. Chamfers can be created through the `Modeler.pull_tools` module.
+
++++
+
+## Create a block
+Launch the modeler and create a block.
+
+```{code-cell} ipython3
+from ansys.geometry.core import launch_modeler, Modeler
+
+modeler = Modeler()
+print(modeler)
+```
+
+```{code-cell} ipython3
+from ansys.geometry.core.sketch import Sketch
+from ansys.geometry.core.math import Point2D
+
+design = modeler.create_design("chamfer_block")
+body = design.extrude_sketch("block", Sketch().box(Point2D([0, 0]), 1, 1), 1)
+
+body.plot()
+```
+
+## Chamfer edges
+Create a uniform chamfer on all edges of the block.
+
+```{code-cell} ipython3
+modeler.pull_tools.chamfer(body.edges, distance=0.1)
+
+body.plot()
+```
+
+## Chamfer faces
+The chamfer of a face can also be modified. Create a chamfer on a single edge, then modify the chamfer distance value by providing the newly created face that represents the chamfer.
+
+```{code-cell} ipython3
+body = design.extrude_sketch("box", Sketch().box(Point2D([0,0]), 1, 1), 1)
+
+modeler.pull_tools.chamfer(body.edges[0], distance=0.1)
+
+body.plot()
+```
+
+```{code-cell} ipython3
+modeler.pull_tools.chamfer(body.faces[-1], distance=0.3)
+
+body.plot()
+```

doc/source/examples/03_modeling/chamfer.mystnb

@@ -21,7 +21,7 @@
 # SOFTWARE.
 """Provides tools for pulling geometry."""
 
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, List, Union
 
 from ansys.api.geometry.v0.commands_pb2 import ChamferRequest
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
@@ -52,13 +52,15 @@ def __init__(self, grpc_client: GrpcClient):
 
     @protect_grpc
     @min_backend_version(25, 1, 0)
-    def chamfer(self, edge_or_face: Union["Edge", "Face"], distance: Real) -> bool:
+    def chamfer(
+        self, selection: Union["Edge", List["Edge"], "Face", List["Face"]], distance: Real
+    ) -> bool:
         """Create a chamfer on an edge, or adjust the chamfer of a face.
 
         Parameters
         ----------
-        edge_or_face : Edge | Face
-            Edge or face to act on.
+        edges_or_faces : Edge | List[Edge] | Face | List[Face]
+            Edge(s) or face(s) to act on.
         distance : Real
             Chamfer distance.
 
@@ -67,8 +69,13 @@ def chamfer(self, edge_or_face: Union["Edge", "Face"], distance: Real) -> bool:
         bool
             Success of chamfer command.
         """
-        edge_or_face.body._reset_tessellation_cache()
+        selection = selection if isinstance(selection, list) else [selection]
 
-        result = self._commands_stub.Chamfer(ChamferRequest(id=edge_or_face.id, distance=distance))
+        for ef in selection:
+            ef.body._reset_tessellation_cache()
+
+        result = self._commands_stub.Chamfer(
+            ChamferRequest(ids=[ef.id for ef in selection], distance=distance)
+        )
 
         return result.success

src/ansys/geometry/core/tools/pull_tools.py

@@ -48,3 +48,16 @@ def test_chamfer(modeler: Modeler):
     assert len(body.faces) == 7
     assert len(body.edges) == 15
     assert body.volume.m == pytest.approx(Quantity(0.875, UNITS.m**3).m, rel=1e-6, abs=1e-8)
+
+    # multiple edges
+    body2 = design.extrude_sketch("box2", Sketch().box(Point2D([0, 0]), 1, 1), 1)
+    assert len(body2.faces) == 6
+    assert len(body2.edges) == 12
+    assert body2.volume.m == pytest.approx(Quantity(1, UNITS.m**3).m, rel=1e-6, abs=1e-8)
+
+    modeler.pull_tools.chamfer(body2.edges, 0.1)
+    assert len(body2.faces) == 26
+    assert len(body2.edges) == 48
+    assert body2.volume.m == pytest.approx(
+        Quantity(0.945333333333333333, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )