fix: well actor wasn't remove correctly

Author: lucas-givord

geos-trame/src/geos/trame/app/ui/viewer/viewer.py

@@ -235,6 +235,7 @@ def _update_internalwell( self, path: str, show: bool ) -> None:
         """
         if not show:
             self.plotter.remove_actor( self.well_engine.get_actor( path ) )  # type: ignore
+            self.well_engine.remove_actor( path )
             return
 
         tube_actor = self.plotter.add_mesh( self.well_engine.get_tube( self.well_engine.get_last_mesh_idx() ) )
@@ -249,6 +250,7 @@ def _update_vtkwell( self, path: str, show: bool ) -> None:
         """
         if not show:
             self.plotter.remove_actor( self.well_engine.get_actor( path ) )  # type: ignore
+            self.well_engine.remove_actor( path )
             return
 
         tube_actor = self.plotter.add_mesh( self.well_engine.get_tube( self.well_engine.get_last_mesh_idx() ) )

geos-trame/src/geos/trame/app/ui/viewer/wellViewer.py

@@ -17,6 +17,12 @@ class Well:
     well_path: str
     polyline: pv.PolyData
     tube: pv.PolyData
+
+
+@dataclass
+class WellActor:
+    """A WellActor stores the VTK Actor representing a well."""
+    well_path: str
     actor: pv.Actor
 
 
@@ -28,6 +34,7 @@ def __init__( self, size: float, amplification: float ) -> None:
         A Well in GEOS could a InternalWell or a Vtkwell.
         """
         self._wells: list[ Well ] = []
+        self._wells_actors: list[ WellActor ] = []
 
         self.size: float = size
         self.amplification: float = amplification
@@ -51,7 +58,8 @@ def add_mesh( self, mesh: pv.PolyData, mesh_path: str ) -> int:
         radius = self.size * ( self.STARTING_VALUE / 100 )
         tube = mesh.tube( radius=radius, n_sides=50 )
 
-        self._wells.append( Well( mesh_path, mesh, tube, pv.Actor() ) )
+        self._wells.append( Well( mesh_path, mesh, tube ) )
+        self._wells_actors.append( WellActor( mesh_path, pv.Actor() ) )
 
         return len( self._wells ) - 1
 
@@ -78,21 +86,21 @@ def get_tube_size( self ) -> float:
 
     def append_actor( self, perforation_path: str, tube_actor: pv.Actor ) -> None:
         """Append a given actor, typically the Actor returned by the pv.Plotter() when a given mes is added."""
-        index = self._get_index_from_perforation( perforation_path )
+        index = self._get_actor_index_from_perforation( perforation_path )
         if index == -1:
             print( "Cannot found the well to remove from path: ", perforation_path )
             return
 
-        self._wells[ index ].actor = tube_actor
+        self._wells_actors[ index ].actor = tube_actor
 
     def get_actor( self, perforation_path: str ) -> pv.Actor | None:
         """Retrieve the polyline linked to a given perforation path."""
-        index = self._get_index_from_perforation( perforation_path )
+        index = self._get_actor_index_from_perforation( perforation_path )
         if index == -1:
             print( "Cannot found the well to remove from path: ", perforation_path )
             return None
 
-        return self._wells[ index ].actor
+        return self._wells_actors[ index ].actor
 
     def update( self, value: float ) -> None:
         """Update the radius of the tubes."""
@@ -108,6 +116,14 @@ def remove( self, perforation_path: str ) -> None:
 
         self._wells.remove( self._wells[ index ] )
 
+    def remove_actor( self, perforation_path: str ) -> None:
+        """Clear all data stored in this class."""
+        index = self._get_actor_index_from_perforation( perforation_path )
+        if index == -1:
+            print( "Cannot found the well to remove from path: ", perforation_path )
+
+        self._wells_actors.remove( self._wells_actors[ index ] )
+
     def _get_index_from_perforation( self, perforation_path: str ) -> int:
         """Retrieve the well associated to a given perforation, otherwise return -1."""
         index = -1
@@ -121,6 +137,19 @@ def _get_index_from_perforation( self, perforation_path: str ) -> int:
 
         return index
 
+    def _get_actor_index_from_perforation( self, perforation_path: str ) -> int:
+        """Retrieve the well actor associated to a given perforation, otherwise return -1."""
+        index = -1
+        if len( self._wells_actors ) == 0:
+            return index
+
+        for i in range( 0, len( self._wells_actors ) ):
+            if self._wells_actors[ i ].well_path in perforation_path:
+                index = i
+                break
+
+        return index
+
     def get_number_of_wells( self ) -> int:
         """Get the number of wells in the viewer."""
         return len( self._wells )