bdv.viewer

Class ViewerOptions

java.lang.Object

bdv.viewer.ViewerOptions

public class ViewerOptions
extends Object

Optional parameters for ViewerPanel.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewerOptions.Values Read-only ViewerOptions values.

Field Summary

Fields

Modifier and Type	Field and Description
ViewerOptions.Values	values

Constructor Summary

Constructors

Constructor and Description
ViewerOptions()

Method Summary

Modifier and Type	Method and Description
ViewerOptions	accumulateProjectorFactory(AccumulateProjectorFactory<net.imglib2.type.numeric.ARGBType> f) Set the factory for creating AccumulateProjector.
ViewerOptions	appearanceManager(AppearanceManager appearanceManager) Set the AppearanceManager to share appearance settings with other BigDataViewer windows.
ViewerOptions	height(int h) Set height of ViewerPanel canvas.
ViewerOptions	inputTriggerConfig(org.scijava.ui.behaviour.io.InputTriggerConfig c) Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.
ViewerOptions	is2D(boolean is2D) Set up the BigDataViewer for 2D navigation.
ViewerOptions	keymapManager(KeymapManager keymapManager) Set the KeymapManager to share keymap settings with other BigDataViewer windows.
ViewerOptions	msgOverlay(MessageOverlayAnimator o)
ViewerOptions	numRenderingThreads(int n) Set how many threads to use for rendering.
ViewerOptions	numSourceGroups(int n) Set how many source groups there are initially.
static ViewerOptions	options() Create default ViewerOptions.
ViewerOptions	screenScales(double[] s) Set the number and scale factors for scaled screen images.
ViewerOptions	shareKeyPressedEvents(org.scijava.ui.behaviour.KeyPressedManager manager) Set the KeyPressedManager to share KeyListener.keyPressed(java.awt.event.KeyEvent) events with other ui-behaviour windows.
ViewerOptions	targetRenderNanos(long t) Set target rendering time in nanoseconds.
ViewerOptions	transformEventHandlerFactory(TransformEventHandlerFactory f)
ViewerOptions	useVolatileIfAvailable(boolean v) Set whether volatile versions of sources should be used if available.
ViewerOptions	width(int w) Set width of ViewerPanel canvas.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

values

public final ViewerOptions.Values values

Constructor Detail

ViewerOptions

public ViewerOptions()

Method Detail

options

public static ViewerOptions options()

Create default ViewerOptions.

Returns:

default ViewerOptions.

width

public ViewerOptions width(int w)

Set width of ViewerPanel canvas.

height

public ViewerOptions height(int h)

Set height of ViewerPanel canvas.

screenScales

public ViewerOptions screenScales(double[] s)

Set the number and scale factors for scaled screen images.

Parameters:

s - Scale factors from the viewer canvas to screen images of different resolutions. A scale factor of 1 means 1 pixel in the screen image is displayed as 1 pixel on the canvas, a scale factor of 0.5 means 1 pixel in the screen image is displayed as 2 pixel on the canvas, etc.

See Also:

MultiResolutionRenderer

targetRenderNanos

public ViewerOptions targetRenderNanos(long t)

Set target rendering time in nanoseconds.

Parameters:

t - Target rendering time in nanoseconds. The rendering time for the coarsest rendered scale should be below this threshold.

See Also:

MultiResolutionRenderer

numRenderingThreads

public ViewerOptions numRenderingThreads(int n)

Set how many threads to use for rendering.

Parameters:

n - How many threads to use for rendering.

See Also:

MultiResolutionRenderer

numSourceGroups

public ViewerOptions numSourceGroups(int n)

Set how many source groups there are initially.

Parameters:

n - How many source groups to create initially.

useVolatileIfAvailable

public ViewerOptions useVolatileIfAvailable(boolean v)

Set whether volatile versions of sources should be used if available.

Parameters:

v - whether volatile versions of sources should be used if available.

See Also:

MultiResolutionRenderer

msgOverlay

public ViewerOptions msgOverlay(MessageOverlayAnimator o)

transformEventHandlerFactory

public ViewerOptions transformEventHandlerFactory(TransformEventHandlerFactory f)

is2D

public ViewerOptions is2D(boolean is2D)

Set up the BigDataViewer for 2D navigation. Note, that Sources still need to provide 3D stacks, etc. This option only prevents out-of-plane movement.

Parameters:

is2D - whether to restrict navigation to 2D (default is false).

accumulateProjectorFactory

public ViewerOptions accumulateProjectorFactory(AccumulateProjectorFactory<net.imglib2.type.numeric.ARGBType> f)

Set the factory for creating AccumulateProjector. This can be used to customize how sources are combined.

Parameters:

f - factory for creating AccumulateProjector.

See Also:

MultiResolutionRenderer

inputTriggerConfig

public ViewerOptions inputTriggerConfig(org.scijava.ui.behaviour.io.InputTriggerConfig c)

Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.

Note that this will override the managed InputTriggerConfig, that is, modifying the keymap through the preferences dialog will have no effect.

Parameters:

c - the InputTriggerConfig from which keyboard and mouse action mapping is loaded

shareKeyPressedEvents

public ViewerOptions shareKeyPressedEvents(org.scijava.ui.behaviour.KeyPressedManager manager)

Set the KeyPressedManager to share KeyListener.keyPressed(java.awt.event.KeyEvent) events with other ui-behaviour windows.

The goal is to make keyboard click/drag behaviours work like mouse click/drag: When a behaviour is initiated with a key press, the window under the mouse receives focus and the behaviour is handled there.

Parameters:

manager -

Returns:

keymapManager

public ViewerOptions keymapManager(KeymapManager keymapManager)

Set the KeymapManager to share keymap settings with other BigDataViewer windows.

This can be used to link multiple BigDataViewer windows such that they use (and modify) the same Keymap, shortcuts and mouse gestures.

appearanceManager

public ViewerOptions appearanceManager(AppearanceManager appearanceManager)

Set the AppearanceManager to share appearance settings with other BigDataViewer windows.

This can be used to link multiple BigDataViewer windows such that they use (and modify) the same Appearance settings, e.g., LookAndFeel, scalebar overlay settings, etc.