From 301001532abd84b89c4398a01fdff19ab14fe615 Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 15:05:31 +0200 Subject: [PATCH 1/3] fix: Add proper behaviour in show method --- .../backends/pyvista/pyvista.py | 3 -- .../tools/visualization_interface/plotter.py | 31 +++++++++++++++++-- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py index fd2c06b9..2f85cf47 100644 --- a/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py +++ b/src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py @@ -500,6 +500,3 @@ def plot(self, object: Any, filter: str = None, **plotting_options): else: self.pv_interface.plot(object, filter, **plotting_options) - def show(self): - """Show the rendered scene.""" - self.pv_interface.show() diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index 958f2676..f66ecaee 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -56,6 +56,31 @@ def plot(self, object: Any, **plotting_options): """ self._backend.plot(object=object, **plotting_options) - def show(self): - """Show the plotted objects.""" - self._backend.show() + def show( + self, + object: Any = None, + screenshot: str = None, + view_2d: bool = None, + filter: bool = None, + **plotting_options + ) -> None: + """Show the plotted objects. + + Parameters + ---------- + object : Any, optional + Object to show, by default None. + screenshot : str, optional + Path to save a screenshot, by default None. + view_2d : bool, optional + Flag to show the object in 2D, by default None. + filter : bool, optional + Flag to filter the object, by default None. + """ + self._backend.show( + object=object, + screenshot=screenshot, + view_2d=view_2d, + filter=filter, + **plotting_options + ) From aafe90d5f71860cf19e308c84c021e2c3efba63e Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 15:44:06 +0200 Subject: [PATCH 2/3] fix: Remove view_2d parameter --- src/ansys/tools/visualization_interface/plotter.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index f66ecaee..2c9265f4 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -60,7 +60,6 @@ def show( self, object: Any = None, screenshot: str = None, - view_2d: bool = None, filter: bool = None, **plotting_options ) -> None: @@ -72,15 +71,12 @@ def show( Object to show, by default None. screenshot : str, optional Path to save a screenshot, by default None. - view_2d : bool, optional - Flag to show the object in 2D, by default None. filter : bool, optional Flag to filter the object, by default None. """ self._backend.show( object=object, screenshot=screenshot, - view_2d=view_2d, filter=filter, **plotting_options ) From eb8c248ff4c8176c938f0303d39bf4e892765407 Mon Sep 17 00:00:00 2001 From: afernand Date: Wed, 22 May 2024 16:21:53 +0200 Subject: [PATCH 3/3] fix: Add missing parameter doc --- src/ansys/tools/visualization_interface/plotter.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ansys/tools/visualization_interface/plotter.py b/src/ansys/tools/visualization_interface/plotter.py index 2c9265f4..e02bc95d 100644 --- a/src/ansys/tools/visualization_interface/plotter.py +++ b/src/ansys/tools/visualization_interface/plotter.py @@ -73,6 +73,8 @@ def show( Path to save a screenshot, by default None. filter : bool, optional Flag to filter the object, by default None. + plotting_options : dict + Additional plotting options the selected backend accepts. """ self._backend.show( object=object,