Bump version 0.4.7

Author: RobPasMue

doc/changelog.d/175.added.md

@@ -0,0 +1 @@
+fix: preserve access order using dictionary and adapt show to already existing objects

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-tools-visualization-interface"
-version = "0.4.6"
+version = "0.4.7"
 description = "A Python visualization interface for PyAnsys libraries"
 readme = "README.rst"
 requires-python = ">=3.10,<4"

src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py

@@ -115,8 +115,8 @@ def __init__(
         # PyVista plotter
         self._pl = None
 
-        # List of picked objects in MeshObject format.
-        self._picked_list = set()
+        # Dictionary of picked objects in MeshObject format.
+        self._picked_dict = {}
 
         # Map that relates PyVista actors with the added actors by the picker
         self._picker_added_actors_map = {}
@@ -197,7 +197,7 @@ def select_object(self, custom_object: Union[MeshObjectPlot, EdgePlot], pt: np.n
         """Select a custom object in the plotter.
 
         This method highlights the edges of a body and adds a label. It also adds
-        the object to the ``_picked_list`` and the actor to the ``_picker_added_actors_map``.
+        the object to the ``_picked_dict`` and the actor to the ``_picker_added_actors_map``.
 
         Parameters
         ----------
@@ -234,8 +234,8 @@ def select_object(self, custom_object: Union[MeshObjectPlot, EdgePlot], pt: np.n
             )
             added_actors.append(label_actor)
 
-        if custom_object not in self._picked_list:
-            self._picked_list.add(custom_object)
+        if custom_object.name not in self._picked_dict:
+            self._picked_dict[custom_object.name] = custom_object
 
         self._picker_added_actors_map[custom_object.actor.name] = added_actors
 
@@ -252,8 +252,8 @@ def unselect_object(self, custom_object: Union[MeshObjectPlot, EdgePlot]) -> Non
 
         """
         # remove actor from picked list and from scene
-        if custom_object in self._picked_list:
-            self._picked_list.remove(custom_object)
+        if custom_object.name in self._picked_dict:
+            self._picked_dict.pop(custom_object.name)
 
         if isinstance(custom_object, MeshObjectPlot) and custom_object in self._origin_colors:
             custom_object.actor.prop.color = self._origin_colors[custom_object]
@@ -287,15 +287,15 @@ def picker_callback(self, actor: "pv.Actor") -> None:
         # if object is a body/component
         if actor in self._object_to_actors_map:
             body_plot = self._object_to_actors_map[actor]
-            if body_plot not in self._picked_list:
+            if body_plot.name not in self._picked_dict:
                 self.select_object(body_plot, pt)
             else:
                 self.unselect_object(body_plot)
 
         # if object is an edge
         elif actor in self._edge_actors_map and actor.GetVisibility():
             edge = self._edge_actors_map[actor]
-            if edge not in self._picked_list:
+            if edge.name not in self._picked_dict:
                 self.select_object(edge, pt)
             else:
                 self.unselect_object(edge)
@@ -439,12 +439,15 @@ def show(
         picked_objects_list = []
         if isinstance(plottable_object, list):
             # Keep them ordered based on picking
-            for meshobject in self._picked_list:
+            for meshobject in self._picked_dict.values():
                 for elem in plottable_object:
                     if hasattr(elem, "name") and elem.name == meshobject.name:
                         picked_objects_list.append(elem)
-        elif hasattr(plottable_object, "name") and plottable_object in self._picked_list:
+        elif hasattr(plottable_object, "name") and plottable_object.name in self._picked_dict:
             picked_objects_list = [plottable_object]
+        else:
+            # Return the picked objects in the order they were picked
+            picked_objects_list = list(self._picked_dict.values())
 
         return picked_objects_list