Skip to content

Avoid single_path_optimization if offsets are non-zero #16517

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.

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
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions lib/matplotlib/collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,14 @@ def draw(self, renderer):
and extents.height < self.figure.bbox.height):
do_single_path_optimization = True

# The single path optimization code path is currently broken when
# offsets are specified
# (https://github.com/matplotlib/matplotlib/issues/16496)
# This should be fixed eventually, but for now don't use the optimized
# code path if some of the offsets are non-zero
if np.any(offsets != 0) and self._offset_position == 'data':
do_single_path_optimization = False

if self._joinstyle:
gc.set_joinstyle(self._joinstyle)

Expand Down
24 changes: 23 additions & 1 deletion lib/matplotlib/tests/test_collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import matplotlib.collections as mcollections
import matplotlib.transforms as mtransforms
from matplotlib.collections import Collection, LineCollection, EventCollection
from matplotlib.testing.decorators import image_comparison
from matplotlib.testing.decorators import image_comparison, check_figures_equal


def generate_EventCollection_plot():
Expand Down Expand Up @@ -612,3 +612,25 @@ def test_EventCollection_nosort():
arr = np.array([3, 2, 1, 10])
coll = EventCollection(arr)
np.testing.assert_array_equal(arr, np.array([3, 2, 1, 10]))


@check_figures_equal()
def test_collection_offset(fig_test, fig_ref):
polygon = np.array([[-1, -1], [-1, 1], [1, 1], [1, -1]]) * 0.1
offsets = np.array([2, 2])

# Add the collection off the edge of the axes, so if offsets is applied
# correctly it is not within the axes bounds
ax = fig_test.subplots()
# edgecolors and linewidths must be set to trigger the right code path
collection = mcollections.PolyCollection(
[polygon],
edgecolors='face',
linewidths=[1],
offsets=offsets,
transOffset=mtransforms.IdentityTransform(),
offset_position="data")
ax.add_collection(collection)

# Create an empty figure
ax = fig_ref.subplots()