Add blitting support to the RadioButtons widget

QuLogic · QuLogic · commit aaa9edb32125 · 2022-11-29T03:23:24.000-05:00
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1396,7 +1396,8 @@ class RadioButtons(AxesWidget):
         The label text of the currently selected button.
     """
 
-    def __init__(self, ax, labels, active=0, activecolor='blue'):
+    def __init__(self, ax, labels, active=0, activecolor='blue',
+                 useblit=False):
         """
         Add radio buttons to an `~.axes.Axes`.
 
@@ -1410,6 +1411,9 @@ def __init__(self, ax, labels, active=0, activecolor='blue'):
             The index of the initially selected button.
         activecolor : color
             The color of the selected button.
+        useblit : bool, default: False
+            Use blitting for faster drawing if supported by the backend.
+            See the tutorial :doc:`/tutorials/advanced/blitting` for details.
         """
         super().__init__(ax)
         self.activecolor = activecolor
@@ -1422,19 +1426,35 @@ def __init__(self, ax, labels, active=0, activecolor='blue'):
         ys = np.linspace(1, 0, len(labels) + 2)[1:-1]
         text_size = mpl.rcParams["font.size"] / 2
 
+        self._useblit = useblit and self.canvas.supports_blit
+        self._background = None
+
         self.labels = [
             ax.text(0.25, y, label, transform=ax.transAxes,
                     horizontalalignment="left", verticalalignment="center")
             for y, label in zip(ys, labels)]
         self._buttons = ax.scatter(
             [.15] * len(ys), ys, transform=ax.transAxes, s=text_size**2,
             c=[activecolor if i == active else "none" for i in range(len(ys))],
-            edgecolor="black")
+            edgecolor="black", animated=self._useblit)
 
         self.connect_event('button_press_event', self._clicked)
+        if self._useblit:
+            self.connect_event('draw_event', self._clear)
 
         self._observers = cbook.CallbackRegistry(signals=["clicked"])
 
+    def _clear(self, event):
+        """Internal event handler to clear the buttons."""
+        if self.ignore(event):
+            return
+        self._background = self.canvas.copy_from_bbox(self.ax.bbox)
+        if hasattr(self, "_circles"):  # Remove once circles is removed.
+            for circle in self._circles:
+                self.ax.draw_artist(circle)
+        else:
+            self.ax.draw_artist(self._buttons)
+
     def _clicked(self, event):
         if self.ignore(event) or event.button != 1 or event.inaxes != self.ax:
             return
@@ -1468,11 +1488,23 @@ def set_active(self, index):
         self.value_selected = self.labels[index].get_text()
         self._buttons.get_facecolor()[:] = colors.to_rgba("none")
         self._buttons.get_facecolor()[index] = colors.to_rgba(self.activecolor)
+        if self._background is not None:
+            self.canvas.restore_region(self._background)
         if hasattr(self, "_circles"):  # Remove once circles is removed.
             for i, p in enumerate(self._circles):
                 p.set_facecolor(self.activecolor if i == index else "none")
+                if self.drawon and self._useblit:
+                    self.ax.draw_artist(p)
+        else:
+            if self.drawon and self._useblit:
+                self.ax.draw_artist(self._buttons)
+
         if self.drawon:
-            self.ax.figure.canvas.draw()
+            if self._useblit:
+                self.canvas.blit(self.ax.bbox)
+            else:
+                self.canvas.draw()
+
         if self.eventson:
             self._observers.process('clicked', self.labels[index].get_text())
 
@@ -1496,7 +1528,8 @@ def circles(self):
             circles = self._circles = [
                 Circle(xy=self._buttons.get_offsets()[i], edgecolor="black",
                        facecolor=self._buttons.get_facecolor()[i],
-                       radius=radius, transform=self.ax.transAxes)
+                       radius=radius, transform=self.ax.transAxes,
+                       animated=self._useblit)
                 for i in range(len(self.labels))]
             self._buttons.set_visible(False)
             for circle in circles:
