Merge pull request #1029 from compas-dev/plotter-remove-collection

Fix remove collection

Author: tomvanmele

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 * Set `jinja >= 3.0` to dev dependencies to fix docs build error.
+* Fixed removing of collections for `compas_plotters`.
 
 ### Removed
 

src/compas/artists/colordict.py

@@ -1,5 +1,6 @@
 import compas
 from collections import defaultdict
+
 if compas.PY2:
     from collections import Mapping
 else:
@@ -12,7 +13,7 @@ class DescriptorProtocol(type):
 
     def __init__(cls, name, bases, attrs):
         for k, v in iter(attrs.items()):
-            if hasattr(v, '__set_name__'):
+            if hasattr(v, "__set_name__"):
                 v.__set_name__(cls, k)
 
 
@@ -58,8 +59,8 @@ def __set_name__(self, owner, name):
 
         """
         self.public_name = name
-        self.private_name = '_' + name
-        self.default_name = 'default_' + ''.join(name.split('_'))
+        self.private_name = "_" + name
+        self.default_name = "default_" + "".join(name.split("_"))
 
     def __get__(self, obj, otype=None):
         """Get the color dict stored in the private attribute corresponding to the public attribute name of the descriptor.

src/compas_plotters/artists/networkartist.py

@@ -55,19 +55,21 @@ class NetworkArtist(PlotterArtist, NetworkArtist):
 
     """
 
-    def __init__(self,
-                 network: Network,
-                 nodes: Optional[List[int]] = None,
-                 edges: Optional[List[int]] = None,
-                 nodecolor: Color = (1.0, 1.0, 1.0),
-                 edgecolor: Color = (0.0, 0.0, 0.0),
-                 edgewidth: float = 1.0,
-                 show_nodes: bool = True,
-                 show_edges: bool = True,
-                 nodesize: int = 5,
-                 sizepolicy: Literal['relative', 'absolute'] = 'relative',
-                 zorder: int = 1000,
-                 **kwargs):
+    def __init__(
+        self,
+        network: Network,
+        nodes: Optional[List[int]] = None,
+        edges: Optional[List[int]] = None,
+        nodecolor: Color = (1.0, 1.0, 1.0),
+        edgecolor: Color = (0.0, 0.0, 0.0),
+        edgewidth: float = 1.0,
+        show_nodes: bool = True,
+        show_edges: bool = True,
+        nodesize: int = 5,
+        sizepolicy: Literal["relative", "absolute"] = "relative",
+        zorder: int = 1000,
+        **kwargs,
+    ):
 
         super().__init__(network=network, **kwargs)
 
@@ -101,21 +103,31 @@ def item(self, item: Network):
 
     @property
     def data(self) -> List[List[float]]:
-        return self.network.nodes_attributes('xy')
+        return self.network.nodes_attributes("xy")
 
     @property
     def node_size(self):
         if not self._node_size:
-            factor = self.plotter.dpi if self.sizepolicy == 'absolute' else self.network.number_of_nodes()
+            factor = (
+                self.plotter.dpi
+                if self.sizepolicy == "absolute"
+                else self.network.number_of_nodes()
+            )
             size = self.default_nodesize / factor
             self._node_size = {node: size for node in self.network.nodes()}
         return self._node_size
 
     @node_size.setter
     def node_size(self, nodesize):
-        factor = self.plotter.dpi if self.sizepolicy == 'absolute' else self.network.number_of_nodes()
+        factor = (
+            self.plotter.dpi
+            if self.sizepolicy == "absolute"
+            else self.network.number_of_nodes()
+        )
         if isinstance(nodesize, dict):
-            self.node_size.update({node: size / factor for node, size in nodesize.items()})
+            self.node_size.update(
+                {node: size / factor for node, size in nodesize.items()}
+            )
         elif isinstance(nodesize, (int, float)):
             self._node_size = {node: nodesize / factor for node in self.network.nodes()}
 
@@ -132,7 +144,7 @@ def clear_nodes(self):
 
         """
         if self._nodecollection:
-            self.plotter.axes.remove_collection(self._nodecollection)
+            self._nodecollection.remove()
         self._nodecollection = None
 
     def clear_edges(self):
@@ -144,14 +156,16 @@ def clear_edges(self):
 
         """
         if self._edgecollection:
-            self.plotter.axes.remove_collection(self._edgecollection)
+            self._edgecollection.remove()
         self._edgecollection = None
 
-    def draw(self,
-             nodes: Optional[List[int]] = None,
-             edges: Optional[Tuple[int, int]] = None,
-             nodecolor: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None,
-             edgecolor: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None) -> None:
+    def draw(
+        self,
+        nodes: Optional[List[int]] = None,
+        edges: Optional[Tuple[int, int]] = None,
+        nodecolor: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None,
+        edgecolor: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None,
+    ) -> None:
         """Draw the network.
 
         Parameters
@@ -178,9 +192,11 @@ def draw(self,
         if self.show_edges:
             self.draw_edges(edges=edges, color=edgecolor)
 
-    def draw_nodes(self,
-                   nodes: Optional[List[int]] = None,
-                   color: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None) -> None:
+    def draw_nodes(
+        self,
+        nodes: Optional[List[int]] = None,
+        color: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None,
+    ) -> None:
         """Draw a selection of nodes.
 
         Parameters
@@ -215,17 +231,16 @@ def draw_nodes(self,
             circles.append(circle)
 
         collection = PatchCollection(
-            circles,
-            match_original=True,
-            zorder=self.zorder_nodes,
-            alpha=1.0
+            circles, match_original=True, zorder=self.zorder_nodes, alpha=1.0
         )
         self.plotter.axes.add_collection(collection)
         self._nodecollection = collection
 
-    def draw_edges(self,
-                   edges: Optional[Tuple[int, int]] = None,
-                   color: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None) -> None:
+    def draw_edges(
+        self,
+        edges: Optional[Tuple[int, int]] = None,
+        color: Optional[Union[str, Color, List[Color], Dict[int, Color]]] = None,
+    ) -> None:
         """Draw a selection of edges.
 
         Parameters
@@ -259,9 +274,9 @@ def draw_edges(self,
             lines,
             linewidths=widths,
             colors=colors,
-            linestyle='solid',
+            linestyle="solid",
             alpha=1.0,
-            zorder=self.zorder_edges
+            zorder=self.zorder_edges,
         )
         self.plotter.axes.add_collection(collection)
         self._edgecollection = collection
@@ -292,19 +307,20 @@ def draw_nodelabels(self, text: Optional[Dict[int, str]] = None) -> None:
             color = (0, 0, 0) if is_color_light(bgcolor) else (1, 1, 1)
 
             text = self.node_text.get(node, None)
-            print(text)
             if text is None:
                 continue
 
             x, y = self.node_xyz[node][:2]
             artist = self.plotter.axes.text(
-                x, y,
-                f'{text}',
+                x,
+                y,
+                f"{text}",
                 fontsize=self.plotter.fontsize,
-                family='monospace',
-                ha='center', va='center',
+                family="monospace",
+                ha="center",
+                va="center",
                 zorder=10000,
-                color=color
+                color=color,
             )
             labels.append(artist)
 
@@ -343,13 +359,21 @@ def draw_edgelabels(self, text: Optional[Dict[int, str]] = None) -> None:
             y = 0.5 * (y0 + y1)
 
             artist = self.plotter.axes.text(
-                x, y, f'{text}',
+                x,
+                y,
+                f"{text}",
                 fontsize=self.plotter.fontsize,
-                family='monospace',
-                ha='center', va='center',
+                family="monospace",
+                ha="center",
+                va="center",
                 zorder=10000,
                 color=(0, 0, 0),
-                bbox=dict(boxstyle='round, pad=0.3', facecolor=(1, 1, 1), edgecolor=None, linewidth=0)
+                bbox=dict(
+                    boxstyle="round, pad=0.3",
+                    facecolor=(1, 1, 1),
+                    edgecolor=None,
+                    linewidth=0,
+                ),
             )
             labels.append(artist)
 

src/compas_rhino/artists/__init__.py

@@ -87,7 +87,6 @@
 from compas.plugins import plugin
 from compas.artists import Artist
 from compas.artists import ShapeArtist
-
 from compas.geometry import Circle
 from compas.geometry import Frame
 from compas.geometry import Line
@@ -141,6 +140,7 @@
 
 BaseArtist = RhinoArtist
 
+
 ShapeArtist.default_color = (255, 255, 255)
 
 # MeshArtist.default_color = (0, 0, 0)
@@ -158,64 +158,64 @@
 VolMeshArtist.default_cellcolor = (255, 0, 0)
 
 
-@plugin(category='drawing-utils', pluggable_name='clear', requires=['Rhino'])
+@plugin(category="drawing-utils", pluggable_name="clear", requires=["Rhino"])
 def clear_rhino():
     compas_rhino.clear()
 
 
-@plugin(category='drawing-utils', pluggable_name='redraw', requires=['Rhino'])
+@plugin(category="drawing-utils", pluggable_name="redraw", requires=["Rhino"])
 def redraw_rhino():
     compas_rhino.redraw()
 
 
-@plugin(category='factories', requires=['Rhino'])
+@plugin(category="factories", requires=["Rhino"])
 def register_artists():
-    Artist.register(Circle, CircleArtist, context='Rhino')
-    Artist.register(Frame, FrameArtist, context='Rhino')
-    Artist.register(Line, LineArtist, context='Rhino')
-    Artist.register(Plane, PlaneArtist, context='Rhino')
-    Artist.register(Point, PointArtist, context='Rhino')
-    Artist.register(Polygon, PolygonArtist, context='Rhino')
-    Artist.register(Polyline, PolylineArtist, context='Rhino')
-    Artist.register(Vector, VectorArtist, context='Rhino')
-    Artist.register(Box, BoxArtist, context='Rhino')
-    Artist.register(Capsule, CapsuleArtist, context='Rhino')
-    Artist.register(Cone, ConeArtist, context='Rhino')
-    Artist.register(Cylinder, CylinderArtist, context='Rhino')
-    Artist.register(Polyhedron, PolyhedronArtist, context='Rhino')
-    Artist.register(Sphere, SphereArtist, context='Rhino')
-    Artist.register(Torus, TorusArtist, context='Rhino')
-    Artist.register(Mesh, MeshArtist, context='Rhino')
-    Artist.register(Network, NetworkArtist, context='Rhino')
-    Artist.register(VolMesh, VolMeshArtist, context='Rhino')
-    Artist.register(RobotModel, RobotModelArtist, context='Rhino')
-    Artist.register(Curve, CurveArtist, context='Rhino')
-    Artist.register(Surface, SurfaceArtist, context='Rhino')
-    print('Rhino Artists registered.')
+    Artist.register(Circle, CircleArtist, context="Rhino")
+    Artist.register(Frame, FrameArtist, context="Rhino")
+    Artist.register(Line, LineArtist, context="Rhino")
+    Artist.register(Plane, PlaneArtist, context="Rhino")
+    Artist.register(Point, PointArtist, context="Rhino")
+    Artist.register(Polygon, PolygonArtist, context="Rhino")
+    Artist.register(Polyline, PolylineArtist, context="Rhino")
+    Artist.register(Vector, VectorArtist, context="Rhino")
+    Artist.register(Box, BoxArtist, context="Rhino")
+    Artist.register(Capsule, CapsuleArtist, context="Rhino")
+    Artist.register(Cone, ConeArtist, context="Rhino")
+    Artist.register(Cylinder, CylinderArtist, context="Rhino")
+    Artist.register(Polyhedron, PolyhedronArtist, context="Rhino")
+    Artist.register(Sphere, SphereArtist, context="Rhino")
+    Artist.register(Torus, TorusArtist, context="Rhino")
+    Artist.register(Mesh, MeshArtist, context="Rhino")
+    Artist.register(Network, NetworkArtist, context="Rhino")
+    Artist.register(VolMesh, VolMeshArtist, context="Rhino")
+    Artist.register(RobotModel, RobotModelArtist, context="Rhino")
+    Artist.register(Curve, CurveArtist, context="Rhino")
+    Artist.register(Surface, SurfaceArtist, context="Rhino")
+    print("Rhino Artists registered.")
 
 
 __all__ = [
-    'BaseArtist',
-    'RhinoArtist',
-    'CircleArtist',
-    'FrameArtist',
-    'LineArtist',
-    'PlaneArtist',
-    'PointArtist',
-    'PolygonArtist',
-    'PolylineArtist',
-    'VectorArtist',
-    'BoxArtist',
-    'CapsuleArtist',
-    'ConeArtist',
-    'CylinderArtist',
-    'PolyhedronArtist',
-    'SphereArtist',
-    'TorusArtist',
-    'MeshArtist',
-    'NetworkArtist',
-    'VolMeshArtist',
-    'RobotModelArtist',
-    'CurveArtist',
-    'SurfaceArtist',
+    "BaseArtist",
+    "RhinoArtist",
+    "CircleArtist",
+    "FrameArtist",
+    "LineArtist",
+    "PlaneArtist",
+    "PointArtist",
+    "PolygonArtist",
+    "PolylineArtist",
+    "VectorArtist",
+    "BoxArtist",
+    "CapsuleArtist",
+    "ConeArtist",
+    "CylinderArtist",
+    "PolyhedronArtist",
+    "SphereArtist",
+    "TorusArtist",
+    "MeshArtist",
+    "NetworkArtist",
+    "VolMeshArtist",
+    "RobotModelArtist",
+    "CurveArtist",
+    "SurfaceArtist",
 ]