|
|
@@ -1827,24 +1827,41 @@ def subplots_adjust(self, *args, **kwargs): |
|
|
def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
|
|
|
mouse_pop=3, mouse_stop=2):
|
|
|
"""
|
|
|
- Blocking call to interact with the figure.
|
|
|
-
|
|
|
- This will wait for *n* clicks from the user and return a list of the
|
|
|
- coordinates of each click.
|
|
|
-
|
|
|
- If *timeout* is zero or negative, does not timeout.
|
|
|
+ Blocking call to interact with a figure.
|
|
|
|
|
|
- If *n* is zero or negative, accumulate clicks until a middle click
|
|
|
- (or potentially both mouse buttons at once) terminates the input.
|
|
|
-
|
|
|
- Right clicking cancels last input.
|
|
|
+ Wait until the user clicks *n* times on the figure, and return the
|
|
|
+ coordinates of each click in a list.
|
|
|
|
|
|
The buttons used for the various actions (adding points, removing
|
|
|
points, terminating the inputs) can be overriden via the
|
|
|
arguments *mouse_add*, *mouse_pop* and *mouse_stop*, that give
|
|
|
the associated mouse button: 1 for left, 2 for middle, 3 for
|
|
|
right.
|
|
|
|
|
|
+ Parameters
|
|
|
+ ----------
|
|
|
+ n : int, optional, default: 1
|
|
|
+ Number of mouse clicks to accumulate. If negative, accumulate
|
|
|
+ clicks until the input is terminated manually.
|
|
|
+ timeout : scalar, optional, default: 30
|
|
|
+ Number of seconds to wait before timing out. If zero or negative
|
|
|
+ will never timeout.
|
|
|
+ show_clicks : bool, optional, default: False
|
|
|
+ If True, show a red cross at the location of each click.
|
|
|
+ mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click)
|
|
|
+ Mouse button used to add points.
|
|
|
+ mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click)
|
|
|
+ Mouse button used to remove the most recently added point.
|
|
|
+ mouse_stop : int, one of (1, 2, 3), optional, default: 2 (middle click)
|
|
|
+ Mouse button used to stop input.
|
|
|
+
|
|
|
+ Returns
|
|
|
+ -------
|
|
|
+ points : list of tuples
|
|
|
+ A list of the clicked (x, y) coordinates.
|
|
|
+
|
|
|
+ Notes
|
|
|
+ -----
|
|
|
The keyboard can also be used to select points in case your mouse
|
|
|
does not have one or more of the buttons. The delete and backspace
|
|
|
keys act like right clicking (i.e., remove last point), the enter key
|
|
|
|