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, frame, canvasPanel)¶ Bases:
fsleyes.controls.controlpanel.SettingsPanel
The
CanvasSettingsPanel
is a FSLeyes control which displays settings for aCanvasPanel
instance. ACanvasSettingsPanel
looks something like this:The
CanvasSettingsPanel
displays controls which modify properties on the following classes:CanvasPanel
The CanvasPanel
class is aViewPanel
which is the base class for all panels which display overlays usingOpenGL
(e.g.SceneOpts
The SceneOpts
class defines settings which are used byCanvasPanel
instances.OrthoOpts
The OrthoOpts
class is used byOrthoPanel
instances to manage their display settings.LightBoxOpts
The LightBoxOpts
class contains display settings for theLightBoxPanel
class.Scene3DOpts
The Scene3DOpts
class contains display settings for theScene3DPanel
class.The
CanvasSettingsPanel
divides the displayed settings into those which are common to allCanvasPanel
instances, and those which are specific to theCanvasPanel
sub-class (i.e.OrthoPanel
,LightBoxPanel
, orScene3DPanel
).-
__init__
(parent, overlayList, displayCtx, frame, canvasPanel)¶ Create a
CanvasSettingsPanel
.Parameters: - parent – The
wx
parent object - overlayList – The
OverlayList
instance. - displayCtx – The
DisplayContext
instance. - frame – The
FSLeyesFrame
instance. - canvasPanel – The
CanvasPanel
instance.
- parent – The
-
destroy
()¶ Must be called when this
CanvasSettingsPanel
is no longer needed. Clears references and calls the base classdestroy
method.
-
static
supportedViews
()¶ Overrides
ControlMixin.supportedViews()
. TheCanvasSettingsPanel
is only intended to be added toOrthoPanel
,LightBoxPanel
, orScene3DPanel
views.
-
_CanvasSettingsPanel__makeTools
()¶
-
__module__
= 'fsleyes.controls.canvassettingspanel'¶
-