8000 Update Ellipse position with ellipse.center by eschutz · Pull Request #11057 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update Ellipse position with ellipse.center #11057

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

Jump to bottom
Merged
merged 2 commits into from
Apr 16, 2018
Merged

Update Ellipse position with ellipse.center #11057

merged 2 commits into from
Apr 16, 2018

Conversation

eschutz
Copy link
Contributor
@eschutz eschutz commented Apr 16, 2018

PR Summary

Fixed an issue where Ellipses would not move when ellipse.center was set.

Example:

import matplotlib.pyplot as plt
from matplotlib.patches import Ellipse

def onmove(event):
    ellipse.center = event.xdata, event.ydata
    # ellipse.stale = True # (old fix)
    # Ellipse position would not update after plt.draw()
    # Should move with mouse
    plt.draw()

ellipse = Ellipse((1,1), 1, 1)
plt.gca().add_patch(ellipse)
plt.gca().set_aspect('equal')
plt.gcf().canvas.mpl_connect('motion_notify_event', onmove)
plt.xlim(0, 4)
plt.ylim(0, 4)
plt.show()

Old
old
New
new

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

timhoffm
timhoffm reviewed Apr 16, 2018
View reviewed changes
lib/matplotlib/patches.py Outdated
@@ -1439,7 +1439,7 @@ def __init__(self, xy, width, height, angle=0.0, **kwargs):
"""
Patch.__init__(self, **kwargs)

self.center = xy
self.xy = xy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd use self._center instead of self.xy. We shouldn't add a public attribute. While xy is used as a variable name in __init__, I don't think it's a good choice. "center" is more semantic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to self._center, thanks!

@ImportanceOfBeingErnest
Copy link
Member

This for sure breaks a lot of existing code. Ellipse and Circle not having setters for the center position, using Circle.center is the widely adopted way to change their position. One should not silently remove this attribute.
I suspect, being an attribute, it's somehow hard to deprecate via warnings issued; but I don't think this qualifies as a reason to let it disappear completely unnoticed from one version to next.

I personally do not quite see the reason to hide the attribute, but if people think this should be done, it should be done for all attributes of all patches and the respective setters and getters should be introduced.

@eschutz
Copy link
Contributor Author
eschutz commented Apr 16, 2018

The Ellipse.center attribute is still there, it’s just accessed through the getter and setter: center = property(get_center, set_center). This is the same way Circle.radius is implemented.

@ImportanceOfBeingErnest
Copy link
Member

omg, I did not see that. Sorry. All good.

@timhoffm timhoffm merged commit 5daabdd into matplotlib:master Apr 16, 2018
@dstansby
Copy link
Member

Thanks for what looks like your first contribution @eschutz!

@eschutz
Copy link
Contributor Author
eschutz commented Apr 16, 2018

Thank you!

@eschutz eschutz deleted the ellipse-center branch April 16, 2018 22:26
@QuLogic QuLogic added this to the v3.0 milestone Apr 17, 2018
@QuLogic
Copy link
Member
QuLogic commented Apr 17, 2018

I think we should move away from this set/get style and use the @property decorator form instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
5 participants
@eschutz @ImportanceOfBeingErnest @dstansby @QuLogic @timhoffm
0