Merge branch 'main' into feat/add-design-points-and-modify-named-selection

Author: RobPasMue

pyproject.toml

@@ -25,7 +25,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ansys-api-geometry==0.2.1",
+    "ansys-api-geometry==0.2.2",
     "beartype>=0.11.0",
     "google-api-python-client>=1.7.11",
     "googleapis-common-protos>=1.52.0",
@@ -41,6 +41,12 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+all = [
+    "pyvista[trame]>=0.38.1",
+    "docker>=6.0.1",
+    "ansys-platform-instancemanagement>=1.0.3",
+]
+
 tests = [
     "beartype==0.12.0",
     "google-api-python-client==2.78.0",
@@ -50,7 +56,7 @@ tests = [
     "numpy==1.24.2",
     "Pint==0.20.1",
     "protobuf==3.20.3",
-    "pyvista==0.37.0",
+    "pyvista[trame]==0.38.2",
     "scipy==1.10.0",
     "six==1.16.0",
     "ansys-platform-instancemanagement==1.0.3",
@@ -71,7 +77,7 @@ doc = [
     "notebook==6.5.2",
     "numpydoc==1.5.0",
     "panel==0.14.3",
-    "pyvista==0.37.0",
+    "pyvista[trame]==0.38.2",
     "Sphinx==5.1.1",                        # PR349 - Duplicated documentation entries...
     "sphinx-autoapi==2.0.1",
     "sphinx-autodoc-typehints==1.19.1",     # PR349 - Duplicated documentation entries...

src/ansys/geometry/core/__init__.py

@@ -22,3 +22,9 @@
 )
 from ansys.geometry.core.logger import LOG
 from ansys.geometry.core.modeler import Modeler
+
+# Global config constants
+# ------------------------------------------------------------------------------
+
+USE_TRAME = False
+"""Global constant for checking the use of trame or not."""

src/ansys/geometry/core/designer/body.py

@@ -517,8 +517,9 @@ def tessellate(self, merge: Optional[bool] = False) -> Union["PolyData", "MultiB
 
     def plot(
         self,
-        merge: Optional[bool] = False,
+        merge: bool = False,
         screenshot: Optional[str] = None,
+        use_trame: Optional[bool] = None,
         **plotting_options: Optional[dict],
     ) -> None:
         """Plot the body.
@@ -529,9 +530,12 @@ def plot(
             Whether to merge the body into a single mesh. By default, the
             number of triangles are preserved and only the topology is merged.
             When ``True``, the individual faces of the tessellation are merged.
-        screenshot : str, default: None
+        screenshot : str, optional
             Save a screenshot of the image being represented. The image is
             stored in the path provided as an argument.
+        use_trame : bool, optional
+            Enables/disables the usage of the trame web visualizer. Defaults to the
+            global setting ``USE_TRAME``.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :func:`pyvista.Plotter.add_mesh` method.
@@ -561,11 +565,13 @@ def plot(
 
         """
         # lazy import here to improve initial module load time
-        from ansys.geometry.core.plotting import Plotter
 
-        pl = Plotter()
+        from ansys.geometry.core.plotting import PlotterHelper
+
+        pl_helper = PlotterHelper(use_trame=use_trame)
+        pl = pl_helper.init_plotter()
         pl.add_body(self, merge=merge, **plotting_options)
-        pl.show(screenshot=screenshot)
+        pl_helper.show_plotter(pl, screenshot=screenshot)
 
     def __repr__(self) -> str:
         """String representation of the body."""

src/ansys/geometry/core/designer/component.py

@@ -717,7 +717,7 @@ def tessellate(
         >>> from ansys.geometry.core import Modeler
         >>> from ansys.geometry.core.math import Point2D, Point3D, Plane
         >>> from ansys.geometry.core.misc import UNITS
-        >>> from ansys.geometry.core.plotting.plotter import Plotter
+        >>> from ansys.geometry.core.plotting import Plotter
         >>> modeler = Modeler("10.54.0.72", "50051")
         >>> sketch_1 = Sketch()
         >>> box = sketch_1.box(
@@ -778,6 +778,7 @@ def plot(
         merge_component: bool = False,
         merge_bodies: bool = False,
         screenshot: Optional[str] = None,
+        use_trame: Optional[bool] = None,
         **plotting_options: Optional[dict],
     ) -> None:
         """Plot this component.
@@ -792,9 +793,12 @@ def plot(
             Whether to merge each body into a single dataset. When ``True``,
             all the faces of each individual body are effectively merged
             into a single dataset without separating faces.
-        screenshot : str, default: None
+        screenshot : str, optional
             Save a screenshot of the image being represented. The image is
             stored in the path provided as an argument.
+        use_trame : bool, optional
+            Enables/disables the usage of the trame web visualizer. Defaults to the
+            global setting ``USE_TRAME``.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :func:`pyvista.Plotter.add_mesh` method.
@@ -835,13 +839,15 @@ def plot(
         >>> mycomp.plot(pbr=True, metallic=1.0)
 
         """
-        from ansys.geometry.core.plotting import Plotter
 
-        pl = Plotter()
+        from ansys.geometry.core.plotting import PlotterHelper
+
+        pl_helper = PlotterHelper(use_trame=use_trame)
+        pl = pl_helper.init_plotter()
         pl.add_component(
             self, merge_bodies=merge_bodies, merge_component=merge_component, **plotting_options
         )
-        pl.show(screenshot=screenshot)
+        pl_helper.show_plotter(pl, screenshot=screenshot)
 
     def __repr__(self) -> str:
         """String representation of the component."""

src/ansys/geometry/core/designer/design.py

@@ -266,7 +266,8 @@ def delete_named_selection(self, named_selection: Union[NamedSelection, str]) ->
         """
         if isinstance(named_selection, str):
             removal_name = named_selection
-            removal_id = self._named_selections.get(named_selection, None)
+            removal = self._named_selections.get(named_selection, None)
+            removal_id = removal.id if removal else None
         else:
             removal_name = named_selection.name
             removal_id = named_selection.id

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

@@ -1,3 +1,4 @@
 """Provides the PyGeometry ``plotting`` subpackage."""
 
-from ansys.geometry.core.plotting.plotter import Plotter
+from ansys.geometry.core.plotting.plotter import Plotter, PlotterHelper
+from ansys.geometry.core.plotting.trame_gui import _HAS_TRAME, TrameVisualizer

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

@@ -5,7 +5,9 @@
 from pyvista.plotting.tools import create_axes_marker
 
 from ansys.geometry.core.designer import Body, Component
+from ansys.geometry.core.logger import LOG as logger
 from ansys.geometry.core.math import Frame, Plane
+from ansys.geometry.core.plotting.trame_gui import _HAS_TRAME, TrameVisualizer
 from ansys.geometry.core.plotting.widgets import (
     CameraPanDirection,
     DisplacementArrow,
@@ -18,50 +20,56 @@
 
 
 class Plotter:
-    """Provides for plotting sketches and bodies."""
+    """Provides for plotting sketches and bodies.
+
+    Parameters
+    ----------
+    scene : ~pyvista.Plotter, default: None
+        Scene instance for rendering the objects.
+    color_opts : dict, default: None
+        Dictionary containing the background and top colors.
+    num_points : int, default: 100
+        Number of points to use to render the shapes.
+    enable_widgets: bool, default: True
+        Enables/disables widget buttons in the plotter window.
+        They must be disabled for trame viewer.
+    """
 
     def __init__(
         self,
         scene: Optional[pv.Plotter] = None,
-        background_opts: Optional[Dict] = None,
+        color_opts: Optional[Dict] = None,
         num_points: int = 100,
+        enable_widgets: bool = True,
     ):
-        """Initializes the plotter.
+        """Initializes the plotter."""
 
-        Parameters
-        ----------
-        scene : ~pyvista.Plotter, default: None
-            Scene instance for rendering the objects.
-        background_opts : dict, default: None
-            Dictionary containing the background and top colors.
-        num_points : int, default: 100
-            Number of points to use to render the shapes.
-        """
         # Generate custom scene if ``None`` is provided
         if scene is None:
             scene = pv.Plotter()
 
         # If required, use a white background with no gradient
-        if not background_opts:
-            background_opts = dict(color="white")
+        if not color_opts:
+            color_opts = dict(color="white")
 
         # Create the scene
         self._scene = scene
         # Scene: assign the background
-        self._scene.set_background(**background_opts)
+        self._scene.set_background(**color_opts)
         view_box = self._scene.add_axes(line_width=5, color="black")
 
         # Save the desired number of points
         self._num_points = num_points
 
         # Create Plotter 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]
+        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]
 
     @property
     def scene(self) -> pv.Plotter:
@@ -322,3 +330,68 @@ def __set_add_mesh_defaults(self, plotting_options: Optional[Dict]) -> None:
         # This method should only be applied in 3D objects: bodies, components
         plotting_options.setdefault("smooth_shading", True)
         plotting_options.setdefault("color", "#D6F7D1")
+
+
+class PlotterHelper:
+    """This class simplifies the selection of Trame visualizer in plot()
+    functions.
+
+    Parameters
+    ----------
+    use_trame: bool, optional
+        Enables/disables the usage of the trame web visualizer. Defaults to the
+        global setting ``USE_TRAME``.
+    """
+
+    def __init__(self, use_trame: Optional[bool] = None) -> None:
+        """Initializes use_trame and saves current pv.OFF_SCREEN value."""
+        # Check if the use of trame was requested
+        if use_trame is None:
+            import ansys.geometry.core as pygeom
+
+            use_trame = pygeom.USE_TRAME
+
+        self._use_trame = use_trame
+        self._pv_off_screen_original = bool(pv.OFF_SCREEN)
+
+    def init_plotter(self):
+        """Initializes the plotter with or without trame visualizer.
+
+        Returns
+        -------
+        Plotter
+            PyGeometry plotter initialized.
+        """
+        if self._use_trame and _HAS_TRAME:
+            # avoids GUI window popping up
+            pv.OFF_SCREEN = True
+            pl = Plotter(enable_widgets=False)
+        elif self._use_trame and not _HAS_TRAME:
+            warn_msg = (
+                "'use_trame' is active but Trame dependencies are not installed."
+                "Consider installing 'pyvista[trame]' to use this functionality."
+            )
+            logger.warning(warn_msg)
+            pl = Plotter()
+        else:
+            pl = Plotter()
+        return pl
+
+    def show_plotter(self, plotter, screenshot):
+        """Shows the plotter or starts Trame service.
+
+        Parameters
+        ----------
+        plotter : Plotter
+            PyGeometry plotter with the meshes added.
+        screenshot : str, default: None
+            Save a screenshot of the image being represented. The image is
+            stored in the path provided as an argument.
+        """
+        if self._use_trame and _HAS_TRAME:
+            visualizer = TrameVisualizer()
+            visualizer.set_scene(plotter)
+            visualizer.show()
+        else:
+            plotter.show(screenshot=screenshot)
+        pv.OFF_SCREEN = self._pv_off_screen_original

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

@@ -0,0 +1,51 @@
+"""Module for the trame visualizer."""
+try:
+    from pyvista.trame.ui import plotter_ui
+    from trame.app import get_server
+    from trame.ui.vuetify import SinglePageLayout
+
+    _HAS_TRAME = True
+
+except ModuleNotFoundError:  # pragma: no cover
+    _HAS_TRAME = False
+
+
+class TrameVisualizer:
+    """Trame visualizer class. It will define how the trame view layout will be."""
+
+    def __init__(self) -> None:
+        """Inits server and server related variables."""
+        if not _HAS_TRAME:  # pragma: no cover
+            raise ModuleNotFoundError(
+                "The package 'pyvista[trame]' is required to use this function."
+            )
+
+        self.server = get_server()
+        self.state, self.ctrl = self.server.state, self.server.controller
+
+    def set_scene(self, plotter):
+        """Sets the trame layout view and the mesh to show
+        through the pyvista plotter.
+
+        Parameters
+        ----------
+        plotter : pv.Plotter
+            PyVista plotter with the mesh rendered.
+        """
+        self.state.trame__title = "PyGeometry Viewer"
+
+        with SinglePageLayout(self.server) as layout:
+            layout.icon.click = self.ctrl.view_reset_camera
+            layout.title.set_text("PyGeometry")
+
+            with layout.content:
+                # Use PyVista UI template for Plotters
+                view = plotter_ui(plotter.scene)
+                self.ctrl.view_update = view.update
+
+            # hide footer with trame watermark
+            layout.footer.hide()
+
+    def show(self):
+        """Starts the server and shows the mesh."""
+        self.server.start()