Simplify state selectors and validate rotation_point attribute Rectangle patch

Author: ericpre

doc/users/next_whats_new/selector_improvement.rst

@@ -1,16 +1,40 @@
-Rotating selectors and aspect ratio correction
-----------------------------------------------
+Selectors improvement: rotation, aspect ratio correction and add/remove state
+-----------------------------------------------------------------------------
 
 The `~matplotlib.widgets.RectangleSelector` and
 `~matplotlib.widgets.EllipseSelector` can now be rotated interactively.
-
-The rotation is enabled when *rotate* is added to
-:py:attr:`~matplotlib.widgets._SelectorWidget.state`, which can be done using
-:py:meth:`~matplotlib.widgets._SelectorWidget.add_state` or by striking
-the *state_modifier_keys* for *rotate* (default *r*).
+The rotation is enabled or disable by striking the *r* key
+(default value of 'rotate' in *state_modifier_keys*) or by calling
+*selector.add_state('rotate')*.
 
 The aspect ratio of the axes can now be taken into account when using the
-"square" state. When *data_coordinates* is added to
-:py:attr:`~matplotlib.widgets._SelectorWidget.state`, which can be done using
-:py:meth:`~matplotlib.widgets._SelectorWidget.add_state` or by striking
-the *state_modifier_keys* for *data_coordinates* (default *d*).
+"square" state. This can be enable or disable by striking the *d* key
+(default value of 'data_coordinates' in *state_modifier_keys*)
+or by calling *selector.add_state('rotate')*.
+
+In addition to changing selector state interactively using the modifier keys
+defined in *state_modifier_keys*, the selector state can now be changed
+programmatically using the *add_state* and *remove_state* method.
+
+
+.. code-block:: python
+
+    import matplotlib.pyplot as plt
+    from matplotlib.widgets import RectangleSelector
+    import numpy as np
+
+    values = np.arange(0, 100)
+
+    fig = plt.figure()
+    ax = fig.add_subplot()
+    ax.plot(values, values)
+
+    selector = RectangleSelector(ax, print, interactive=True, drag_from_anywhere=True)
+    selector.add_state('rotate') # alternatively press 'r' key
+    # rotate the selector interactively
+
+    selector.remove_state('rotate') # alternatively press 'r' key
+
+    selector.add_state('square')
+    # to keep the aspect ratio in data coordinates
+    selector.add_state('data_coordinates')

lib/matplotlib/patches.py

@@ -768,8 +768,7 @@ def get_patch_transform(self):
             rotation_point = bbox.x0 + width / 2., bbox.y0 + height / 2.
         elif self.rotation_point == 'xy':
             rotation_point = bbox.x0, bbox.y0
-        elif (isinstance(self.rotation_point[0], Number) and
-                  isinstance(self.rotation_point[1], Number)):
+        else:
             rotation_point = self.rotation_point
         return transforms.BboxTransformTo(bbox) \
                 + transforms.Affine2D() \
@@ -779,6 +778,21 @@ def get_patch_transform(self):
                 .scale(1, 1 / self._aspect_ratio_correction) \
                 .translate(*rotation_point)
 
+    @property
+    def rotation_point(self):
+        return self._rotation_point
+
+    @rotation_point.setter
+    def rotation_point(self, value):
+        if value in ['center', 'xy'] or (
+                isinstance(value, tuple) and len(value) == 2 and
+                isinstance(value[0], Number) and isinstance(value[1], Number)
+                ):
+            self._rotation_point = value
+        else:
+            raise ValueError("`rotation_point` must be one of "
+                             "{'xy', 'center', (number, number)}.")
+
     def get_x(self):
         """Return the left coordinate of the rectangle."""
         return self._x0

lib/matplotlib/tests/test_widgets.py

@@ -172,7 +172,7 @@ def onselect(epress, erelease):
     assert tool.extents == (xdata_new, extents[1], ydata_new, extents[3])
 
 
-def test_rectangle_add_default_state():
+def test_rectangle_add_state():
     ax = get_ax()
 
     def onselect(epress, erelease):
@@ -183,18 +183,18 @@ def onselect(epress, erelease):
     _resize_rectangle(tool, 70, 65, 125, 130)
 
     with pytest.raises(ValueError):
-        tool.add_default_state('unsupported_state')
+        tool.add_state('unsupported_state')
 
     with pytest.raises(ValueError):
-        tool.add_default_state('clear')
-    tool.add_default_state('move')
-    tool.add_default_state('square')
-    tool.add_default_state('center')
-    tool.add_default_state('data_coordinates')
+        tool.add_state('clear')
+    tool.add_state('move')
+    tool.add_state('square')
+    tool.add_state('center')
+    tool.add_state('data_coordinates')
 
 
-@pytest.mark.parametrize('use_default_state', [True, False])
-def test_rectangle_resize_center(use_default_state):
+@pytest.mark.parametrize('add_state', [True, False])
+def test_rectangle_resize_center(add_state):
     ax = get_ax()
 
     def onselect(epress, erelease):
@@ -205,8 +205,8 @@ def onselect(epress, erelease):
     _resize_rectangle(tool, 70, 65, 125, 130)
     assert tool.extents == (70.0, 125.0, 65.0, 130.0)
 
-    if use_default_state:
-        tool.add_default_state('center')
+    if add_state:
+        tool.add_state('center')
         use_key = None
     else:
         use_key = 'control'
@@ -266,8 +266,8 @@ def onselect(epress, erelease):
                             ydata_new, extents[3] - ydiff)
 
 
-@pytest.mark.parametrize('use_default_state', [True, False])
-def test_rectangle_resize_square(use_default_state):
+@pytest.mark.parametrize('add_state', [True, False])
+def test_rectangle_resize_square(add_state):
     ax = get_ax()
 
     def onselect(epress, erelease):
@@ -278,8 +278,8 @@ def onselect(epress, erelease):
     _resize_rectangle(tool, 70, 65, 120, 115)
     assert tool.extents == (70.0, 120.0, 65.0, 115.0)
 
-    if use_default_state:
-        tool.add_default_state('square')
+    if add_state:
+        tool.add_state('square')
         use_key = None
     else:
         use_key = 'shift'
@@ -348,8 +348,8 @@ def onselect(epress, erelease):
     tool = widgets.RectangleSelector(ax, onselect, interactive=True)
     # Create rectangle
     _resize_rectangle(tool, 70, 65, 120, 115)
-    tool.add_default_state('square')
-    tool.add_default_state('center')
+    tool.add_state('square')
+    tool.add_state('center')
     assert_allclose(tool.extents, (70.0, 120.0, 65.0, 115.0))
 
     # resize NE handle
@@ -421,18 +421,16 @@ def onselect(epress, erelease):
     do_event(tool, 'onmove', xdata=130, ydata=140)
     do_event(tool, 'release', xdata=130, ydata=140)
     assert tool.extents == (100, 130, 100, 140)
-    assert len(tool._default_state) == 0
     assert len(tool._state) == 0
 
     # Rotate anticlockwise using top-right corner
     do_event(tool, 'on_key_press', key='r')
-    assert tool._default_state == set(['rotate'])
-    assert len(tool._state) == 0
+    assert tool._state == set(['rotate'])
+    assert len(tool._state) == 1
     do_event(tool, 'press', xdata=130, ydata=140)
     do_event(tool, 'onmove', xdata=120, ydata=145)
     do_event(tool, 'release', xdata=120, ydata=145)
     do_event(tool, 'on_key_press', key='r')
-    assert len(tool._default_state) == 0
     assert len(tool._state) == 0
     # Extents shouldn't change (as shape of rectangle hasn't changed)
     assert tool.extents == (100, 130, 100, 140)
@@ -450,6 +448,30 @@ def onselect(epress, erelease):
     do_event(tool, 'release', xdata=110, ydata=160)
     assert_allclose(tool.extents, (100, 139.75, 100, 151.82), atol=0.01)
 
+    if selector_class == widgets.RectangleSelector:
+        with pytest.raises(ValueError):
+            tool._selection_artist.rotation_point = 'unvalid_value'
+
+
+def test_rectange_add_remove_set():
+    ax = get_ax()
+
+    def onselect(epress, erelease):
+        pass
+
+    tool = widgets.RectangleSelector(ax, onselect=onselect, interactive=True)
+    # Draw rectangle
+    do_event(tool, 'press', xdata=100, ydata=100)
+    do_event(tool, 'onmove', xdata=130, ydata=140)
+    do_event(tool, 'release', xdata=130, ydata=140)
+    assert tool.extents == (100, 130, 100, 140)
+    assert len(tool._state) == 0
+    for state in ['rotate', 'data_coordinates', 'square', 'center']:
+        tool.add_state(state)
+        assert len(tool._state) == 1
+        tool.remove_state(state)
+        assert len(tool._state) == 0
+
 
 def test_rectangle_resize_square_center_aspect():
     ax = get_ax()
@@ -461,8 +483,8 @@ def onselect(epress, erelease):
     tool = widgets.RectangleSelector(ax, onselect, interactive=True)
     # Create rectangle
     _resize_rectangle(tool, 70, 65, 120, 115)
-    tool.add_default_state('square')
-    tool.add_default_state('center')
+    tool.add_state('square')
+    tool.add_state('center')
     assert tool.extents == (70.0, 120.0, 65.0, 115.0)
 
     # resize E handle
@@ -905,7 +927,7 @@ def onselect(*args):
         assert tool.extents == (10, 50)
 
 
-def test_span_selector_add_default_state():
+def test_span_selector_add_state():
     ax = get_ax()
 
     def onselect(*args):
@@ -914,13 +936,13 @@ def onselect(*args):
     tool = widgets.SpanSelector(ax, onselect, 'horizontal', interactive=True)
 
     with pytest.raises(ValueError):
-        tool.add_default_state('unsupported_state')
+        tool.add_state('unsupported_state')
     with pytest.raises(ValueError):
-        tool.add_default_state('center')
+        tool.add_state('center')
     with pytest.raises(ValueError):
-        tool.add_default_state('square')
+        tool.add_state('square')
 
-    tool.add_default_state('move')
+    tool.add_state('move')
 
 
 def test_tool_line_handle():