fsleyes.displaycontext.sceneopts

This module provides the SceneOpts class, which contains display settings used by CanvasPanel instances.

class fsleyes.displaycontext.sceneopts.SceneOpts(panel)[source]

Bases: __main__.docbuilder.run.<locals>.MockClass

The SceneOpts class defines settings which are used by CanvasPanel instances.

Several of the properties of the SceneOpts class are defined in the SliceCanvasOpts class, so see its documentation for more details.

showCursor = <MagicMock name='mock.Boolean()' id='139881573090064'>
zoom = <MagicMock name='mock.Percentage()' id='139881574468624'>
bgColour = <MagicMock name='mock.Colour()' id='139881574468816'>
cursorColour = <MagicMock name='mock.Colour()' id='139881574476592'>
renderMode = <MagicMock name='mock.Choice()' id='139881574476640'>
highDpi = <MagicMock name='mock.Boolean()' id='139881574476688'>
fgColour = <MagicMock name='mock.Colour()' id='139881574128016'>

Colour to use for foreground items (e.g. labels).

Note

This colour is automatically updated whenever the bgColour is changed. But it can be modified independently.

showColourBar = <MagicMock name='mock.Boolean()' id='139881574968736'>

If True, and it is possible to do so, a colour bar is shown on the scene.

colourBarLocation = <MagicMock name='mock.Choice()' id='139881574868272'>

This property controls the location of the colour bar, if it is being shown.

colourBarLabelSide = <MagicMock name='mock.Choice()' id='139881574868272'>

This property controls the location of the colour bar labels, relative to the colour bar, if it is being shown.

colourBarSize = <MagicMock name='mock.Percentage()' id='139881574389488'>

Size of the major axis of the colour bar, as a proportion of the available space.

labelSize = <MagicMock name='mock.Int()' id='139881574289696'>

Font size used for any labels drawn on the canvas, including orthographic labels, and colour bar labels.

performance = <MagicMock name='mock.Choice()' id='139881574868272'>

User controllable performance setting.

This property is linked to the renderMode property. Setting this property to a low value will result in faster rendering time, at the cost of increased memory usage and poorer rendering quality.

See the __onPerformanceChange() method.

__annotations__ = {}
__module__ = 'fsleyes.displaycontext.sceneopts'
__init__(panel)[source]

Create a SceneOpts instance.

This method simply links the performance property to the renderMode property.

movieSyncRefresh = <MagicMock name='mock.Boolean()' id='139881574968736'>

Whether, when in movie mode, to synchronise the refresh for GL canvases. This is not possible in some platforms/environments. See CanvasPanel.movieSyncRefresh.

property defaultMovieSyncRefresh

In movie mode, the canvas refreshes are performed by the __syncMovieRefresh or __unsyncMovieRefresh methods of the CanvasPanel class. Some platforms/GL drivers/environments seem to have a problem with separate renders/buffer swaps, so we have to use a shitty unsynchronised update routine.

These heuristics are not perfect - the movieSyncRefresh property can therefore be overridden by the user.

property panel

Return a reference to the CanvasPanel that owns this SceneOpts instance.

_onPerformanceChange(*a)[source]

Called when the performance property changes.

This method must be overridden by sub-classes to change the values of the renderMode property according to the new performance setting.

__onBgColourChange(*a)

Called when the background colour changes. Updates the fgColour to a complementary colour.