Skip to content

Use left/right top/bottom instead of width/height in Rectangle #9072

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

Merged
merged 5 commits into from
Dec 4, 2017
Merged

Use left/right top/bottom instead of width/height in Rectangle #9072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e8ce736
Use rectangle coords instead of width/height
dstansby Aug 22, 2017
8208ddc
Add timedelta rectangle test
dstansby Aug 22, 2017
03fba6b
Add a test to ensure that datetimes cannot be used as deltas.
pganssle Aug 22, 2017
f40607e
Convert units when returning Rect bbox
dstansby Aug 25, 2017
8ee4da2
Clean docstring of Rectangle methods
dstansby Aug 25, 2017
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
110 changes: 65 additions & 45 deletions lib/matplotlib/patches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,29 +643,43 @@ class Rectangle(Patch):
"""

def __str__(self):
pars = self._x, self._y, self._width, self._height, self.angle
pars = self._x0, self._y0, self._width, self._height, self.angle
fmt = "Rectangle(xy=(%g, %g), width=%g, height=%g, angle=%g)"
return fmt % pars

@docstring.dedent_interpd
def __init__(self, xy, width, height, angle=0.0, **kwargs):
"""
Parameters
----------
xy: length-2 tuple
The bottom and left rectangle coordinates
width:
Rectangle width
height:
Rectangle height
angle: float, optional
rotation in degrees anti-clockwise about *xy* (default is 0.0)
fill: bool, optional
Whether to fill the rectangle (default is ``True``)

*angle*
rotation in degrees (anti-clockwise)

*fill* is a boolean indicating whether to fill the rectangle

Notes
-----
Valid kwargs are:
%(Patch)s
"""

Patch.__init__(self, **kwargs)

self._x = xy[0]
self._y = xy[1]
self._x0 = xy[0]
self._y0 = xy[1]

self._width = width
self._height = height

self._x1 = self._x0 + self._width
self._y1 = self._y0 + self._height

self.angle = float(angle)
# Note: This cannot be calculated until this is added to an Axes
self._rect_transform = transforms.IdentityTransform()
Expand All @@ -682,56 +696,63 @@ def _update_patch_transform(self):
makes it very important to call the accessor method and
not directly access the transformation member variable.
"""
x = self.convert_xunits(self._x)
y = self.convert_yunits(self._y)
width = self.convert_xunits(self._width)
height = self.convert_yunits(self._height)
bbox = transforms.Bbox.from_bounds(x, y, width, height)
x0, y0, x1, y1 = self._convert_units()
bbox = transforms.Bbox.from_extents(x0, y0, x1, y1)
rot_trans = transforms.Affine2D()
rot_trans.rotate_deg_around(x, y, self.angle)
rot_trans.rotate_deg_around(x0, y0, self.angle)
self._rect_transform = transforms.BboxTransformTo(bbox)
self._rect_transform += rot_trans

def _update_x1(self):
self._x1 = self._x0 + self._width

def _update_y1(self):
self._y1 = self._y0 + self._height

def _convert_units(self):
'''
Convert bounds of the rectangle
'''
x0 = self.convert_xunits(self._x0)
y0 = self.convert_yunits(self._y0)
x1 = self.convert_xunits(self._x1)
y1 = self.convert_yunits(self._y1)
return x0, y0, x1, y1

def get_patch_transform(self):
self._update_patch_transform()
return self._rect_transform

def get_x(self):
"Return the left coord of the rectangle"
return self._x
return self._x0

def get_y(self):
"Return the bottom coord of the rectangle"
return self._y
return self._y0

def get_xy(self):
"Return the left and bottom coords of the rectangle"
return self._x, self._y
return self._x0, self._y0

def get_width(self):
"Return the width of the rectangle"
"Return the width of the rectangle"
return self._width

def get_height(self):
"Return the height of the rectangle"
return self._height

def set_x(self, x):
"""
Set the left coord of the rectangle

ACCEPTS: float
"""
self._x = x
"Set the left coord of the rectangle"
self._x0 = x
self._update_x1()
self.stale = True

def set_y(self, y):
"""
Set the bottom coord of the rectangle

ACCEPTS: float
"""
self._y = y
"Set the bottom coord of the rectangle"
self._y0 = y
self._update_y1()
self.stale = True

def set_xy(self, xy):
Expand All @@ -740,25 +761,21 @@ def set_xy(self, xy):

ACCEPTS: 2-item sequence
"""
self._x, self._y = xy
self._x0, self._y0 = xy
self._update_x1()
self._update_y1()
self.stale = True

def set_width(self, w):
"""
Set the width rectangle

ACCEPTS: float
"""
"Set the width of the rectangle"
self._width = w
self._update_x1()
self.stale = True

def set_height(self, h):
"""
Set the width rectangle

ACCEPTS: float
"""
"Set the height of the rectangle"
self._height = h
self._update_y1()
self.stale = True

def set_bounds(self, *args):
Expand All @@ -771,15 +788,18 @@ def set_bounds(self, *args):
l, b, w, h = args[0]
else:
l, b, w, h = args
self._x = l
self._y = b
self._x0 = l
self._y0 = b
self._width = w
self._height = h
self._update_x1()
self._update_y1()
self.stale = True

def get_bbox(self):
return transforms.Bbox.from_bounds(self._x, self._y,
self._width, self._height)
x0, y0, x1, y1 = self._convert_units()
Copy link
Member

Choose a reason for hiding this comment

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

Why this call to convert_units? Am I missing a side effect or was this meant to be passed to the from_extents call?

Copy link
Member Author

Choose a reason for hiding this comment

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

The _x0, _y0 etc. coords are now all stored in the class with units attached, so this strips the units because I don't think from_extents takes units.

Copy link
Member

Choose a reason for hiding this comment

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

but the next line passes in self._x0 etc not x0.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, I see. PR incoming

return transforms.Bbox.from_extents(self._x0, self._y0,
self._x1, self._y1)

xy = property(get_xy, set_xy)

Expand Down
25 changes: 25 additions & 0 deletions lib/matplotlib/tests/test_patches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,3 +362,28 @@ def test_connection_patch():
axesA=ax2, axesB=ax1,
arrowstyle="->")
ax2.add_artist(con)


def test_datetime_rectangle():
# Check that creating a rectangle with timedeltas doesn't fail
from datetime import datetime, timedelta

start = datetime(2017, 1, 1, 0, 0, 0)
delta = timedelta(seconds=16)
patch = mpatches.Rectangle((start, 0), delta, 1)

fig, ax = plt.subplots()
ax.add_patch(patch)


def test_datetime_datetime_fails():
from datetime import datetime

start = datetime(2017, 1, 1, 0, 0, 0)
dt_delta = datetime(1970, 1, 5) # Will be 5 days if units are done wrong

with pytest.raises(TypeError):
mpatches.Rectangle((start, 0), dt_delta, 1)

with pytest.raises(TypeError):
mpatches.Rectangle((0, start), 1, dt_delta)