fsleyes.controls.canvassettingspanel

This module provides the CanvasSettingsPanel class, a FSLeyes control panel which displays settings for a CanvasPanel.

class fsleyes.controls.canvassettingspanel.CanvasSettingsPanel(parent, overlayList, displayCtx, canvasPanel)

Bases: fsleyes.controls.controlpanel.SettingsPanel

The CanvasSettingsPanel is a FSLeyes control which displays settings for a CanvasPanel instance. A CanvasSettingsPanel looks something like this:

The CanvasSettingsPanel displays controls which modify properties on the following classes:

CanvasPanel	The CanvasPanel class is a ViewPanel which is the base class for all panels which display overlays using OpenGL (e.g.
SceneOpts	The SceneOpts class defines settings which are used by CanvasPanel instances.
OrthoOpts	The OrthoOpts class is used by OrthoPanel instances to manage their display settings.
LightBoxOpts	The LightBoxOpts class contains display settings for the LightBoxPanel class.
Scene3DOpts	The Scene3DOpts class contains display settings for the Scene3DPanel class.

The CanvasSettingsPanel divides the displayed settings into those which are common to all CanvasPanel instances, and those which are specific to the CanvasPanel sub-class (i.e. OrthoPanel, LightBoxPanel, or Scene3DPanel).

static supportedViews()

Overrides ControlMixin.supportedViews(). The CanvasSettingsPanel is only intended to be added to OrthoPanel, LightBoxPanel, or Scene3DPanel views.

static defaultLayout()

Returns a dictionary of settings to be passed to the ViewPanel.togglePanel() method.

__init__(parent, overlayList, displayCtx, canvasPanel)

Create a CanvasSettingsPanel.

Parameters

• parent – The wx parent object

• overlayList – The OverlayList instance.

• displayCtx – The DisplayContext instance.

• canvasPanel – The CanvasPanel instance.

destroy()

Must be called when this CanvasSettingsPanel is no longer needed. Clears references and calls the base class destroy method.

__makeTools()

__module__ = 'fsleyes.controls.canvassettingspanel'

fsleyes.controls.canvassettingspanel._genLightPosWidget(parent, opts)

Generates a widget for the Scene3DOpts.lightPos property.