Skip to content

MNT: Make useblit a property in Widget classes #30605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tacaswell wants to merge 1 commit into from
Closed

MNT: Make useblit a property in Widget classes #30605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 40 additions & 18 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class AxesWidget(Widget):
active : bool
If False, the widget does not respond to events.
"""
_useblit = False

def __init__(self, ax):
self.ax = ax
Expand All @@ -121,6 +122,16 @@ def __init__(self, ax):
lambda self: getattr(self.ax.get_figure(root=True), 'canvas', None)
)

useblit = property(
fget=lambda self: (
self._useblit and
(canvas := self.canvas) is not None and
canvas.supports_blit
),
fset=lambda self, useblit: setattr(self, '_useblit', useblit),
doc="If the user asked for blitting AND if the canvas supports it"
)

def connect_event(self, event, callback):
"""
Connect a callback function with an event.
Expand Down Expand Up @@ -201,7 +212,7 @@ def __init__(self, ax, label, image=None,
horizontalalignment='center',
transform=ax.transAxes)

self._useblit = useblit and self.canvas.supports_blit
self._useblit = useblit

self._observers = cbook.CallbackRegistry(signals=["clicked"])

Expand Down Expand Up @@ -235,7 +246,7 @@ def _motion(self, event):
if not colors.same_color(c, self.ax.get_facecolor()):
self.ax.set_facecolor(c)
if self.drawon:
if self._useblit:
if self.useblit:
self.ax.draw_artist(self.ax)
self.canvas.blit(self.ax.bbox)
else:
Expand Down Expand Up @@ -1057,7 +1068,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
if actives is None:
actives = [False] * len(labels)

self._useblit = useblit and self.canvas.supports_blit
self._useblit = useblit
self._background = None

ys = np.linspace(1, 0, len(labels)+2)[1:-1]
Expand Down Expand Up @@ -1086,7 +1097,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
**cbook.normalize_kwargs(check_props, collections.PathCollection),
'marker': 'x',
'transform': ax.transAxes,
'animated': self._useblit,
'animated': self.useblit,
}
check_props.setdefault('facecolor', check_props.pop('color', 'black'))
self._checks = ax.scatter([0.15] * len(ys), ys, **check_props)
Expand All @@ -1096,7 +1107,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
self._init_status(actives)

self.connect_event('button_press_event', self._clicked)
if self._useblit:
if self.useblit:
self.connect_event('draw_event', self._clear)

self._observers = cbook.CallbackRegistry(signals=["clicked"])
Expand All @@ -1105,7 +1116,8 @@ def _clear(self, event):
"""Internal event handler to clear the buttons."""
if self.ignore(event) or self.canvas.is_saving():
return
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
if self.useblit:
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
self.ax.draw_artist(self._checks)

def _clicked(self, event):
Expand Down Expand Up @@ -1209,7 +1221,7 @@ def set_active(self, index, state=None):
self._checks.set_facecolor(facecolors)

if self.drawon:
if self._useblit:
if self.useblit:
if self._background is not None:
self.canvas.restore_region(self._background)
self.ax.draw_artist(self._checks)
Expand Down Expand Up @@ -1644,7 +1656,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,

ys = np.linspace(1, 0, len(labels) + 2)[1:-1]

self._useblit = useblit and self.canvas.supports_blit
self._useblit = useblit
self._background = None

label_props = _expand_text_props(label_props)
Expand All @@ -1660,7 +1672,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
**radio_props,
'marker': 'o',
'transform': ax.transAxes,
'animated': self._useblit,
'animated': self.useblit,
}
radio_props.setdefault('edgecolor', radio_props.get('color', 'black'))
radio_props.setdefault('facecolor',
Expand All @@ -1678,7 +1690,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
for i, activecolor in enumerate(self._active_colors)])

self.connect_event('button_press_event', self._clicked)
if self._useblit:
if self.useblit:
self.connect_event('draw_event', self._clear)

self._observers = cbook.CallbackRegistry(signals=["clicked"])
Expand All @@ -1687,7 +1699,8 @@ def _clear(self, event):
"""Internal event handler to clear the buttons."""
if self.ignore(event) or self.canvas.is_saving():
return
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
if self.useblit:
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
self.ax.draw_artist(self._buttons)

def _clicked(self, event):
Expand Down Expand Up @@ -1779,7 +1792,7 @@ def set_active(self, index):
self._buttons.set_facecolor(button_facecolors)

if self.drawon:
if self._useblit:
if self.useblit:
if self._background is not None:
self.canvas.restore_region(self._background)
self.ax.draw_artist(self._buttons)
Expand Down Expand Up @@ -1930,7 +1943,7 @@ def __init__(self, ax, *, horizOn=True, vertOn=True, useblit=False,
self.visible = True
self.horizOn = horizOn
self.vertOn = vertOn
self.useblit = useblit and self.canvas.supports_blit
self._useblit = useblit

if self.useblit:
lineprops['animated'] = True
Expand Down Expand Up @@ -2015,6 +2028,17 @@ class MultiCursor(Widget):
--------
See :doc:`/gallery/widgets/multicursor`.
"""
_useblit = False

@property
def useblit(self):
return (
self._useblit and all(canvas.supports_blit for canvas in self._canvas_infos)
)

@useblit.setter
def useblit(self, useblit):
self._useblit = useblit

def __init__(self, canvas, axes, *, useblit=True, horizOn=False, vertOn=True,
**lineprops):
Expand All @@ -2036,9 +2060,7 @@ def __init__(self, canvas, axes, *, useblit=True, horizOn=False, vertOn=True,
ymid = 0.5 * (ymin + ymax)

self.visible = True
self.useblit = (
useblit
and all(canvas.supports_blit for canvas in self._canvas_infos))
self._useblit = useblit

if self.useblit:
lineprops['animated'] = True
Expand Down Expand Up @@ -2123,7 +2145,7 @@ def __init__(self, ax, onselect=None, useblit=False, button=None,
self.onselect = lambda *args: None
else:
self.onselect = onselect
self.useblit = useblit and self.canvas.supports_blit
self._useblit = useblit
self.connect_default_events()

self._state_modifier_keys = dict(move=' ', clear='escape',
Expand Down Expand Up @@ -4157,7 +4179,7 @@ class Lasso(AxesWidget):
def __init__(self, ax, xy, callback, *, useblit=True, props=None):
super().__init__(ax)

self.useblit = useblit and self.canvas.supports_blit
self._useblit = useblit
if self.useblit:
self.background = self.canvas.copy_from_bbox(self.ax.bbox)

Expand Down
Loading