Skip to content

MEP22 first draft (DO NOT MERGE) #2740

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

Closed
wants to merge 9 commits into from
Closed

MEP22 first draft (DO NOT MERGE) #2740

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3dd0a3e
Navigation, Toolbar and Tool in place
fariza Jan 16, 2014
128f1a7
stuff moved to new locations
fariza Jan 16, 2014
482e247
Removing prints
fariza Jan 16, 2014
72ce737
improving the example
fariza Jan 17, 2014
aae701b
adding locks for events, instead of modifying attributes
fariza Jan 21, 2014
e226cc0
moving class attribute to ToolBase
fariza Jan 21, 2014
deb834c
Reducing the number of public methods
fariza Jan 22, 2014
8835b9b
adding copy tool to example
fariza Jan 22, 2014
560868a
bug fix
fariza Jan 22, 2014
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
Prev Previous commit
Next Next commit
adding locks for events, instead of modifying attributes
  • Loading branch information
@fariza
fariza committed Jan 21, 2014
commit aae701bbad2f2a57807374f076a6d8e751d05417
76 changes: 46 additions & 30 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2609,11 +2609,6 @@ class SaveFigureBase(ToolBase):
class ToolToggleBase(ToolPersistentBase):
toggle = True
cursor = None
capture_keypress = False
capture_move = False
capture_press = False
capture_release = False
lock_drawing = False

def mouse_move(self, event):
pass
Expand All @@ -2637,23 +2632,30 @@ class ToolZoom(ToolToggleBase):
image = 'zoom_to_rect'
position = -1
keymap = rcParams['keymap.zoom']

cursor = cursors.SELECT_REGION
capture_press = True
capture_release = True

def __init__(self, *args):
ToolToggleBase.__init__(self, *args)
self._ids_zoom = []
self._button_pressed = None
self._xypress = None

def activate(self, event):
self.navigation.canvaslock(self)
self.navigation.presslock(self)
self.navigation.releaselock(self)

def deactivate(self, event):
self.navigation.canvaslock.release(self)
self.navigation.presslock.release(self)
self.navigation.releaselock.release(self)

def press(self, event):
"""the press mouse button in zoom to rect mode callback"""
# If we're already in the middle of a zoom, pressing another
# button works to "cancel"
if self._ids_zoom != []:
self.capture_move = False
self.navigation.movelock.release(self)
for zoom_id in self._ids_zoom:
self.figure.canvas.mpl_disconnect(zoom_id)
self.navigation.release(event)
Expand Down Expand Up @@ -2685,7 +2687,7 @@ def press(self, event):
self._xypress.append((x, y, a, i, a.viewLim.frozen(),
a.transData.frozen()))

self.capture_move = True
self.navigation.movelock(self)
id2 = self.figure.canvas.mpl_connect('key_press_event',
self._switch_on_zoom_mode)
id3 = self.figure.canvas.mpl_connect('key_release_event',
Expand Down Expand Up @@ -2726,7 +2728,7 @@ def mouse_move(self, event):

def release(self, event):
"""the release mouse button callback in zoom to rect mode"""
self.capture_move = False
self.navigation.movelock.release(self)
for zoom_id in self._ids_zoom:
self.figure.canvas.mpl_disconnect(zoom_id)
self._ids_zoom = []
Expand Down Expand Up @@ -2859,17 +2861,23 @@ class ToolPan(ToolToggleBase):
description = 'Pan axes with left mouse, zoom with right'
image = 'move'
position = -1

cursor = cursors.MOVE
capture_press = True
capture_release = True
lock_drawing = True

def __init__(self, *args):
ToolToggleBase.__init__(self, *args)
self._button_pressed = None
self._xypress = None

def activate(self, event):
self.navigation.canvaslock(self)
self.navigation.presslock(self)
self.navigation.releaselock(self)

def deactivate(self, event):
self.navigation.canvaslock.release(self)
self.navigation.presslock.release(self)
self.navigation.releaselock.release(self)

def press(self, event):
"""the press mouse button in pan/zoom mode callback"""

Expand All @@ -2894,14 +2902,14 @@ def press(self, event):
a.get_navigate() and a.can_pan()):
a.start_pan(x, y, event.button)
self._xypress.append((a, i))
self.capture_move = True
self.navigation.movelock(self)
self.navigation.press(event)

def release(self, event):
if self._button_pressed is None:
return

self.capture_move = False
self.navigation.movelock.release(self)

for a, _ind in self._xypress:
a.end_pan()
Expand Down Expand Up @@ -2957,6 +2965,14 @@ def __init__(self, canvas, toolbar=None):
self._instances = {}
self._toggled = None

#to communicate with tools and redirect events
self.keypresslock = widgets.LockDraw()
self.movelock = widgets.LockDraw()
self.presslock = widgets.LockDraw()
self.releaselock = widgets.LockDraw()
#just to group all the locks in one place
self.canvaslock = self.canvas.widgetlock

for tool in self.tools:
self.add_tool(tool)

Expand Down Expand Up @@ -2991,13 +3007,12 @@ def remove_tool(self, name):
def add_tool(self, callback_class):
tool = self._get_cls_to_instantiate(callback_class)
name = tool.name

if name is None:
#TODO: add a warning
print ('impossible to add without name')
warnings.warn('Tools need a name to be added, it is used as ID')
return
if name in self._tools:
#TODO: add a warning
print ('impossible to add two times with the same name')
warnings.warn('A tool with the same name already exist, not added')
return

self._tools[name] = tool
Expand Down Expand Up @@ -3040,8 +3055,10 @@ def key_press(self, event):
return

#some tools may need to capture keypress, but they need to be toggle
if self._toggled and self._tools[self._toggled].capture_keypress:
self._instances[self._toggled].key_press(event)
if self._toggled:
instance = self._get_instance(self._toggled)
if self.keypresslock.isowner(instance):
instance.key_press(event)
return

name = self._keys.get(event.key, None)
Expand All @@ -3062,6 +3079,7 @@ def key_press(self, event):
def _get_instance(self, name):
if name not in self._instances:
instance = self._tools[name](self.canvas.figure)
#register instance
self._instances[name] = instance

return self._instances[name]
Expand All @@ -3077,20 +3095,18 @@ def toolbar_callback(self, name):
tool(self.canvas.figure, None)

def _handle_toggle(self, name, event=None, from_toolbar=False):
#when from keypress toggle toolbar without callback
#toggle toolbar without callback
if not from_toolbar and self.toolbar:
self.toolbar.toggle(name, False)

instance = self._get_instance(name)
if self._toggled is None:
instance.activate(None)
self._toggled = name
self.canvas.widgetlock(self)

elif self._toggled == name:
instance.deactivate(None)
self._toggled = None
self.canvas.widgetlock.release(self)

else:
if self.toolbar:
Expand Down Expand Up @@ -3124,7 +3140,7 @@ def update(self):
def mouse_move(self, event):
if self._toggled:
instance = self._instances[self._toggled]
if instance.capture_move:
if self.movelock.isowner(instance):
instance.mouse_move(event)
return

Expand Down Expand Up @@ -3159,7 +3175,7 @@ def mouse_move(self, event):
def _release(self, event):
if self._toggled:
instance = self._instances[self._toggled]
if instance.capture_release:
if self.releaselock.isowner(instance):
instance.release(event)
return
self.release(event)
Expand All @@ -3171,7 +3187,7 @@ def _press(self, event):
"""Called whenver a mouse button is pressed."""
if self._toggled:
instance = self._instances[self._toggled]
if instance.capture_press:
if self.presslock.isowner(instance):
instance.press(event)
return
self.press(event)
Expand Down Expand Up @@ -3333,7 +3349,7 @@ def set_message(self, s):
pass

def toggle(self, name, callback=False):
#carefull, callback means to perform or not the callback while toggling
#callback = perform or not the callback while toggling
raise NotImplementedError

def remove_toolitem(self, name):
Expand Down