fsleyes.views.viewpanel

This module provides the ViewPanel class, which is the base-class for all of the FSLeyes view panels. See the fsleyes package documentation for more details.

class fsleyes.views.viewpanel.ViewPanel(*args, **kwargs)

Bases: FSLeyesPanel

The ViewPanel class is the base-class for all FSLeyes views.

A ViewPanel displays some sort of view of the overlays in an OverlayList. The settings for a ViewPanel are defined by a DisplayContext instance.

Panels and controls

A ViewPanel class uses a wx.lib.agw.aui.AuiManager to lay out its children. A ViewPanel has one central panel, which contains the primary view; and may have one or more secondary panels, which contain controls - see the fsleyes.controls package. The centre panel can be set via the centrePanel() property, and secondary panels can be added/removed to/from with the togglePanel() method. The current state of a secondary panel (i.e. whether one is open or not) can be queried with the isPanelOpen() method, and existing secondary panels can be accessed via the getPanel() method. Secondary panels must be derived from either the ControlPanel or ControlToolBar base-classes.

Profiles

The logic which defines the way that a user interacts with a view panel is defined by a Profile object, which contains mouse and keyboard event handlers for reacting to user input.

Sub-classes must call the initProfile() method to initialise their default profile. Other profiles may be associated with a particular control panel - these profiles can be temporarily activated and deactivated when the control panel is toggled via the togglePanel() method.

The currently active interaction profile can be accessed with the currentProfile() method. See the fsleyes.profiles package for more information on interaction profiles.

Programming interface

The following methods are available on a Viewpanel for programmatically controlling its display and layout:

togglePanel	Add/remove the secondary control panel of the specified type to/from this ViewPanel.
isPanelOpen	Returns True if a panel of type panelType is open, False otherwise.
getPanel	If an instance of panelType exists, it is returned.
getPanels	Returns a list containing all control panels currently shown in this ViewPanel.
getTools	This method should be overridden by sub-classes (if necessary), and should return any action methods which should be added to the FSLeyesFrame Tools menu.
removeFromFrame	Remove this ViewPanel from the FSLeyesFrame.
removeAllPanels	Remove all control panels from this ViewPanel.
getPanelInfo	Returns the AuiPaneInfo object which contains information about the given control panel.
auiManager	Returns the wx.lib.agw.aui.AuiManager object which manages the layout of this ViewPanel.

controlOptions(cpType)

May be overridden by sub-classes. Given a control panel type, may return a dictionary containing arguments to be passed to the __init__ method when the control panel is created.

static title()

May be overridden by sub-classes. Returns a title for this ViewPanel, to be used in menus and window title bars.

static controlOrder()

May be overridden by sub-classes. Returns a list of names of control panel types, specifying a suggested order for the settings menu for views of this type.

static toolOrder()

May be overridden by sub-classes. Returns a list of names of tools, specifying a suggested order for the corresponding entries in the FSLeyes tools menu. Note that the ordering of tools returned by the getTools() method is honoured - the ordering returned by this method relates to tools which are implemented as plugins.

static defaultLayout()

May be overridden by sub-classes. Should return a list of names of FSLeyes ControlPanel types which form the default layout for this view.

static defaultLocation()

May be overridden by sub-classes. Should return a sequence containing:

• the preferred location of the view panel in the FSLeyesFrame - one of wx.TOP, wx.BOTTOM, wx.LEFT, or wx.RIGHT.

• A number between 0 and 1 indicating the preferred size of the view panel, as a proportion of the total frame size.

static displayType()

May be overridden by sub-classes. May return a string which describes the type of display/view that this ViewPanel provides. This might be used as a hint by Display / DisplayOpts instances to tailor their overlay display settings to different view/display types.

__init__(parent, overlayList, displayCtx, frame)

Create a ViewPanel.

Parameters:

• parent – wx parent object

• overlayList – The OverlayList

• displayCtx – A DisplayContext object unique to this ViewPanel

• frame – The FSLeyesFrame

reloadPlugins()

Called by __init__(), and by the LoadPluginAction when new plugins are registered.

This is a bit of a hack, but less hacky than it used to be. All plugin-provided control panels and tools which support this ViewPanel are looked up via the plugins. module. Then, for each control, we create a ToggleControlPanelAction, and add it as an attribute on this ViewPanel.

Similarly, all plugin-provided tools which support this ViewPanel are created and added as attributes.

In both cases, the class name of the control/tool is used as the attribute name.

This is done so that these actions will work with the ActionProvider interface, and hence the FSLEeyesFrame.populateMenu() method.

This implementation may change in the future if it becomes problematic (e.g. due to naming conflicts).

destroy()

Removes some property listeners, destroys all child panels, destroys the ProfileManager, and AuiManager, and calls FSLeyesPanel.destroy().

property events: Notifier

Return a reference to a Notifier instance which can be used to be notified when certain events occur. Currently the following events are emitted:

• 'profile', when the current interaction profile changes. Callbacks which are registered with the 'profile' topic will be passed a tuple containing the types (Profile sub-classes) of the de-registered and newly registered profiles.

• 'aui_perspective', when the AUI-managed layout changes, e.g. sash resizes, control panels added/removed, etc. This event is emitted whenever the AuiManager emits a EVT_AUI_PERSPECTIVE_CHANGED event. It is re-emitted via the Notifer interface so that non-wx entities can be notified (see e.g. the ToggleControlPanelAction).

initProfile(defaultProfile)

Must be called by subclasses, after they have initialised all of the attributes which may be needed by their associated Profile instances.

Parameters:

defaultProfile – Default profile type

property currentProfile

Returns the Profile instance currently in use.

property profileManager

Returns a reference to the ProfileManager used by this ViewPanel.

property centrePanel

Returns the primary (centre) panel on this ViewPanel.

togglePanel(panelType, *args, **kwargs)

Add/remove the secondary control panel of the specified type to/from this ViewPanel.

If no keyword argunents are specified, the arguments returned by the ControlMixin.defaultLayout() method are returned.

Parameters:

• panelType – Type of the secondary panel.

• args – All positional arguments are passed to the panelType constructor.

• floatPane – If True, the secondary panel is initially floated. Defaults to False.

• floatOnly – If True, and floatPane=True, the panel will be permanently floated (i.e. it will not be dockable).

• floatPos – If provided, and floatPane is True, specifies the location of the floating panel as (w, h) proportions between 0 and 1, relative to this view panel.

• closeable – If False, and floatPane=True, the panel will not have a close button when it is floated.

• location – If floatPane=False, the initial dock position of the panel - either wx.TOP, wx.BOTTOM, wx.LEFT, or wx.RIGHT. Defaults to ``wx.BOTTOM.

• title – Title to give the control. If not provided, it is assumed that a title for panelType is in strings.titles.

• kwargs – All other keyword arguments, are passed to the panelType constructor.

Returns:

The newly created control panel.

Note

The panelType type must be a sub-class of ControlPanel or ControlToolBar, which can be created like so:

panel = panelType(parent,
                  overlayList,
                  displayCtx,
                  frame,
                  *args,
                  **kwargs)

Warning

Do not define a control (a.k.a. secondary) panel constructor to accept arguments with the names floatPane, floatOnly, floatPos, closeable, or location, as arguments with those names will get eaten by this method before they can be passed to the constructor.

__layoutNewPanel(panel, title, location, floatPane, floatPos, floatOnly, closeable)

Sub-method of togglePanel(). Creates and returns an AuiPaneInfo instance describing the initial layout of a new control panel. See togglePanel for an explanation of the arguments.

isPanelOpen(panelType)

Returns True if a panel of type panelType is open, False otherwise.

getPanel(panelType)

If an instance of panelType exists, it is returned. Otherwise None is returned.

removeAllPanels()

Remove all control panels from this ViewPanel.

removeFromFrame()

Remove this ViewPanel from the FSLeyesFrame.

Will raise an error if this ViewPanel is not in a FSLeyesFrame.

getPanels()

Returns a list containing all control panels currently shown in this ViewPanel.

getPanelInfo(panel)

Returns the AuiPaneInfo object which contains information about the given control panel.

property auiManager

Returns the wx.lib.agw.aui.AuiManager object which manages the layout of this ViewPanel.

getTools()

This method should be overridden by sub-classes (if necessary), and should return any action methods which should be added to the FSLeyesFrame Tools menu.

See also the ActionProvider.getActions() method, which can also be overridden, and controls the actions which get added to the FSLeyes settings menu.

__auiMgrUpdate(*args, **kwargs)

Called whenever a panel is added/removed to/from this ViewPanel.

Calls the Update method on the AuiManager instance that is managing this panel.

Parameters:

newPanel – Must be passed as a keyword argument. When a new panel is added, it should be passed here.

__onPaneClose(ev=None, panel=None)

Called when the user closes a control (a.k.a. secondary) panel. Calls the ControlPanel.destroy/ControlToolBar.destroy method on the panel.

__onPerspectiveChange(ev)

Called on EVT_AUI_PERSPECTIVE_CHANGED events. Re-emits the event via the events() notifier, with topic 'aui_perspective'. This is performed for the benefit of non-wx entities which need to know about layout changes.

__annotations__ = {}

__module__ = 'fsleyes.views.viewpanel'