3 ƽhw,@sdZddlmZddlZddlZddlZddlmZddlZddl m Z ddl Z ddl ZddlmZddljZejeZGdddeZeZd ZGd d d ZGd d d eZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZ ej!dGddde Z"GdddeZ#ej!dGdd d e#Z$Gd!d"d"eZ%Gd#d$d$eZ&Gd%d&d&eZ'Gd'd(d(eZ(Gd)d*d*e(Z)Gd+d,d,e(Z*Gd-d.d.eZ+Gd/d0d0eZ,Gd1d2d2e,Z-Gd3d4d4e,Z.Gd5d6d6e,Z/Gd7d8d8eZ0Gd9d:d:eZ1Gd;d<dd>e2Z3Gd?d@d@e2Z4GdAdBdBeZ5GdCdDdDeZ6dEe-dFe.dGe/dHe3dIe4dJdKdLdMdNe%dOe&dPe'dQedRedSe dTe#dUe*dVe)dWeee+dXdYdZd[d\d]d^d_iZ7d`dEdFdGggdadIdHdJggdbdLd\gggZ8e7fdcddZ9e8fdedfZ:dS)gaR Abstract base classes define the primitives for Tools. These tools are used by `matplotlib.backend_managers.ToolManager` :class:`ToolBase` Simple stateless tool :class:`ToolToggleBase` Tool that has two states, only one Toggle tool can be active at any given time for the same `matplotlib.backend_managers.ToolManager` )IntEnumN)SimpleNamespace)WeakKeyDictionary)Gcfc@s"eZdZdZed\ZZZZZ dS)Cursorsz!Backend-independent cursor types.N) __name__ __module__ __qualname____doc__rangeZHANDPOINTER SELECT_REGIONMOVEZWAITrr>/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/backend_tools.pyrsrZviewposc@seZdZdZdZdZdZddZeddZ e j ddZ edd Z ed d Z d d Z ddZdddZeddZddZdS)ToolBasea Base tool class. A base tool, only implements `trigger` method or not method at all. The tool is instantiated by `matplotlib.backend_managers.ToolManager`. Attributes ---------- toolmanager : `matplotlib.backend_managers.ToolManager` ToolManager that controls this Tool. figure : `FigureCanvas` Figure instance that is affected by this Tool. name : str Used as **Id** of the tool, has to be unique among tools of the same ToolManager. NcCs tjd||_||_d|_dS)Nz|The new Tool classes introduced in v1.5 are experimental; their API (including names) will likely change in future versions.)cbookZ_warn_external_name _toolmanager_figure)self toolmanagernamerrr__init__Rs zToolBase.__init__cCs|jS)N)r)rrrrfigureZszToolBase.figurecCs|j|dS)N) set_figure)rrrrrr^scCs|js dS|jjS)N)rcanvas)rrrrrbszToolBase.canvascCs|jS)N)r)rrrrrhszToolBase.toolmanagercCs t|jdS)z Return a placeholder object with a single `canvas` attribute. This is useful to reuse the implementations of tools already provided by the classic Toolbars. )r)rr)rrrr"_make_classic_style_pseudo_toolbarlsz+ToolBase._make_classic_style_pseudo_toolbarcCs ||_dS)zp Assign a figure to the tool. Parameters ---------- figure : `.Figure` N)r)rrrrrruszToolBase.set_figurecCsdS)a Called when this tool gets used. This method is called by `matplotlib.backend_managers.ToolManager.trigger_tool`. Parameters ---------- event : `.Event` The canvas event that caused this tool to be called. sender : object Object that requested the tool to be triggered. data : object Extra data. Nr)rsendereventdatarrrtriggerszToolBase.triggercCs|jS)zTool Id.)r)rrrrrsz ToolBase.namecCsdS)z Destroy the tool. This method is called when the tool is removed by `matplotlib.backend_managers.ToolManager.remove_tool`. Nr)rrrrdestroyszToolBase.destroy)N)rr r r default_keymap descriptionimagerpropertyrsetterrrrrr"rr#rrrrr(s      rc@sVeZdZdZdZdZdZddZdddZddd Z dd d Z e d d Z ddZ dS)ToolToggleBaseac Toggleable tool. Every time it is triggered, it switches between enable and disable. Parameters ---------- ``*args`` Variable length argument to be used by the Tool. ``**kwargs`` `toggled` if present and True, sets the initial state of the Tool Arbitrary keyword arguments to be consumed by the Tool NFcOs&|jd|j|_tj|f||dS)Ntoggled)popdefault_toggled_toggledrr)rargskwargsrrrrszToolToggleBase.__init__cCs*|jr|j|n |j||j |_dS)z5Calls `enable` or `disable` based on `toggled` value.N)r-disableenable)rrr r!rrrr"s  zToolToggleBase.triggercCsdS)zg Enable the toggle tool. `trigger` calls this method when `toggled` is False. Nr)rr rrrr1szToolToggleBase.enablecCsdS)ay Disable the toggle tool. `trigger` call this method when `toggled` is True. This can happen in different circumstances. * Click on the toolbar tool button. * Call to `matplotlib.backend_managers.ToolManager.trigger_tool`. * Another `ToolToggleBase` derived tool is triggered (from the same `.ToolManager`). Nr)rr rrrr0s zToolToggleBase.disablecCs|jS)zState of the toggled tool.)r-)rrrrr*szToolToggleBase.toggledcCsP|j}|r$|jr|j|dnd|_tj|||rL|rF|j|dnd|_dS)NFT)r*rr"r-rr)rrr*rrrrs zToolToggleBase.set_figure)N)N)N)rr r r radio_groupcursorr,rr"r1r0r'r*rrrrrr)s     r)c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS) SetCursorBasez Change to the current cursor while inaxes. This tool, keeps track of all `ToolToggleBase` derived tools, and calls `set_cursor` when a tool gets triggered. cOsbtj|f||d|_d|_tj|_|j|_|jj d|j x|jj j D]}|j |qLWdS)NZtool_added_event)rr_id_drag_cursorcursorsr _default_cursor _last_cursorrtoolmanager_connect _add_tool_cbktoolsvalues _add_tool)rr.r/toolrrrrszSetCursorBase.__init__cCs:|jr|jj|jtj|||r6|jjd|j|_dS)Nmotion_notify_event)r5rmpl_disconnectrr mpl_connect_set_cursor_cbk)rrrrrr s  zSetCursorBase.set_figurecCs*|jjr|jj|_nd|_|j|jdS)N)r?r*r3r6rCZ canvasevent)rr rrr_tool_trigger_cbks zSetCursorBase._tool_trigger_cbkcCs*t|dddk r&|jjd|j|jdS)z*Set the cursor when the tool is triggered.r3Nztool_trigger_%s)getattrrr:rrD)rr?rrrr>szSetCursorBase._add_toolcCs|j|krdS|j|jdS)zProcess every newly added tool.N)r?r>)rr rrrr;"s zSetCursorBase._add_tool_cbkcCsn|sdSt|dd s|j r@|j|jkrj|j|j|j|_n*|jrj|j}|rj|j|krj|j|||_dS)NinaxesF)rEr6r9r8 set_cursor)rr r3rrrrC(s    zSetCursorBase._set_cursor_cbkcCstdS)zY Set the cursor. This method has to be implemented per backend. N)NotImplementedError)rr3rrrrG6szSetCursorBase.set_cursorN) rr r r rrrDr>r;rCrGrrrrr4s r4c@s(eZdZdZddZddZddZdS) ToolCursorPositionz Send message with the current pointer position. This tool runs in the background reporting the position of the cursor. cOsd|_tj|f||dS)N)r5rr)rr.r/rrrrEszToolCursorPosition.__init__cCs:|jr|jj|jtj|||r6|jjd|j|_dS)Nr@)r5rrArrrB send_message)rrrrrrIs  zToolCursorPosition.set_figurec s|jjjrdSd}jrjjryjjjj}Wntt fk rRYnfXfddjj D}|rt j |}|jj k r|j}|dk r|j|}|dk r|d|}|}|jj||dS)z=Call `matplotlib.backend_managers.ToolManager.message_event`.N cs"g|]}|jr|jr|qSr)containsZ get_visible).0a)r rr ^sz3ToolCursorPosition.send_message..)r messagelocklockedrF get_navigateZ format_coordZxdataZydata ValueError OverflowErrorZ_mouseover_setrZ_topmost_artistpatchZget_cursor_dataZformat_cursor_data message_event)rr messagesZartistsrNr!Zdata_strr)r rrJQs&      zToolCursorPosition.send_messageN)rr r r rrrJrrrrrI?srIc@s(eZdZdZddZddZddZdS) RubberbandBasezDraw and remove a rubberband.cCs4|jjjj|sdS|dk r(|j|n|jdS)z*sz/ToolViewsPositions.add_figure..N)rrZStackrrr push_currentZadd_axobserver)rrr)rr add_figure s    zToolViewsPositions.add_figurecCs@||jkr<|j|j|j|j|j|j|jdS)zReset the axes stack.N)rclearrrr)rrrrrr,s  zToolViewsPositions.clearcCs|j|j}|dkrdS|j|j}|dkr4dS|j|j}|jj}x0|D](}||krf||}n||}|j|qPWt|j|rx4|D],}|j||dd|j||ddqW|jj j dS)a Update the view limits and position for each axes from the current stack position. If any axes are present in the figure that aren't in the current stack position, use the home view limits for those axes and don't update *any* positions. Nroriginalactive) rrrrget_axesZ _set_viewsetissubsetZ _set_positionrr)rrposrZall_axesrNZcur_viewrrr update_view4s$     zToolViewsPositions.update_viewNcCsf|s |j}t}t}x*|jD]}|j||<|j|||<q W|j|j||j|j|dS)zY Push the current view limits and position onto their respective stacks. N)rrr _get_view _axes_posrpushr)rrrrrNrrrrSs zToolViewsPositions.push_currentcCs|jdj|jjfS)aY Return the original and modified positions for the specified axes. Parameters ---------- ax : matplotlib.axes.Axes The `.Axes` to get the positions for. Returns ------- original_position, modified_position A tuple of the original and modified positions. T) get_positionfrozen)rrrrrras zToolViewsPositions._axes_poscCs@|s |j}x0|jD]$}||j|kr|j|j||<qWdS)zm Make sure that ``self.home_views`` has an entry for all axes present in the figure. N)rrrr)rrrNrrrrss z$ToolViewsPositions.update_home_viewsz3.3zself.figure.canvas.draw_idle()) alternativecCs |jdS)z)Redraw the canvases, update the locators.N)_refresh_locators)rrrrrefresh_locatorssz#ToolViewsPositions.refresh_locatorscCsx|jjD]}t|dd}t|dd}t|dd}g}|dk r\|j|j|j|j|dk r|j|j|j|j|dk r|j|j|j|jx|D]}tjj|qWq W|jj j dS)Nxaxisyaxiszaxis) rrrEappendZget_major_locatorZget_minor_locatorr_ZtickerZ+_if_refresh_overridden_call_and_emit_deprecrr)rrNrrrZlocatorslocrrrrs"    z$ToolViewsPositions._refresh_locatorscCs$|j|jj|j|jjdS)z2Recall the first view and position from the stack.N)rrhomer)rrrrrszToolViewsPositions.homecCs$|j|jj|j|jjdS)z2Back one step in the stack of views and positions.N)rrbackr)rrrrrszToolViewsPositions.backcCs$|j|jj|j|jjdS)z5Forward one step in the stack of views and positions.N)rrforwardr)rrrrrszToolViewsPositions.forward)N)N)rr r r rrrrrrrr deprecatedrrrrrrrrrr s    rc@seZdZdZdZdddZdS)ViewsPositionsBasez8Base class for `ToolHome`, `ToolBack` and `ToolForward`.NcCs>|jjtj|jt|jjt|j|jjtjdS)N)rget_tool_views_positionsrrrE _on_triggerr)rrr r!rrrr"s  zViewsPositionsBase.trigger)N)rr r r rr"rrrrrsrc@s&eZdZdZdZdZejdZdZ dS)ToolHomez!Restore the original view limits.zReset original viewrz keymap.homeN) rr r r r%r&r_r`r$rrrrrrs  rc@s&eZdZdZdZdZejdZdZ dS)ToolBackz#Move back up the view limits stack.zBack to previous viewrz keymap.backN) rr r r r%r&r_r`r$rrrrrrs  rc@s&eZdZdZdZdZejdZdZ dS) ToolForwardz#Move forward in the view lim stack.zForward to next viewrzkeymap.forwardN) rr r r r%r&r_r`r$rrrrrrs  rc@seZdZdZdZdZdS)ConfigureSubplotsBasez,Base tool for the configuration of subplots.zConfigure subplotssubplotsN)rr r r r%r&rrrrrsrc@s"eZdZdZdZdZejdZdS)SaveFigureBasezBase tool for figure saving.zSave the figureZfilesavez keymap.saveN) rr r r r%r&r_r`r$rrrrrsrc@s:eZdZdZddZddZddZd d d Zd d ZdS) ZoomPanBasez(Base class for `ToolZoom` and `ToolPan`.cGsNtj|f|d|_d|_d|_d|_d|_d|_d|_t j |j|_ dS)Ng@g?) r)r_button_pressed_xypress_idPress _idRelease _idScroll base_scale scrollthreshtime lastscroll)rr.rrrrszZoomPanBase.__init__cCsN|jjj||jjjd|j|_|jjjd|j|_|jjjd|j|_ dS)z1Connect press/release events and lock the canvas.Zbutton_press_eventZbutton_release_eventZ scroll_eventN) rrrZrB_pressr_releaser scroll_zoomr)rr rrrr1s  zZoomPanBase.enablecCsL|j|jjjj||jjj|j|jjj|j|jjj|jdS)z7Release the canvas and disconnect press/release events.N) _cancel_actionrrrZreleaserArrr)rr rrrr0s zZoomPanBase.disableNcCs(|jjtj|jtj||||dS)N)rrrrrr)r")rrr r!rrrr"szZoomPanBase.triggercCs|jdkrdS|jdkr |j}n|jdkr6d|j}nd}|j}|j|j|j|gtj|j|jkrx|j j t j |j jjtj|_|j j t jdS)NZupZdownr)rFbuttonr_set_view_from_bboxxyrrrrrrrrrrr)rr Zsclrrrrrs      zZoomPanBase.scroll_zoom)N) rr r r rr1r0r"rrrrrrs    rc@sdeZdZdZdZdZejdZe j Z dZ ddZ dd Zd d Zd d ZddZddZddZdS)ToolZoomz.A Tool for zooming using a rectangle selector.zZoom to rectangleZ zoom_to_rectz keymap.zoomdefaultcGstj|f|g|_dS)N)rr _ids_zoom)rr.rrrr)szToolZoom.__init__cCsRx|jD]}|jjj|qW|jjd||jjtjd|_ d|_ g|_dS)N rubberband) rrrrAr trigger_toolrrrrr)rzoom_idrrrr-s zToolZoom._cancel_actionc Cs|jr|j|jdkr d|_n|jdkr2d|_n |jdS|j|j}}g|_x^t|jj D]L\}}|dk rb|dk rb|j |rb|j rb|j rb|jj |||||jfqbW|jjjd|j}|jjjd|j}|jjjd|j}|||f|_|j|_dS)zx|jD]}|jjj|qWg|_|js6|jdSg}x|jD]}|j|j}}|\}}} } } t||dkst||dkr|jdSd \} } |rx4|D],}| j j | |rd} | j j | |rd} qW|j | |j dkrd}n|j dkrBd}nqB| j||||f||j| | qBWd|_|jjtj|jdS) z=Callback for mouse button releases in zoom-to-rectangle mode.NrFTrinrout)FF)rrrrArrrrabsZget_shared_x_axesZjoinedZget_shared_y_axesrrrrrrrr)rr rZlast_aZ cur_xypressrrrrrN_indrZtwinxZtwinyZla directionrrrrps>       zToolZoom._releaseN)rr r r r%r&r_r`r$r7rr3r2rrrrrrrrrrrr s  "rc@sTeZdZdZejdZdZdZe j Z dZ ddZ dd Zd d Zd d ZddZdS)ToolPanz*Pan axes with left mouse, zoom with right.z keymap.panz)Pan axes with left mouse, zoom with rightmovercGstj|f|d|_dS)N)rrr5)rr.rrrrszToolPan.__init__cCs>d|_g|_|jjj|j|jjj||jj t j dS)N) rrrrrAr5rrPrrrr)rrrrrs zToolPan._cancel_actioncCs|jdkrd|_n|jdkr$d|_n |jdS|j|j}}g|_xt|jjD]r\}}|dk rT|dk rT|j |rT|j rT|j rT|j |||j|jj ||f|jj||jjjd|j|_qTWdS)Nrrr@)rrrrrrrrrrrRZcan_panZ start_panrrrPrrBrr5)rr rrrrNrrrrs    zToolPan._presscCs~|jdkr|jdS|jjj|j|jjj|x|j D]\}}|j q 'Ctrl+A'. rz\+[A-Z]z +Shift\g<0>)lenresubtitle)Z key_sequencerrrformat_shortcutszToolHelpBase.format_shortcutcs$jj|}djfdd|DS)Nz, c3s|]}j|VqdS)N)r)rMZkeymap)rrr sz3ToolHelpBase._format_tool_keymap..)rZget_tool_keymapjoin)rrZkeymapsr)rr_format_tool_keymaps z ToolHelpBase._format_tool_keymapcsfddtjjjDS)Ncs(g|] \}}|jr|j||jfqSr)r%r)rMrr?)rrrrOsz2ToolHelpBase._get_help_entries..)sortedrr<items)rr)rr_get_help_entriess zToolHelpBase._get_help_entriescCs |j}dd|D}dj|S)NcSsg|]}dj|qS)z {}: {} {})format)rMentryrrrrOsz/ToolHelpBase._get_help_text.. )rr)rentriesrrr_get_help_textszToolHelpBase._get_help_textcsPdjdddg}|fdd|jD7}d|dd j|d dd S) Nz*{}{}{}z ActionzShortcutszDescriptioncsg|]}j|qSr)r)rMrow)fmtrrrOsz/ToolHelpBase._get_help_html..z2rzrz
)rrr)rZrowsr)rr_get_help_htmls  zToolHelpBase._get_help_htmlN)rr r r%r_r`r$r& staticmethodrrrrrrrrrrs  rc@s&eZdZdZdZejdZddZdS)ToolCopyToClipboardBasez)Tool to copy the figure to the clipboard.z#Copy the canvas figure to clipboardz keymap.copycOsd}|jj||dS)NzCopy tool is not available)rrV)rr.r/rWrrrr" szToolCopyToClipboardBase.triggerN) rr r r r%r_r`r$r"rrrrrs rrrrZzoomZpanrZToolConfigureSubplotssaveZToolSaveFigureZgridZ grid_minorZ fullscreenquitZquit_allZallnavnavZxscaleZyscalepositionr3Z ToolSetCursorrZToolRubberbandrZToolHelpcopyZToolCopyToClipboardZ navigationZzoompaniocCs&x |jD]\}}|j||q WdS)a/ Add multiple tools to a `.ToolManager`. Parameters ---------- toolmanager : `.backend_managers.ToolManager` Manager to which the tools are added. tools : {str: class_like}, optional The tools to add in a {name: tool} dict, see `add_tool` for more info. N)radd_tool)rr<rr?rrradd_tools_to_manager-s rcCs:x4|D],\}}x"t|D]\}}|j|||qWqWdS)a Add multiple tools to the container. Parameters ---------- container : Container `backend_bases.ToolContainerBase` object that will get the tools added. tools : list, optional List in the form ``[[group1, [tool1, tool2 ...]], [group2, [...]]]`` where the tools ``[tool1, tool2, ...]`` will display in group1. See `add_tool` for details. N)rr) containerr<groupZ grouptoolsrr?rrradd_tools_to_container>sr);r enumrloggingrrtypesrrtweakrefrnumpyrZ matplotlibr_Zmatplotlib._pylab_helpersrZmatplotlib.cbookr getLoggerr_logrr7rrr)r4rIrYr^rarbrrerfrprqryrzr}rrrrrrrrrrrrrrZ default_toolsZdefault_toolbar_toolsrrrrrr s      xXG/           @~B&