Fix drawing animated artists changed in selector callback

[ericpre]

PR Summary

Alternative to #20977.

PR Checklist

• [N/A] Has pytest style unit tests (and pytest passes).
• Is Flake 8 compliant (run flake8 on changed files to check).
• [N/A] New features are documented, with examples if plot related.
• [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).
• Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
• [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
• [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

[anntzer]

I like the general approach more here.

[ericpre]

Yes, I agree, this is much better! :)

[anntzer]

+/- stylistic point above.

[ericpre]

In 515aa53, I remove the if artist.stale:, because when using blitting, the animated artists which are not stale will be missing, because they will either: not be part of the background or not be drawn (because stale is False!).

Adapting one of the blitting example:

import matplotlib.pyplot as plt
from matplotlib.widgets import SpanSelector
import numpy as np

x = np.linspace(0, 2 * np.pi, 100)
values = np.sin(x)

fig, ax = plt.subplots()
(ln,) = ax.plot(x, values, animated=True)
(ln2 , ) = ax.plot([], animated=True)

plt.show(block=False)
plt.pause(0.1)

bg = fig.canvas.copy_from_bbox(fig.bbox)
ax.draw_artist(ln)
fig.canvas.blit(fig.bbox)

def mean(vmin, vmax):
    indmin, indmax = np.searchsorted(x, (vmin, vmax))
    v = values[indmin:indmax].mean()
    ln2.set_data(x, v)
    
span = SpanSelector(ax, mean, direction='horizontal',
                    onmove_callback=mean,
                    interactive=True,
                    drag_from_anywhere=True,
                    useblit=True)

[dstansby]

Looks 👍 - is there a test we an add for this?

[ericpre]

I have added a test and switch to list comprehension instead of using filter.

[ericpre]

2a5c86c fixes an issue with zorder of the artists. Before 2a5c86c, the selector artists will be drawn before other artists and therefore it was behind, as in the following example:

import matplotlib.pyplot as plt
from matplotlib.widgets import SpanSelector
import numpy as np

values = np.ones((10, 10))

fig, ax = plt.subplots()
ax.imshow(values, animated=True)

span = SpanSelector(ax, print, direction='horizontal',
                    interactive=True,
                    drag_from_anywhere=True,
                    useblit=True)

when sorting the artists order, all artists need to sorted together!

[ericpre]

@dstansby, any chance you can have a look at this again, please? Thanks!

[tacaswell]

This PR is affected by a re-writing of our history to remove a large number of accidentally committed files see discourse for details.

To recover this PR it will need be rebased onto the new default branch (main). There are several ways to accomplish this, but we recommend (assuming that you call the matplotlib/matplotlib remote "upstream"

git remote update
git checkout main
git merge --ff-only upstream/main
git checkout YOUR_BRANCH
git rebase --onto=main upstream/old_master
# git rebase -i main # if you prefer
git push --force-with-lease   # assuming you are tracking your branch

If you do not feel comfortable doing this or need any help please reach out to any of the Matplotlib developers. We can either help you with the process or do it for you.

Thank you for your contributions to Matplotlib and sorry for the inconvenience.

[ericpre]

Can anyone review this PR, please?

[ericpre]

@dstansby, if this PR looks good to you - from your comment in #21342 (review); can you please approve and merge? :) Thanks!

[dstansby]

Why a tuple and not a list?

[ericpre]

No particular reason.

[tacaswell]

Suggested change

	return tuple([a for ax_ in self.ax.get_figure().get_axes()
	for a in ax_.get_children()
	if a.get_animated() and a not in self.artists])
	return tuple(a for ax_ in self.ax.get_figure().get_axes()
	for a in ax_.get_children()
	if a.get_animated() and a not in self.artists)

if we are going with a tuple might as well not bother with the list in the middle. I have a slight preference for tuple over list because immutablability is good, but given that his is an internal API either is fine with me!

[ericpre]

Done!

[ericpre]

Rebased to get the test suite to pass, can anyone merge this PR?