EVOLUTION-MANAGER

Edit File: backend_wx.py

""" A wxPython backend for matplotlib. Originally contributed by Jeremy O'Donoghue (jeremy@o-donoghue.com) and John Hunter (jdhunter@ace.bsd.uchicago.edu). Copyright (C) Jeremy O'Donoghue & John Hunter, 2003-4. """ import logging import math import pathlib import sys import weakref import numpy as np import PIL import matplotlib as mpl from matplotlib.backend_bases import ( _Backend, _check_savefig_extra_args, FigureCanvasBase, FigureManagerBase, GraphicsContextBase, MouseButton, NavigationToolbar2, RendererBase, StatusbarBase, TimerBase, ToolContainerBase, cursors) from matplotlib import cbook, backend_tools from matplotlib._pylab_helpers import Gcf from matplotlib.backend_managers import ToolManager from matplotlib.figure import Figure from matplotlib.path import Path from matplotlib.transforms import Affine2D from matplotlib.widgets import SubplotTool import wx _log = logging.getLogger(__name__) # Debugging settings here... # Debug level set here. If the debug level is less than 5, information # messages (progressively more info for lower value) are printed. In addition, # traceback is performed, and pdb activated, for all uncaught exceptions in # this case _DEBUG = 5 _DEBUG_lvls = {1: 'Low ', 2: 'Med ', 3: 'High', 4: 'Error'} @cbook.deprecated("3.3") def DEBUG_MSG(string, lvl=3, o=None): if lvl >= _DEBUG: print(f"{_DEBUG_lvls[lvl]}- {string} in {type(o)}") # the True dots per inch on the screen; should be display dependent; see # http://groups.google.com/groups?q=screen+dpi+x11&hl=en&lr=&ie=UTF-8&oe=UTF-8&safe=off&selm=7077.26e81ad5%40swift.cs.tcd.ie&rnum=5 # for some info about screen dpi PIXELS_PER_INCH = 75 # Delay time for idle checks IDLE_DELAY = 5 # Documented as deprecated as of Matplotlib 3.1. def error_msg_wx(msg, parent=None): """Signal an error condition with a popup error dialog.""" dialog = wx.MessageDialog(parent=parent, message=msg, caption='Matplotlib backend_wx error', style=wx.OK | wx.CENTRE) dialog.ShowModal() dialog.Destroy() return None class TimerWx(TimerBase): """Subclass of `.TimerBase` using wx.Timer events.""" def __init__(self, *args, **kwargs): self._timer = wx.Timer() self._timer.Notify = self._on_timer TimerBase.__init__(self, *args, **kwargs) def _timer_start(self): self._timer.Start(self._interval, self._single) def _timer_stop(self): self._timer.Stop() def _timer_set_interval(self): if self._timer.IsRunning(): self._timer_start() # Restart with new interval. def _timer_set_single_shot(self): self._timer.Start() class RendererWx(RendererBase): """ The renderer handles all the drawing primitives using a graphics context instance that controls the colors/styles. It acts as the 'renderer' instance used by many classes in the hierarchy. """ # In wxPython, drawing is performed on a wxDC instance, which will # generally be mapped to the client area of the window displaying # the plot. Under wxPython, the wxDC instance has a wx.Pen which # describes the colour and weight of any lines drawn, and a wxBrush # which describes the fill colour of any closed polygon. # Font styles, families and weight. fontweights = { 100: wx.FONTWEIGHT_LIGHT, 200: wx.FONTWEIGHT_LIGHT, 300: wx.FONTWEIGHT_LIGHT, 400: wx.FONTWEIGHT_NORMAL, 500: wx.FONTWEIGHT_NORMAL, 600: wx.FONTWEIGHT_NORMAL, 700: wx.FONTWEIGHT_BOLD, 800: wx.FONTWEIGHT_BOLD, 900: wx.FONTWEIGHT_BOLD, 'ultralight': wx.FONTWEIGHT_LIGHT, 'light': wx.FONTWEIGHT_LIGHT, 'normal': wx.FONTWEIGHT_NORMAL, 'medium': wx.FONTWEIGHT_NORMAL, 'semibold': wx.FONTWEIGHT_NORMAL, 'bold': wx.FONTWEIGHT_BOLD, 'heavy': wx.FONTWEIGHT_BOLD, 'ultrabold': wx.FONTWEIGHT_BOLD, 'black': wx.FONTWEIGHT_BOLD, } fontangles = { 'italic': wx.FONTSTYLE_ITALIC, 'normal': wx.FONTSTYLE_NORMAL, 'oblique': wx.FONTSTYLE_SLANT, } # wxPython allows for portable font styles, choosing them appropriately for # the target platform. Map some standard font names to the portable styles. # QUESTION: Is it be wise to agree standard fontnames across all backends? fontnames = { 'Sans': wx.FONTFAMILY_SWISS, 'Roman': wx.FONTFAMILY_ROMAN, 'Script': wx.FONTFAMILY_SCRIPT, 'Decorative': wx.FONTFAMILY_DECORATIVE, 'Modern': wx.FONTFAMILY_MODERN, 'Courier': wx.FONTFAMILY_MODERN, 'courier': wx.FONTFAMILY_MODERN, } def __init__(self, bitmap, dpi): """Initialise a wxWindows renderer instance.""" cbook.warn_deprecated( "2.0", name="wx", obj_type="backend", removal="the future", alternative="wxagg", addendum="See the Matplotlib usage FAQ for " "more info on backends.") RendererBase.__init__(self) _log.debug("%s - __init__()", type(self)) self.width = bitmap.GetWidth() self.height = bitmap.GetHeight() self.bitmap = bitmap self.fontd = {} self.dpi = dpi self.gc = None def flipy(self): # docstring inherited return True def offset_text_height(self): return True def get_text_width_height_descent(self, s, prop, ismath): # docstring inherited if ismath: s = cbook.strip_math(s) if self.gc is None: gc = self.new_gc() else: gc = self.gc gfx_ctx = gc.gfx_ctx font = self.get_wx_font(s, prop) gfx_ctx.SetFont(font, wx.BLACK) w, h, descent, leading = gfx_ctx.GetFullTextExtent(s) return w, h, descent def get_canvas_width_height(self): # docstring inherited return self.width, self.height def handle_clip_rectangle(self, gc): new_bounds = gc.get_clip_rectangle() if new_bounds is not None: new_bounds = new_bounds.bounds gfx_ctx = gc.gfx_ctx if gfx_ctx._lastcliprect != new_bounds: gfx_ctx._lastcliprect = new_bounds if new_bounds is None: gfx_ctx.ResetClip() else: gfx_ctx.Clip(new_bounds[0], self.height - new_bounds[1] - new_bounds[3], new_bounds[2], new_bounds[3]) @staticmethod def convert_path(gfx_ctx, path, transform): wxpath = gfx_ctx.CreatePath() for points, code in path.iter_segments(transform): if code == Path.MOVETO: wxpath.MoveToPoint(*points) elif code == Path.LINETO: wxpath.AddLineToPoint(*points) elif code == Path.CURVE3: wxpath.AddQuadCurveToPoint(*points) elif code == Path.CURVE4: wxpath.AddCurveToPoint(*points) elif code == Path.CLOSEPOLY: wxpath.CloseSubpath() return wxpath def draw_path(self, gc, path, transform, rgbFace=None): # docstring inherited gc.select() self.handle_clip_rectangle(gc) gfx_ctx = gc.gfx_ctx transform = transform + \ Affine2D().scale(1.0, -1.0).translate(0.0, self.height) wxpath = self.convert_path(gfx_ctx, path, transform) if rgbFace is not None: gfx_ctx.SetBrush(wx.Brush(gc.get_wxcolour(rgbFace))) gfx_ctx.DrawPath(wxpath) else: gfx_ctx.StrokePath(wxpath) gc.unselect() def draw_image(self, gc, x, y, im): bbox = gc.get_clip_rectangle() if bbox is not None: l, b, w, h = bbox.bounds else: l = 0 b = 0 w = self.width h = self.height rows, cols = im.shape[:2] bitmap = wx.Bitmap.FromBufferRGBA(cols, rows, im.tobytes()) gc.select() gc.gfx_ctx.DrawBitmap(bitmap, int(l), int(self.height - b), int(w), int(-h)) gc.unselect() def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None): # docstring inherited if ismath: s = cbook.strip_math(s) _log.debug("%s - draw_text()", type(self)) gc.select() self.handle_clip_rectangle(gc) gfx_ctx = gc.gfx_ctx font = self.get_wx_font(s, prop) color = gc.get_wxcolour(gc.get_rgb()) gfx_ctx.SetFont(font, color) w, h, d = self.get_text_width_height_descent(s, prop, ismath) x = int(x) y = int(y - h) if angle == 0.0: gfx_ctx.DrawText(s, x, y) else: rads = math.radians(angle) xo = h * math.sin(rads) yo = h * math.cos(rads) gfx_ctx.DrawRotatedText(s, x - xo, y - yo, rads) gc.unselect() def new_gc(self): # docstring inherited _log.debug("%s - new_gc()", type(self)) self.gc = GraphicsContextWx(self.bitmap, self) self.gc.select() self.gc.unselect() return self.gc @cbook.deprecated("3.3", alternative=".gc") def get_gc(self): """ Fetch the locally cached gc. """ # This is a dirty hack to allow anything with access to a renderer to # access the current graphics context assert self.gc is not None, "gc must be defined" return self.gc def get_wx_font(self, s, prop): """Return a wx font. Cache font instances for efficiency.""" _log.debug("%s - get_wx_font()", type(self)) key = hash(prop) font = self.fontd.get(key) if font is not None: return font # Font colour is determined by the active wx.Pen # TODO: It may be wise to cache font information self.fontd[key] = font = wx.Font( # Cache the font and gc. pointSize=self.points_to_pixels(prop.get_size_in_points()), family=self.fontnames.get(prop.get_name(), wx.ROMAN), style=self.fontangles[prop.get_style()], weight=self.fontweights[prop.get_weight()]) return font def points_to_pixels(self, points): # docstring inherited return points * (PIXELS_PER_INCH / 72.0 * self.dpi / 72.0) class GraphicsContextWx(GraphicsContextBase): """ The graphics context provides the color, line styles, etc... This class stores a reference to a wxMemoryDC, and a wxGraphicsContext that draws to it. Creating a wxGraphicsContext seems to be fairly heavy, so these objects are cached based on the bitmap object that is passed in. The base GraphicsContext stores colors as a RGB tuple on the unit interval, e.g., (0.5, 0.0, 1.0). wxPython uses an int interval, but since wxPython colour management is rather simple, I have not chosen to implement a separate colour manager class. """ _capd = {'butt': wx.CAP_BUTT, 'projecting': wx.CAP_PROJECTING, 'round': wx.CAP_ROUND} _joind = {'bevel': wx.JOIN_BEVEL, 'miter': wx.JOIN_MITER, 'round': wx.JOIN_ROUND} _cache = weakref.WeakKeyDictionary() def __init__(self, bitmap, renderer): GraphicsContextBase.__init__(self) # assert self.Ok(), "wxMemoryDC not OK to use" _log.debug("%s - __init__(): %s", type(self), bitmap) dc, gfx_ctx = self._cache.get(bitmap, (None, None)) if dc is None: dc = wx.MemoryDC() dc.SelectObject(bitmap) gfx_ctx = wx.GraphicsContext.Create(dc) gfx_ctx._lastcliprect = None self._cache[bitmap] = dc, gfx_ctx self.bitmap = bitmap self.dc = dc self.gfx_ctx = gfx_ctx self._pen = wx.Pen('BLACK', 1, wx.SOLID) gfx_ctx.SetPen(self._pen) self.renderer = renderer def select(self): """Select the current bitmap into this wxDC instance.""" if sys.platform == 'win32': self.dc.SelectObject(self.bitmap) self.IsSelected = True def unselect(self): """Select a Null bitmap into this wxDC instance.""" if sys.platform == 'win32': self.dc.SelectObject(wx.NullBitmap) self.IsSelected = False def set_foreground(self, fg, isRGBA=None): # docstring inherited # Implementation note: wxPython has a separate concept of pen and # brush - the brush fills any outline trace left by the pen. # Here we set both to the same colour - if a figure is not to be # filled, the renderer will set the brush to be transparent # Same goes for text foreground... _log.debug("%s - set_foreground()", type(self)) self.select() GraphicsContextBase.set_foreground(self, fg, isRGBA) self._pen.SetColour(self.get_wxcolour(self.get_rgb())) self.gfx_ctx.SetPen(self._pen) self.unselect() def set_linewidth(self, w): # docstring inherited w = float(w) _log.debug("%s - set_linewidth()", type(self)) self.select() if 0 < w < 1: w = 1 GraphicsContextBase.set_linewidth(self, w) lw = int(self.renderer.points_to_pixels(self._linewidth)) if lw == 0: lw = 1 self._pen.SetWidth(lw) self.gfx_ctx.SetPen(self._pen) self.unselect() def set_capstyle(self, cs): # docstring inherited _log.debug("%s - set_capstyle()", type(self)) self.select() GraphicsContextBase.set_capstyle(self, cs) self._pen.SetCap(GraphicsContextWx._capd[self._capstyle]) self.gfx_ctx.SetPen(self._pen) self.unselect() def set_joinstyle(self, js): # docstring inherited _log.debug("%s - set_joinstyle()", type(self)) self.select() GraphicsContextBase.set_joinstyle(self, js) self._pen.SetJoin(GraphicsContextWx._joind[self._joinstyle]) self.gfx_ctx.SetPen(self._pen) self.unselect() def get_wxcolour(self, color): """Convert a RGB(A) color to a wx.Colour.""" _log.debug("%s - get_wx_color()", type(self)) if len(color) == 3: r, g, b = color r *= 255 g *= 255 b *= 255 return wx.Colour(red=int(r), green=int(g), blue=int(b)) else: r, g, b, a = color r *= 255 g *= 255 b *= 255 a *= 255 return wx.Colour( red=int(r), green=int(g), blue=int(b), alpha=int(a)) class _FigureCanvasWxBase(FigureCanvasBase, wx.Panel): """ The FigureCanvas contains the figure and does event handling. In the wxPython backend, it is derived from wxPanel, and (usually) lives inside a frame instantiated by a FigureManagerWx. The parent window probably implements a wx.Sizer to control the displayed control size - but we give a hint as to our preferred minimum size. """ required_interactive_framework = "wx" _timer_cls = TimerWx keyvald = { wx.WXK_CONTROL: 'control', wx.WXK_SHIFT: 'shift', wx.WXK_ALT: 'alt', wx.WXK_LEFT: 'left', wx.WXK_UP: 'up', wx.WXK_RIGHT: 'right', wx.WXK_DOWN: 'down', wx.WXK_ESCAPE: 'escape', wx.WXK_F1: 'f1', wx.WXK_F2: 'f2', wx.WXK_F3: 'f3', wx.WXK_F4: 'f4', wx.WXK_F5: 'f5', wx.WXK_F6: 'f6', wx.WXK_F7: 'f7', wx.WXK_F8: 'f8', wx.WXK_F9: 'f9', wx.WXK_F10: 'f10', wx.WXK_F11: 'f11', wx.WXK_F12: 'f12', wx.WXK_SCROLL: 'scroll_lock', wx.WXK_PAUSE: 'break', wx.WXK_BACK: 'backspace', wx.WXK_RETURN: 'enter', wx.WXK_INSERT: 'insert', wx.WXK_DELETE: 'delete', wx.WXK_HOME: 'home', wx.WXK_END: 'end', wx.WXK_PAGEUP: 'pageup', wx.WXK_PAGEDOWN: 'pagedown', wx.WXK_NUMPAD0: '0', wx.WXK_NUMPAD1: '1', wx.WXK_NUMPAD2: '2', wx.WXK_NUMPAD3: '3', wx.WXK_NUMPAD4: '4', wx.WXK_NUMPAD5: '5', wx.WXK_NUMPAD6: '6', wx.WXK_NUMPAD7: '7', wx.WXK_NUMPAD8: '8', wx.WXK_NUMPAD9: '9', wx.WXK_NUMPAD_ADD: '+', wx.WXK_NUMPAD_SUBTRACT: '-', wx.WXK_NUMPAD_MULTIPLY: '*', wx.WXK_NUMPAD_DIVIDE: '/', wx.WXK_NUMPAD_DECIMAL: 'dec', wx.WXK_NUMPAD_ENTER: 'enter', wx.WXK_NUMPAD_UP: 'up', wx.WXK_NUMPAD_RIGHT: 'right', wx.WXK_NUMPAD_DOWN: 'down', wx.WXK_NUMPAD_LEFT: 'left', wx.WXK_NUMPAD_PAGEUP: 'pageup', wx.WXK_NUMPAD_PAGEDOWN: 'pagedown', wx.WXK_NUMPAD_HOME: 'home', wx.WXK_NUMPAD_END: 'end', wx.WXK_NUMPAD_INSERT: 'insert', wx.WXK_NUMPAD_DELETE: 'delete', } def __init__(self, parent, id, figure): """ Initialize a FigureWx instance. - Initialize the FigureCanvasBase and wxPanel parents. - Set event handlers for resize, paint, and keyboard and mouse interaction. """ FigureCanvasBase.__init__(self, figure) w, h = map(math.ceil, figure.bbox.size) # Set preferred window size hint - helps the sizer, if one is connected wx.Panel.__init__(self, parent, id, size=wx.Size(w, h)) # Create the drawing bitmap self.bitmap = wx.Bitmap(w, h) _log.debug("%s - __init__() - bitmap w:%d h:%d", type(self), w, h) # TODO: Add support for 'point' inspection and plot navigation. self._isDrawn = False self.Bind(wx.EVT_SIZE, self._onSize) self.Bind(wx.EVT_PAINT, self._onPaint) self.Bind(wx.EVT_KEY_DOWN, self._onKeyDown) self.Bind(wx.EVT_KEY_UP, self._onKeyUp) self.Bind(wx.EVT_LEFT_DOWN, self._onMouseButton) self.Bind(wx.EVT_LEFT_DCLICK, self._onMouseButton) self.Bind(wx.EVT_LEFT_UP, self._onMouseButton) self.Bind(wx.EVT_MIDDLE_DOWN, self._onMouseButton) self.Bind(wx.EVT_MIDDLE_DCLICK, self._onMouseButton) self.Bind(wx.EVT_MIDDLE_UP, self._onMouseButton) self.Bind(wx.EVT_RIGHT_DOWN, self._onMouseButton) self.Bind(wx.EVT_RIGHT_DCLICK, self._onMouseButton) self.Bind(wx.EVT_RIGHT_UP, self._onMouseButton) self.Bind(wx.EVT_MOUSEWHEEL, self._onMouseWheel) self.Bind(wx.EVT_MOTION, self._onMotion) self.Bind(wx.EVT_LEAVE_WINDOW, self._onLeave) self.Bind(wx.EVT_ENTER_WINDOW, self._onEnter) self.Bind(wx.EVT_MOUSE_CAPTURE_CHANGED, self._onCaptureLost) self.Bind(wx.EVT_MOUSE_CAPTURE_LOST, self._onCaptureLost) self.SetBackgroundStyle(wx.BG_STYLE_PAINT) # Reduce flicker. self.SetBackgroundColour(wx.WHITE) def Copy_to_Clipboard(self, event=None): """Copy bitmap of canvas to system clipboard.""" bmp_obj = wx.BitmapDataObject() bmp_obj.SetBitmap(self.bitmap) if not wx.TheClipboard.IsOpened(): open_success = wx.TheClipboard.Open() if open_success: wx.TheClipboard.SetData(bmp_obj) wx.TheClipboard.Close() wx.TheClipboard.Flush() def draw_idle(self): # docstring inherited _log.debug("%s - draw_idle()", type(self)) self._isDrawn = False # Force redraw # Triggering a paint event is all that is needed to defer drawing # until later. The platform will send the event when it thinks it is # a good time (usually as soon as there are no other events pending). self.Refresh(eraseBackground=False) def flush_events(self): # docstring inherited wx.Yield() def start_event_loop(self, timeout=0): # docstring inherited if hasattr(self, '_event_loop'): raise RuntimeError("Event loop already running") timer = wx.Timer(self, id=wx.ID_ANY) if timeout > 0: timer.Start(timeout * 1000, oneShot=True) self.Bind(wx.EVT_TIMER, self.stop_event_loop, id=timer.GetId()) # Event loop handler for start/stop event loop self._event_loop = wx.GUIEventLoop() self._event_loop.Run() timer.Stop() def stop_event_loop(self, event=None): # docstring inherited if hasattr(self, '_event_loop'): if self._event_loop.IsRunning(): self._event_loop.Exit() del self._event_loop def _get_imagesave_wildcards(self): """Return the wildcard string for the filesave dialog.""" default_filetype = self.get_default_filetype() filetypes = self.get_supported_filetypes_grouped() sorted_filetypes = sorted(filetypes.items()) wildcards = [] extensions = [] filter_index = 0 for i, (name, exts) in enumerate(sorted_filetypes): ext_list = ';'.join(['*.%s' % ext for ext in exts]) extensions.append(exts[0]) wildcard = '%s (%s)|%s' % (name, ext_list, ext_list) if default_filetype in exts: filter_index = i wildcards.append(wildcard) wildcards = '|'.join(wildcards) return wildcards, extensions, filter_index def gui_repaint(self, drawDC=None, origin='WX'): """ Performs update of the displayed image on the GUI canvas, using the supplied wx.PaintDC device context. The 'WXAgg' backend sets origin accordingly. """ _log.debug("%s - gui_repaint()", type(self)) # The "if self" check avoids a "wrapped C/C++ object has been deleted" # RuntimeError if doing things after window is closed. if self and self.IsShownOnScreen(): if not drawDC: # not called from OnPaint use a ClientDC drawDC = wx.ClientDC(self) # following is for 'WX' backend on Windows # the bitmap can not be in use by another DC, # see GraphicsContextWx._cache if wx.Platform == '__WXMSW__' and origin == 'WX': img = self.bitmap.ConvertToImage() bmp = img.ConvertToBitmap() drawDC.DrawBitmap(bmp, 0, 0) else: drawDC.DrawBitmap(self.bitmap, 0, 0) filetypes = { **FigureCanvasBase.filetypes, 'bmp': 'Windows bitmap', 'jpeg': 'JPEG', 'jpg': 'JPEG', 'pcx': 'PCX', 'png': 'Portable Network Graphics', 'tif': 'Tagged Image Format File', 'tiff': 'Tagged Image Format File', 'xpm': 'X pixmap', } def print_figure(self, filename, *args, **kwargs): # docstring inherited super().print_figure(filename, *args, **kwargs) # Restore the current view; this is needed because the artist contains # methods rely on particular attributes of the rendered figure for # determining things like bounding boxes. if self._isDrawn: self.draw() def _onPaint(self, event): """Called when wxPaintEvt is generated.""" _log.debug("%s - _onPaint()", type(self)) drawDC = wx.PaintDC(self) if not self._isDrawn: self.draw(drawDC=drawDC) else: self.gui_repaint(drawDC=drawDC) drawDC.Destroy() def _onSize(self, event): """ Called when wxEventSize is generated. In this application we attempt to resize to fit the window, so it is better to take the performance hit and redraw the whole window. """ _log.debug("%s - _onSize()", type(self)) sz = self.GetParent().GetSizer() if sz: si = sz.GetItem(self) if sz and si and not si.Proportion and not si.Flag & wx.EXPAND: # managed by a sizer, but with a fixed size size = self.GetMinSize() else: # variable size size = self.GetClientSize() # Do not allow size to become smaller than MinSize size.IncTo(self.GetMinSize()) if getattr(self, "_width", None): if size == (self._width, self._height): # no change in size return self._width, self._height = size self._isDrawn = False if self._width <= 1 or self._height <= 1: return # Empty figure # Create a new, correctly sized bitmap self.bitmap = wx.Bitmap(self._width, self._height) dpival = self.figure.dpi winch = self._width / dpival hinch = self._height / dpival self.figure.set_size_inches(winch, hinch, forward=False) # Rendering will happen on the associated paint event # so no need to do anything here except to make sure # the whole background is repainted. self.Refresh(eraseBackground=False) FigureCanvasBase.resize_event(self) def _get_key(self, event): keyval = event.KeyCode if keyval in self.keyvald: key = self.keyvald[keyval] elif keyval < 256: key = chr(keyval) # wx always returns an uppercase, so make it lowercase if the shift # key is not depressed (NOTE: this will not handle Caps Lock) if not event.ShiftDown(): key = key.lower() else: key = None for meth, prefix in ( [event.AltDown, 'alt'], [event.ControlDown, 'ctrl'], ): if meth(): key = '{0}+{1}'.format(prefix, key) return key def _onKeyDown(self, event): """Capture key press.""" key = self._get_key(event) FigureCanvasBase.key_press_event(self, key, guiEvent=event) if self: event.Skip() def _onKeyUp(self, event): """Release key.""" key = self._get_key(event) FigureCanvasBase.key_release_event(self, key, guiEvent=event) if self: event.Skip() def _set_capture(self, capture=True): """Control wx mouse capture.""" if self.HasCapture(): self.ReleaseMouse() if capture: self.CaptureMouse() def _onCaptureLost(self, event): """Capture changed or lost""" self._set_capture(False) def _onMouseButton(self, event): """Start measuring on an axis.""" event.Skip() self._set_capture(event.ButtonDown() or event.ButtonDClick()) x = event.X y = self.figure.bbox.height - event.Y button_map = { wx.MOUSE_BTN_LEFT: MouseButton.LEFT, wx.MOUSE_BTN_MIDDLE: MouseButton.MIDDLE, wx.MOUSE_BTN_RIGHT: MouseButton.RIGHT, } button = event.GetButton() button = button_map.get(button, button) if event.ButtonDown(): self.button_press_event(x, y, button, guiEvent=event) elif event.ButtonDClick(): self.button_press_event(x, y, button, dblclick=True, guiEvent=event) elif event.ButtonUp(): self.button_release_event(x, y, button, guiEvent=event) def _onMouseWheel(self, event): """Translate mouse wheel events into matplotlib events""" # Determine mouse location x = event.GetX() y = self.figure.bbox.height - event.GetY() # Convert delta/rotation/rate into a floating point step size step = event.LinesPerAction * event.WheelRotation / event.WheelDelta # Done handling event event.Skip() # Mac gives two events for every wheel event; skip every second one. if wx.Platform == '__WXMAC__': if not hasattr(self, '_skipwheelevent'): self._skipwheelevent = True elif self._skipwheelevent: self._skipwheelevent = False return # Return without processing event else: self._skipwheelevent = True FigureCanvasBase.scroll_event(self, x, y, step, guiEvent=event) def _onMotion(self, event): """Start measuring on an axis.""" x = event.GetX() y = self.figure.bbox.height - event.GetY() event.Skip() FigureCanvasBase.motion_notify_event(self, x, y, guiEvent=event) def _onLeave(self, event): """Mouse has left the window.""" event.Skip() FigureCanvasBase.leave_notify_event(self, guiEvent=event) def _onEnter(self, event): """Mouse has entered the window.""" x = event.GetX() y = self.figure.bbox.height - event.GetY() event.Skip() FigureCanvasBase.enter_notify_event(self, guiEvent=event, xy=(x, y)) class FigureCanvasWx(_FigureCanvasWxBase): # Rendering to a Wx canvas using the deprecated Wx renderer. def draw(self, drawDC=None): """ Render the figure using RendererWx instance renderer, or using a previously defined renderer if none is specified. """ _log.debug("%s - draw()", type(self)) self.renderer = RendererWx(self.bitmap, self.figure.dpi) self.figure.draw(self.renderer) self._isDrawn = True self.gui_repaint(drawDC=drawDC) def print_bmp(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_BMP, *args, **kwargs) def print_jpeg(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_JPEG, *args, **kwargs) print_jpg = print_jpeg def print_pcx(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_PCX, *args, **kwargs) def print_png(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_PNG, *args, **kwargs) def print_tiff(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_TIF, *args, **kwargs) print_tif = print_tiff def print_xpm(self, filename, *args, **kwargs): return self._print_image(filename, wx.BITMAP_TYPE_XPM, *args, **kwargs) @_check_savefig_extra_args def _print_image(self, filename, filetype, *, quality=None): origBitmap = self.bitmap self.bitmap = wx.Bitmap(math.ceil(self.figure.bbox.width), math.ceil(self.figure.bbox.height)) renderer = RendererWx(self.bitmap, self.figure.dpi) gc = renderer.new_gc() self.figure.draw(renderer) # image is the object that we call SaveFile on. image = self.bitmap # set the JPEG quality appropriately. Unfortunately, it is only # possible to set the quality on a wx.Image object. So if we # are saving a JPEG, convert the wx.Bitmap to a wx.Image, # and set the quality. if filetype == wx.BITMAP_TYPE_JPEG: if quality is None: quality = dict.__getitem__(mpl.rcParams, 'savefig.jpeg_quality') image = self.bitmap.ConvertToImage() image.SetOption(wx.IMAGE_OPTION_QUALITY, str(quality)) # Now that we have rendered into the bitmap, save it to the appropriate # file type and clean up. if (cbook.is_writable_file_like(filename) and not isinstance(image, wx.Image)): image = image.ConvertToImage() if not image.SaveFile(filename, filetype): raise RuntimeError(f'Could not save figure to {filename}') # Restore everything to normal self.bitmap = origBitmap # Note: draw is required here since bits of state about the # last renderer are strewn about the artist draw methods. Do # not remove the draw without first verifying that these have # been cleaned up. The artist contains() methods will fail # otherwise. if self._isDrawn: self.draw() # The "if self" check avoids a "wrapped C/C++ object has been deleted" # RuntimeError if doing things after window is closed. if self: self.Refresh() class FigureFrameWx(wx.Frame): def __init__(self, num, fig): # On non-Windows platform, explicitly set the position - fix # positioning bug on some Linux platforms if wx.Platform == '__WXMSW__': pos = wx.DefaultPosition else: pos = wx.Point(20, 20) wx.Frame.__init__(self, parent=None, id=-1, pos=pos, title="Figure %d" % num) # Frame will be sized later by the Fit method _log.debug("%s - __init__()", type(self)) self.num = num _set_frame_icon(self) self.canvas = self.get_canvas(fig) self.canvas.SetInitialSize(wx.Size(fig.bbox.width, fig.bbox.height)) self.canvas.SetFocus() self.sizer = wx.BoxSizer(wx.VERTICAL) self.sizer.Add(self.canvas, 1, wx.TOP | wx.LEFT | wx.EXPAND) # By adding toolbar in sizer, we are able to put it at the bottom # of the frame - so appearance is closer to GTK version self.figmgr = FigureManagerWx(self.canvas, num, self) self.toolbar = self._get_toolbar() if self.figmgr.toolmanager: backend_tools.add_tools_to_manager(self.figmgr.toolmanager) if self.toolbar: backend_tools.add_tools_to_container(self.toolbar) if self.toolbar is not None: self.toolbar.Realize() # On Windows platform, default window size is incorrect, so set # toolbar width to figure width. tw, th = self.toolbar.GetSize() fw, fh = self.canvas.GetSize() # By adding toolbar in sizer, we are able to put it at the bottom # of the frame - so appearance is closer to GTK version. self.toolbar.SetSize(wx.Size(fw, th)) self.sizer.Add(self.toolbar, 0, wx.LEFT | wx.EXPAND) self.SetSizer(self.sizer) self.Fit() self.canvas.SetMinSize((2, 2)) self.Bind(wx.EVT_CLOSE, self._onClose) @cbook.deprecated("3.2", alternative="self.GetStatusBar()") @property def statusbar(self): return self.GetStatusBar() @property def toolmanager(self): return self.figmgr.toolmanager def _get_toolbar(self): if mpl.rcParams['toolbar'] == 'toolbar2': toolbar = NavigationToolbar2Wx(self.canvas) elif mpl.rcParams['toolbar'] == 'toolmanager': toolbar = ToolbarWx(self.toolmanager, self) else: toolbar = None return toolbar def get_canvas(self, fig): return FigureCanvasWx(self, -1, fig) def get_figure_manager(self): _log.debug("%s - get_figure_manager()", type(self)) return self.figmgr def _onClose(self, event): _log.debug("%s - onClose()", type(self)) self.canvas.close_event() self.canvas.stop_event_loop() Gcf.destroy(self) if self: self.Destroy() def GetToolBar(self): """Override wxFrame::GetToolBar as we don't have managed toolbar""" return self.toolbar def Destroy(self, *args, **kwargs): try: self.canvas.mpl_disconnect(self.toolbar._id_drag) # Rationale for line above: see issue 2941338. except AttributeError: pass # classic toolbar lacks the attribute # The "if self" check avoids a "wrapped C/C++ object has been deleted" # RuntimeError at exit with e.g. # MPLBACKEND=wxagg python -c 'from pylab import *; plot()'. if self and not self.IsBeingDeleted(): wx.Frame.Destroy(self, *args, **kwargs) if self.toolbar is not None: self.toolbar.Destroy() wxapp = wx.GetApp() if wxapp: wxapp.Yield() return True class FigureManagerWx(FigureManagerBase): """ Container/controller for the FigureCanvas and GUI frame. It is instantiated by Gcf whenever a new figure is created. Gcf is responsible for managing multiple instances of FigureManagerWx. Attributes ---------- canvas : `FigureCanvas` a FigureCanvasWx(wx.Panel) instance window : wxFrame a wxFrame instance - wxpython.org/Phoenix/docs/html/Frame.html """ def __init__(self, canvas, num, frame): _log.debug("%s - __init__()", type(self)) FigureManagerBase.__init__(self, canvas, num) self.frame = frame self.window = frame @property def toolbar(self): return self.frame.GetToolBar() @toolbar.setter def toolbar(self, value): # Never allow this, except that base class inits this to None before # the frame is set up. if value is not None or hasattr(self, "frame"): raise AttributeError("can't set attribute") def show(self): # docstring inherited self.frame.Show() self.canvas.draw() if mpl.rcParams['figure.raise_window']: self.frame.Raise() def destroy(self, *args): # docstring inherited _log.debug("%s - destroy()", type(self)) frame = self.frame if frame: # Else, may have been already deleted, e.g. when closing. frame.Close() wxapp = wx.GetApp() if wxapp: wxapp.Yield() def get_window_title(self): # docstring inherited return self.window.GetTitle() def set_window_title(self, title): # docstring inherited self.window.SetTitle(title) def resize(self, width, height): # docstring inherited self.canvas.SetInitialSize(wx.Size(width, height)) self.window.GetSizer().Fit(self.window) def _load_bitmap(filename): """ Load a wx.Bitmap from a file in the "images" directory of the Matplotlib data. """ return wx.Bitmap(str(cbook._get_data_path('images', filename))) def _set_frame_icon(frame): bundle = wx.IconBundle() for image in ('matplotlib.png', 'matplotlib_large.png'): icon = wx.Icon(_load_bitmap(image)) if not icon.IsOk(): return bundle.AddIcon(icon) frame.SetIcons(bundle) cursord = { cursors.MOVE: wx.CURSOR_HAND, cursors.HAND: wx.CURSOR_HAND, cursors.POINTER: wx.CURSOR_ARROW, cursors.SELECT_REGION: wx.CURSOR_CROSS, cursors.WAIT: wx.CURSOR_WAIT, } class NavigationToolbar2Wx(NavigationToolbar2, wx.ToolBar): def __init__(self, canvas, coordinates=True): wx.ToolBar.__init__(self, canvas.GetParent(), -1) if 'wxMac' in wx.PlatformInfo: self.SetToolBitmapSize((24, 24)) self.wx_ids = {} for text, tooltip_text, image_file, callback in self.toolitems: if text is None: self.AddSeparator() continue self.wx_ids[text] = ( self.AddTool( -1, bitmap=self._icon(f"{image_file}.png"), bmpDisabled=wx.NullBitmap, label=text, shortHelp=tooltip_text, kind=(wx.ITEM_CHECK if text in ["Pan", "Zoom"] else wx.ITEM_NORMAL)) .Id) self.Bind(wx.EVT_TOOL, getattr(self, callback), id=self.wx_ids[text]) self._coordinates = coordinates if self._coordinates: self.AddStretchableSpace() self._label_text = wx.StaticText(self) self.AddControl(self._label_text) self.Realize() NavigationToolbar2.__init__(self, canvas) self._idle = True self._prevZoomRect = None # for now, use alternate zoom-rectangle drawing on all # Macs. N.B. In future versions of wx it may be possible to # detect Retina displays with window.GetContentScaleFactor() # and/or dc.GetContentScaleFactor() self._retinaFix = 'wxMac' in wx.PlatformInfo prevZoomRect = cbook._deprecate_privatize_attribute("3.3") retinaFix = cbook._deprecate_privatize_attribute("3.3") savedRetinaImage = cbook._deprecate_privatize_attribute("3.3") wxoverlay = cbook._deprecate_privatize_attribute("3.3") zoomAxes = cbook._deprecate_privatize_attribute("3.3") zoomStartX = cbook._deprecate_privatize_attribute("3.3") zoomStartY = cbook._deprecate_privatize_attribute("3.3") @staticmethod def _icon(name): """ Construct a `wx.Bitmap` suitable for use as icon from an image file *name*, including the extension and relative to Matplotlib's "images" data directory. """ image = np.array(PIL.Image.open(cbook._get_data_path("images", name))) try: dark = wx.SystemSettings.GetAppearance().IsDark() except AttributeError: # wxpython < 4.1 # copied from wx's IsUsingDarkBackground / GetLuminance. bg = wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW) fg = wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOWTEXT) # See wx.Colour.GetLuminance. bg_lum = (.299 * bg.red + .587 * bg.green + .114 * bg.blue) / 255 fg_lum = (.299 * fg.red + .587 * fg.green + .114 * fg.blue) / 255 dark = fg_lum - bg_lum > .2 if dark: fg = wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOWTEXT) black_mask = (image[..., :3] == 0).all(axis=-1) image[black_mask, :3] = (fg.Red(), fg.Green(), fg.Blue()) return wx.Bitmap.FromBufferRGBA( image.shape[1], image.shape[0], image.tobytes()) def get_canvas(self, frame, fig): return type(self.canvas)(frame, -1, fig) def zoom(self, *args): self.ToggleTool(self.wx_ids['Pan'], False) NavigationToolbar2.zoom(self, *args) def pan(self, *args): self.ToggleTool(self.wx_ids['Zoom'], False) NavigationToolbar2.pan(self, *args) def configure_subplots(self, *args): global FigureManager # placates pyflakes: created by @_Backend.export frame = wx.Frame(None, -1, "Configure subplots") _set_frame_icon(frame) toolfig = Figure((6, 3)) canvas = type(self.canvas)(frame, -1, toolfig) # Create a figure manager to manage things FigureManager(canvas, 1, frame) # Now put all into a sizer sizer = wx.BoxSizer(wx.VERTICAL) # This way of adding to sizer allows resizing sizer.Add(canvas, 1, wx.LEFT | wx.TOP | wx.GROW) frame.SetSizer(sizer) frame.Fit() SubplotTool(self.canvas.figure, toolfig) frame.Show() def save_figure(self, *args): # Fetch the required filename and file type. filetypes, exts, filter_index = self.canvas._get_imagesave_wildcards() default_file = self.canvas.get_default_filename() dlg = wx.FileDialog( self.canvas.GetParent(), "Save to file", mpl.rcParams["savefig.directory"], default_file, filetypes, wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT) dlg.SetFilterIndex(filter_index) if dlg.ShowModal() == wx.ID_OK: path = pathlib.Path(dlg.GetPath()) _log.debug('%s - Save file path: %s', type(self), path) fmt = exts[dlg.GetFilterIndex()] ext = path.suffix[1:] if ext in self.canvas.get_supported_filetypes() and fmt != ext: # looks like they forgot to set the image type drop # down, going with the extension. _log.warning('extension %s did not match the selected ' 'image type %s; going with %s', ext, fmt, ext) fmt = ext # Save dir for next time, unless empty str (which means use cwd). if mpl.rcParams["savefig.directory"]: mpl.rcParams["savefig.directory"] = str(path.parent) try: self.canvas.figure.savefig(str(path), format=fmt) except Exception as e: error_msg_wx(str(e)) def set_cursor(self, cursor): cursor = wx.Cursor(cursord[cursor]) self.canvas.SetCursor(cursor) self.canvas.Update() def press_zoom(self, event): super().press_zoom(event) if self.mode.name == 'ZOOM': if not self._retinaFix: self._wxoverlay = wx.Overlay() else: if event.inaxes is not None: self._savedRetinaImage = self.canvas.copy_from_bbox( event.inaxes.bbox) self._zoomStartX = event.xdata self._zoomStartY = event.ydata self._zoomAxes = event.inaxes def release_zoom(self, event): super().release_zoom(event) if self.mode.name == 'ZOOM': # When the mouse is released we reset the overlay and it # restores the former content to the window. if not self._retinaFix: self._wxoverlay.Reset() del self._wxoverlay else: del self._savedRetinaImage if self._prevZoomRect: self._prevZoomRect.pop(0).remove() self._prevZoomRect = None if self._zoomAxes: self._zoomAxes = None def draw_rubberband(self, event, x0, y0, x1, y1): if self._retinaFix: # On Macs, use the following code # wx.DCOverlay does not work properly on Retina displays. rubberBandColor = '#C0C0FF' if self._prevZoomRect: self._prevZoomRect.pop(0).remove() self.canvas.restore_region(self._savedRetinaImage) X0, X1 = self._zoomStartX, event.xdata Y0, Y1 = self._zoomStartY, event.ydata lineX = (X0, X0, X1, X1, X0) lineY = (Y0, Y1, Y1, Y0, Y0) self._prevZoomRect = self._zoomAxes.plot( lineX, lineY, '-', color=rubberBandColor) self._zoomAxes.draw_artist(self._prevZoomRect[0]) self.canvas.blit(self._zoomAxes.bbox) return # Use an Overlay to draw a rubberband-like bounding box. dc = wx.ClientDC(self.canvas) odc = wx.DCOverlay(self._wxoverlay, dc) odc.Clear() # Mac's DC is already the same as a GCDC, and it causes # problems with the overlay if we try to use an actual # wx.GCDC so don't try it. if 'wxMac' not in wx.PlatformInfo: dc = wx.GCDC(dc) height = self.canvas.figure.bbox.height y1 = height - y1 y0 = height - y0 if y1 < y0: y0, y1 = y1, y0 if x1 < x0: x0, x1 = x1, x0 w = x1 - x0 h = y1 - y0 rect = wx.Rect(x0, y0, w, h) rubberBandColor = '#C0C0FF' # or load from config? # Set a pen for the border color = wx.Colour(rubberBandColor) dc.SetPen(wx.Pen(color, 1)) # use the same color, plus alpha for the brush r, g, b, a = color.Get(True) color.Set(r, g, b, 0x60) dc.SetBrush(wx.Brush(color)) dc.DrawRectangle(rect) @cbook.deprecated("3.2") def set_status_bar(self, statbar): self.GetTopLevelParent().SetStatusBar(statbar) @cbook.deprecated("3.2", alternative="self.GetTopLevelParent().GetStatusBar()") @property def statbar(self): return self.GetTopLevelParent().GetStatusBar() def set_message(self, s): if self._coordinates: self._label_text.SetLabel(s) def set_history_buttons(self): can_backward = self._nav_stack._pos > 0 can_forward = self._nav_stack._pos < len(self._nav_stack._elements) - 1 if 'Back' in self.wx_ids: self.EnableTool(self.wx_ids['Back'], can_backward) if 'Forward' in self.wx_ids: self.EnableTool(self.wx_ids['Forward'], can_forward) @cbook.deprecated("3.3") class StatusBarWx(wx.StatusBar): """ A status bar is added to _FigureFrame to allow measurements and the previously selected scroll function to be displayed as a user convenience. """ def __init__(self, parent, *args, **kwargs): wx.StatusBar.__init__(self, parent, -1) self.SetFieldsCount(2) def set_function(self, string): self.SetStatusText("%s" % string, 1) # tools for matplotlib.backend_managers.ToolManager: class ToolbarWx(ToolContainerBase, wx.ToolBar): def __init__(self, toolmanager, parent, style=wx.TB_HORIZONTAL): ToolContainerBase.__init__(self, toolmanager) wx.ToolBar.__init__(self, parent, -1, style=style) self._space = self.AddStretchableSpace() self._label_text = wx.StaticText(self) self.AddControl(self._label_text) self._toolitems = {} self._groups = {} # Mapping of groups to the separator after them. def _get_tool_pos(self, tool): """ Find the position (index) of a wx.ToolBarToolBase in a ToolBar. ``ToolBar.GetToolPos`` is not useful because wx assigns the same Id to all Separators and StretchableSpaces. """ pos, = [pos for pos in range(self.ToolsCount) if self.GetToolByPos(pos) == tool] return pos def add_toolitem(self, name, group, position, image_file, description, toggle): # Find or create the separator that follows this group. if group not in self._groups: self._groups[group] = self.InsertSeparator( self._get_tool_pos(self._space)) sep = self._groups[group] # List all separators. seps = [t for t in map(self.GetToolByPos, range(self.ToolsCount)) if t.IsSeparator() and not t.IsStretchableSpace()] # Find where to insert the tool. if position >= 0: # Find the start of the group by looking for the separator # preceding this one; then move forward from it. start = (0 if sep == seps[0] else self._get_tool_pos(seps[seps.index(sep) - 1]) + 1) else: # Move backwards from this separator. start = self._get_tool_pos(sep) + 1 idx = start + position if image_file: bmp = NavigationToolbar2Wx._icon(image_file) kind = wx.ITEM_NORMAL if not toggle else wx.ITEM_CHECK tool = self.InsertTool(idx, -1, name, bmp, wx.NullBitmap, kind, description or "") else: size = (self.GetTextExtent(name)[0] + 10, -1) if toggle: control = wx.ToggleButton(self, -1, name, size=size) else: control = wx.Button(self, -1, name, size=size) tool = self.InsertControl(idx, control, label=name) self.Realize() def handler(event): self.trigger_tool(name) if image_file: self.Bind(wx.EVT_TOOL, handler, tool) else: control.Bind(wx.EVT_LEFT_DOWN, handler) self._toolitems.setdefault(name, []) self._toolitems[name].append((tool, handler)) def toggle_toolitem(self, name, toggled): if name not in self._toolitems: return for tool, handler in self._toolitems[name]: if not tool.IsControl(): self.ToggleTool(tool.Id, toggled) else: tool.GetControl().SetValue(toggled) self.Refresh() def remove_toolitem(self, name): for tool, handler in self._toolitems[name]: self.DeleteTool(tool.Id) del self._toolitems[name] def set_message(self, s): self._label_text.SetLabel(s) @cbook.deprecated("3.3") class StatusbarWx(StatusbarBase, wx.StatusBar): """For use with ToolManager.""" def __init__(self, parent, *args, **kwargs): StatusbarBase.__init__(self, *args, **kwargs) wx.StatusBar.__init__(self, parent, -1) self.SetFieldsCount(1) self.SetStatusText("") def set_message(self, s): self.SetStatusText(s) class ConfigureSubplotsWx(backend_tools.ConfigureSubplotsBase): def trigger(self, *args): NavigationToolbar2Wx.configure_subplots( self._make_classic_style_pseudo_toolbar()) @cbook.deprecated("3.2") def configure_subplots(self): frame = wx.Frame(None, -1, "Configure subplots") _set_frame_icon(frame) toolfig = Figure((6, 3)) canvas = self.get_canvas(frame, toolfig) # Now put all into a sizer sizer = wx.BoxSizer(wx.VERTICAL) # This way of adding to sizer allows resizing sizer.Add(canvas, 1, wx.LEFT | wx.TOP | wx.GROW) frame.SetSizer(sizer) frame.Fit() SubplotTool(self.canvas.figure, toolfig) frame.Show() @cbook.deprecated("3.2") def get_canvas(self, frame, fig): return type(self.canvas)(frame, -1, fig) class SaveFigureWx(backend_tools.SaveFigureBase): def trigger(self, *args): NavigationToolbar2Wx.save_figure( self._make_classic_style_pseudo_toolbar()) class SetCursorWx(backend_tools.SetCursorBase): def set_cursor(self, cursor): NavigationToolbar2Wx.set_cursor( self._make_classic_style_pseudo_toolbar(), cursor) if 'wxMac' not in wx.PlatformInfo: # on most platforms, use overlay class RubberbandWx(backend_tools.RubberbandBase): def __init__(self, *args, **kwargs): backend_tools.RubberbandBase.__init__(self, *args, **kwargs) self._wxoverlay = None def draw_rubberband(self, x0, y0, x1, y1): # Use an Overlay to draw a rubberband-like bounding box. if self._wxoverlay is None: self._wxoverlay = wx.Overlay() dc = wx.ClientDC(self.canvas) odc = wx.DCOverlay(self._wxoverlay, dc) odc.Clear() dc = wx.GCDC(dc) height = self.canvas.figure.bbox.height y1 = height - y1 y0 = height - y0 if y1 < y0: y0, y1 = y1, y0 if x1 < x0: x0, x1 = x1, x0 w = x1 - x0 h = y1 - y0 rect = wx.Rect(x0, y0, w, h) rubberBandColor = '#C0C0FF' # or load from config? # Set a pen for the border color = wx.Colour(rubberBandColor) dc.SetPen(wx.Pen(color, 1)) # use the same color, plus alpha for the brush r, g, b, a = color.Get(True) color.Set(r, g, b, 0x60) dc.SetBrush(wx.Brush(color)) dc.DrawRectangle(rect) def remove_rubberband(self): if self._wxoverlay is None: return self._wxoverlay.Reset() self._wxoverlay = None else: # on Mac OS retina displays DCOverlay does not work # and dc.SetLogicalFunction does not have an effect on any display # the workaround is to blit the full image for remove_rubberband class RubberbandWx(backend_tools.RubberbandBase): def __init__(self, *args, **kwargs): backend_tools.RubberbandBase.__init__(self, *args, **kwargs) self._rect = None def draw_rubberband(self, x0, y0, x1, y1): dc = wx.ClientDC(self.canvas) # this would be required if the Canvas is a ScrolledWindow, # which is not the case for now # self.PrepareDC(dc) # delete old rubberband if self._rect: self.remove_rubberband(dc) # draw new rubberband dc.SetPen(wx.Pen(wx.BLACK, 1, wx.SOLID)) dc.SetBrush(wx.TRANSPARENT_BRUSH) self._rect = (x0, self.canvas._height-y0, x1-x0, -y1+y0) dc.DrawRectangle(self._rect) def remove_rubberband(self, dc=None): if not self._rect: return if self.canvas.bitmap: if dc is None: dc = wx.ClientDC(self.canvas) dc.DrawBitmap(self.canvas.bitmap, 0, 0) # for testing the method on Windows, use this code instead: # img = self.canvas.bitmap.ConvertToImage() # bmp = img.ConvertToBitmap() # dc.DrawBitmap(bmp, 0, 0) self._rect = None class _HelpDialog(wx.Dialog): _instance = None # a reference to an open dialog singleton headers = [("Action", "Shortcuts", "Description")] widths = [100, 140, 300] def __init__(self, parent, help_entries): wx.Dialog.__init__(self, parent, title="Help", style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER) sizer = wx.BoxSizer(wx.VERTICAL) grid_sizer = wx.FlexGridSizer(0, 3, 8, 6) # create and add the entries bold = self.GetFont().MakeBold() for r, row in enumerate(self.headers + help_entries): for (col, width) in zip(row, self.widths): label = wx.StaticText(self, label=col) if r == 0: label.SetFont(bold) label.Wrap(width) grid_sizer.Add(label, 0, 0, 0) # finalize layout, create button sizer.Add(grid_sizer, 0, wx.ALL, 6) OK = wx.Button(self, wx.ID_OK) sizer.Add(OK, 0, wx.ALIGN_CENTER_HORIZONTAL | wx.ALL, 8) self.SetSizer(sizer) sizer.Fit(self) self.Layout() self.Bind(wx.EVT_CLOSE, self.OnClose) OK.Bind(wx.EVT_BUTTON, self.OnClose) def OnClose(self, event): _HelpDialog._instance = None # remove global reference self.DestroyLater() event.Skip() @classmethod def show(cls, parent, help_entries): # if no dialog is shown, create one; otherwise just re-raise it if cls._instance: cls._instance.Raise() return cls._instance = cls(parent, help_entries) cls._instance.Show() class HelpWx(backend_tools.ToolHelpBase): def trigger(self, *args): _HelpDialog.show(self.figure.canvas.GetTopLevelParent(), self._get_help_entries()) class ToolCopyToClipboardWx(backend_tools.ToolCopyToClipboardBase): def trigger(self, *args, **kwargs): if not self.canvas._isDrawn: self.canvas.draw() if not self.canvas.bitmap.IsOk() or not wx.TheClipboard.Open(): return try: wx.TheClipboard.SetData(wx.BitmapDataObject(self.canvas.bitmap)) finally: wx.TheClipboard.Close() backend_tools.ToolSaveFigure = SaveFigureWx backend_tools.ToolConfigureSubplots = ConfigureSubplotsWx backend_tools.ToolSetCursor = SetCursorWx backend_tools.ToolRubberband = RubberbandWx backend_tools.ToolHelp = HelpWx backend_tools.ToolCopyToClipboard = ToolCopyToClipboardWx @_Backend.export class _BackendWx(_Backend): FigureCanvas = FigureCanvasWx FigureManager = FigureManagerWx _frame_class = FigureFrameWx @staticmethod def trigger_manager_draw(manager): manager.canvas.draw_idle() @classmethod def new_figure_manager(cls, num, *args, **kwargs): # Create a wx.App instance if it has not been created so far. wxapp = wx.GetApp() if wxapp is None: wxapp = wx.App(False) wxapp.SetExitOnFrameDelete(True) # Retain a reference to the app object so that it does not get # garbage collected. _BackendWx._theWxApp = wxapp return super().new_figure_manager(num, *args, **kwargs) @classmethod def new_figure_manager_given_figure(cls, num, figure): frame = cls._frame_class(num, figure) figmgr = frame.get_figure_manager() if mpl.is_interactive(): figmgr.frame.Show() figure.canvas.draw_idle() return figmgr @staticmethod def mainloop(): if not wx.App.IsMainLoopRunning(): wxapp = wx.GetApp() if wxapp is not None: wxapp.MainLoop()