feat: Add measurement widget (#727)

Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>

Author: AlejandroFernandezLuces

.github/workflows/ci_cd.yml

@@ -17,7 +17,7 @@ env:
   ANSRV_GEO_PORT: 700
   ANSRV_GEO_LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
   GEO_CONT_NAME: ans_geo
-  RESET_IMAGE_CACHE: 3
+  RESET_IMAGE_CACHE: 4
   IS_WORKFLOW_RUNNING: True
   ARTIFACTORY_VERSION: v241
 

src/ansys/geometry/core/plotting/plotter.py

@@ -33,14 +33,6 @@
 from ansys.geometry.core.math.frame import Frame
 from ansys.geometry.core.math.plane import Plane
 from ansys.geometry.core.plotting.plotting_types import EdgePlot, GeomObjectPlot
-from ansys.geometry.core.plotting.widgets import (
-    CameraPanDirection,
-    DisplacementArrow,
-    PlotterWidget,
-    Ruler,
-    ViewButton,
-    ViewDirection,
-)
 from ansys.geometry.core.sketch.sketch import Sketch
 
 DEFAULT_COLOR = "#D6F7D1"
@@ -102,16 +94,7 @@ def __init__(
 
         # geometry objects to actors mapping
         self._geom_object_actors_map = {}
-
-        # Create Plotter widgets
-        if enable_widgets:
-            self._widgets: List[PlotterWidget] = []
-            self._widgets.append(Ruler(self._scene))
-            [
-                self._widgets.append(DisplacementArrow(self._scene, direction=dir))
-                for dir in CameraPanDirection
-            ]
-            [self._widgets.append(ViewButton(self._scene, direction=dir)) for dir in ViewDirection]
+        self._enable_widgets = enable_widgets
 
     @property
     def scene(self) -> PyVistaPlotter:
@@ -245,7 +228,8 @@ def plot_sketch(
         if show_frame:
             self.plot_frame(sketch._plane)
 
-        self.add_sketch_polydata(sketch.sketch_polydata(), **plotting_options)
+        self.add_sketch_polydata(sketch.sketch_polydata_faces(), opacity=0.7, **plotting_options)
+        self.add_sketch_polydata(sketch.sketch_polydata_edges(), **plotting_options)
 
     def add_body_edges(self, body_plot: GeomObjectPlot, **plotting_options: Optional[dict]) -> None:
         """
@@ -498,9 +482,6 @@ def show(
         # Enabling anti-aliasing by default on scene
         self.scene.enable_anti_aliasing("ssaa")
 
-        # Update all buttons/widgets
-        [widget.update() for widget in self._widgets]
-
         self.scene.show(jupyter_backend=jupyter_backend, **kwargs)
 
     def __set_add_mesh_defaults(self, plotting_options: Optional[Dict]) -> None:

src/ansys/geometry/core/plotting/plotter_helper.py

@@ -34,6 +34,15 @@
 )
 from ansys.geometry.core.plotting.plotting_types import EdgePlot, GeomObjectPlot
 from ansys.geometry.core.plotting.trame_gui import _HAS_TRAME, TrameVisualizer
+from ansys.geometry.core.plotting.widgets import (
+    CameraPanDirection,
+    DisplacementArrow,
+    MeasureWidget,
+    PlotterWidget,
+    Ruler,
+    ViewButton,
+    ViewDirection,
+)
 
 
 class PlotterHelper:
@@ -68,6 +77,7 @@ def __init__(
         self._picked_list = set()
         self._picker_added_actors_map = {}
         self._edge_actors_map = {}
+        self._widgets = []
 
         if self._use_trame and _HAS_TRAME:
             # avoids GUI window popping up
@@ -83,10 +93,23 @@ def __init__(
         else:
             self._pl = Plotter()
 
-        if self._allow_picking:
-            self._pl.scene.enable_mesh_picking(
-                callback=self.picker_callback, use_actor=True, show=False, show_message=False
-            )
+        self._enable_widgets = self._pl._enable_widgets
+
+    def enable_widgets(self):
+        """Enable the widgets for the plotter."""
+        # Create Plotter widgets
+        if self._enable_widgets:
+            self._widgets: List[PlotterWidget] = []
+            self._widgets.append(Ruler(self._pl._scene))
+            [
+                self._widgets.append(DisplacementArrow(self._pl._scene, direction=dir))
+                for dir in CameraPanDirection
+            ]
+            [
+                self._widgets.append(ViewButton(self._pl._scene, direction=dir))
+                for dir in ViewDirection
+            ]
+            self._widgets.append(MeasureWidget(self))
 
     def select_object(self, geom_object: Union[GeomObjectPlot, EdgePlot], pt: np.ndarray) -> None:
         """
@@ -204,6 +227,16 @@ def compute_edge_object_map(self) -> Dict[pv.Actor, EdgePlot]:
             for edge in object.edges:
                 self._edge_actors_map[edge.actor] = edge
 
+    def enable_picking(self):
+        """Enable picking capabilities in the plotter."""
+        self._pl.scene.enable_mesh_picking(
+            callback=self.picker_callback, use_actor=True, show=False, show_message=False
+        )
+
+    def disable_picking(self):
+        """Disable picking capabilities in the plotter."""
+        self._pl.scene.disable_picking()
+
     def plot(
         self,
         object: Any,
@@ -262,6 +295,15 @@ def plot(
                 vector=view_2d["vector"],
                 viewup=view_2d["viewup"],
             )
+
+        # Enable widgets and picking capabilities
+        self.enable_widgets()
+        if self._allow_picking:
+            self.enable_picking()
+
+        # Update all buttons/widgets
+        [widget.update() for widget in self._widgets]
+
         self.show_plotter(screenshot)
 
         picked_objects_list = []

src/ansys/geometry/core/plotting/widgets/__init__.py

@@ -24,6 +24,7 @@
     CameraPanDirection,
     DisplacementArrow,
 )
+from ansys.geometry.core.plotting.widgets.measure import MeasureWidget
 from ansys.geometry.core.plotting.widgets.ruler import Ruler
 from ansys.geometry.core.plotting.widgets.view_button import ViewButton, ViewDirection
 from ansys.geometry.core.plotting.widgets.widget import PlotterWidget

src/ansys/geometry/core/plotting/widgets/_images/measurement.png

@@ -0,0 +1,85 @@
+# Copyright (C) 2023 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Provides the ruler widget for the PyAnsys Geometry plotter."""
+
+import os
+
+from vtk import vtkActor, vtkButtonWidget, vtkPNGReader
+
+from ansys.geometry.core.plotting.widgets.widget import PlotterWidget
+
+
+class MeasureWidget(PlotterWidget):
+    """
+    Provides the ruler widget for the PyAnsys Geometry ``Plotter`` class.
+
+    Parameters
+    ----------
+    plotter : ~pyvista.Plotter
+        Provides the plotter to add the ruler widget to.
+    """
+
+    def __init__(self, plotter_helper: "PlotterHelper") -> None:
+        """Initialize the ``Ruler`` class."""
+        # Call PlotterWidget ctor
+        super().__init__(plotter_helper._pl.scene)
+
+        # Initialize variables
+        self._actor: vtkActor = None
+        self.plotter_helper = plotter_helper
+        self._button: vtkButtonWidget = self.plotter_helper._pl.scene.add_checkbox_button_widget(
+            self.callback, position=(10, 60), size=30, border_size=3
+        )
+
+    def callback(self, state: bool) -> None:
+        """
+        Remove or add the measurement widget actor upon click.
+
+        Parameters
+        ----------
+        state : bool
+            State of the button, which is inherited from PyVista. The value is ``True``
+            if the button is active.
+        """
+        # This implementation uses direct calls to VTK due to limitations
+        # in PyVista. If there are improvements in the compatibility between
+        # the PyVista picker and the measurement widget, this should be reviewed.
+        if not state:
+            self._widget.Off()
+            self.plotter_helper._pl.scene.clear_measure_widgets()
+            if self.plotter_helper._allow_picking:
+                self.plotter_helper.enable_picking()
+        else:
+            if self.plotter_helper._allow_picking:
+                self.plotter_helper.disable_picking()
+            self._widget = self.plotter_helper._pl.scene.add_measurement_widget()
+
+    def update(self) -> None:
+        """Define the measurement widget button params."""
+        show_ruler_vr = self._button.GetRepresentation()
+        show_ruler_icon_file = os.path.join(os.path.dirname(__file__), "_images", "measurement.png")
+        show_ruler_r = vtkPNGReader()
+        show_ruler_r.SetFileName(show_ruler_icon_file)
+        show_ruler_r.Update()
+        image = show_ruler_r.GetOutput()
+        show_ruler_vr.SetButtonTexture(0, image)
+        show_ruler_vr.SetButtonTexture(1, image)

src/ansys/geometry/core/plotting/widgets/measure.py

@@ -910,18 +910,36 @@ def sketch_polydata(self) -> List["PolyData"]:
             List of the polydata configuration for all edges and faces in the sketch.
         """
         sketches_polydata = []
-        sketches_polydata.extend(
-            [
-                edge.visualization_polydata.transform(self._plane.transformation_matrix)
-                for edge in self.edges
-            ]
-        )
+        sketches_polydata.extend(self.sketch_polydata_edges())
+        sketches_polydata.extend(self.sketch_polydata_faces())
+        return sketches_polydata
 
-        sketches_polydata.extend(
-            [
-                face.visualization_polydata.transform(self._plane.transformation_matrix)
-                for face in self.faces
-            ]
-        )
+    def sketch_polydata_faces(self) -> List["PolyData"]:
+        """
+        Get polydata configuration for all faces of the sketch to the scene.
 
-        return sketches_polydata
+        Returns
+        -------
+        List[~pyvista.PolyData]
+            List of the polydata configuration for faces in the sketch.
+        """
+        sketches_polydata_faces = [
+            face.visualization_polydata.transform(self._plane.transformation_matrix)
+            for face in self.faces
+        ]
+        return sketches_polydata_faces
+
+    def sketch_polydata_edges(self) -> List["PolyData"]:
+        """
+        Get polydata configuration for all edges of the sketch to the scene.
+
+        Returns
+        -------
+        List[~pyvista.PolyData]
+            List of the polydata configuration for edges in the sketch.
+        """
+        sketches_polydata_edges = [
+            edge.visualization_polydata.transform(self._plane.transformation_matrix)
+            for edge in self.edges
+        ]
+        return sketches_polydata_edges

src/ansys/geometry/core/sketch/sketch.py

@@ -753,3 +753,20 @@ def test_arc_from_three_points():
     for point in pd.points:
         if point[1] > 0:
             assert point[0] < 0 or np.isclose(point[0], 0)
+
+
+def test_polydata_methods():
+    sketch = Sketch()
+    sketch.polygon(Point2D([10, 10], UNITS.m), Quantity(10, UNITS.m), sides=5, tag="Polygon1")
+    sketch.arc(
+        Point2D([10, 10], UNITS.m),
+        Point2D([10, -10], UNITS.m),
+        Point2D([10, 0], UNITS.m),
+        tag="Arc1",
+    )
+    pd = sketch.sketch_polydata()
+    pd_faces = sketch.sketch_polydata_faces()
+    pd_edges = sketch.sketch_polydata_edges()
+    assert len(pd) == 2
+    assert len(pd_edges) == 1
+    assert len(pd_faces) == 1