bvv.core

Class VolumeViewerOptions

java.lang.Object

bvv.core.VolumeViewerOptions

public class VolumeViewerOptions
extends Object

Optional parameters for VolumeViewerPanel.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
VolumeViewerOptions.Values	values

Constructor Summary

Constructors

Constructor and Description
VolumeViewerOptions()

Method Summary

Modifier and Type	Method and Description
VolumeViewerOptions	appearanceManager(bdv.ui.appearance.AppearanceManager appearanceManager) Set the AppearanceManager to share appearance settings with other BigVolumeViewer windows.
VolumeViewerOptions	cacheBlockSize(int s) Sets the GPU cache tile size.
VolumeViewerOptions	cacheBlockSize(int[] s) Sets the GPU cache tile size.
VolumeViewerOptions	dCam(double d) Sets the distance from the camera to the z=0 plane.
VolumeViewerOptions	dClip(double d)
VolumeViewerOptions	dClipFar(double d) Sets the visible distance from the z=0 plane away from the camera.
VolumeViewerOptions	dClipNear(double d) Sets the visible distance from the z=0 plane towards the camera.
VolumeViewerOptions	ditherWidth(int w) Sets the dither window width.
VolumeViewerOptions	height(int h) Set height of VolumeViewerPanel canvas.
VolumeViewerOptions	inputTriggerConfig(org.scijava.ui.behaviour.io.InputTriggerConfig c) Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.
VolumeViewerOptions	keymapManager(bdv.ui.keymap.KeymapManager keymapManager) Set the KeymapManager to share keymap settings with other BigVolumeViewer windows.
VolumeViewerOptions	maxAllowedStepInVoxels(double s)
VolumeViewerOptions	maxCacheSizeInMB(int s) Sets the max memory to use for the GPU cache texture in MB.
VolumeViewerOptions	maxRenderMillis(int t) Set target per-frame time in milliseconds.
VolumeViewerOptions	msgOverlay(bdv.viewer.animate.MessageOverlayAnimator o)
VolumeViewerOptions	numDitherSamples(int n) Sets the number of dither samples.
VolumeViewerOptions	numSourceGroups(int n) Set how many source groups there are initially.
static VolumeViewerOptions	options() Create default VolumeViewerOptions.
VolumeViewerOptions	renderHeight(int h) Sets the height of offscreen canvas.
VolumeViewerOptions	renderWidth(int w) Sets the width of offscreen canvas.
VolumeViewerOptions	shareKeyPressedEvents(org.scijava.ui.behaviour.KeyPressedManager manager) Set the KeyPressedManager to share KeyListener.keyPressed(java.awt.event.KeyEvent) events with other ui-behaviour windows.
VolumeViewerOptions	transformEventHandlerFactory(bdv.TransformEventHandlerFactory f)
VolumeViewerOptions	width(int w) Set width of VolumeViewerPanel canvas.

Methods inherited from class java.lang.Object

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

Field Detail

values

public final VolumeViewerOptions.Values values

Constructor Detail

VolumeViewerOptions

public VolumeViewerOptions()

Method Detail

options

public static VolumeViewerOptions options()

Create default VolumeViewerOptions.

Returns:

default VolumeViewerOptions.

width

public VolumeViewerOptions width(int w)

Set width of VolumeViewerPanel canvas.

height

public VolumeViewerOptions height(int h)

Set height of VolumeViewerPanel canvas.

renderWidth

public VolumeViewerOptions renderWidth(int w)

Sets the width of offscreen canvas.

Parameters:

w - the width.

Returns:

this instance.

renderHeight

public VolumeViewerOptions renderHeight(int h)

Sets the height of offscreen canvas.

Parameters:

h - the height.

Returns:

this instance.

maxRenderMillis

public VolumeViewerOptions maxRenderMillis(int t)

Set target per-frame time in milliseconds.

Parameters:

t - Target rendering time in milliseconds.

ditherWidth

public VolumeViewerOptions ditherWidth(int w)

Sets the dither window width. E.g., w=3 means 3x3 dither window size.

Parameters:

w - dither window width.

Returns:

this instance.

numDitherSamples

public VolumeViewerOptions numDitherSamples(int n)

Sets the number of dither samples. Pixels are interpolated from this many nearest neighbors when dithering.

Parameters:

n - the number of dither samples.

Returns:

this instance.

cacheBlockSize

public VolumeViewerOptions cacheBlockSize(int[] s)

Sets the GPU cache tile size. (not padded)

Parameters:

s - the cache tile size.

Returns:

this instance

cacheBlockSize

public VolumeViewerOptions cacheBlockSize(int s)

Sets the GPU cache tile size. (not padded)

Parameters:

s - the cache tile size.

Returns:

this instance

maxCacheSizeInMB

public VolumeViewerOptions maxCacheSizeInMB(int s)

Sets the max memory to use for the GPU cache texture in MB. The size of the GPU cache texture will match this as close as possible with the given tile size.

Parameters:

s - the GPU cache size in MB.

Returns:

this instance.

dCam

public VolumeViewerOptions dCam(double d)

Sets the distance from the camera to the z=0 plane. In units of screen pixel width.

Parameters:

d - camera distance.

Returns:

this instance.

dClipNear

public VolumeViewerOptions dClipNear(double d)

Sets the visible distance from the z=0 plane towards the camera. In units of screen pixel width. (Should be smaller than camera distance.)

Parameters:

d - visible distance from z=0 towards camera.

Returns:

this instance.

dClipFar

public VolumeViewerOptions dClipFar(double d)

Sets the visible distance from the z=0 plane away from the camera. In units of screen pixel width.

Parameters:

d - visible distance from z=0 away from camera.

Returns:

this instance.

dClip

public VolumeViewerOptions dClip(double d)

maxAllowedStepInVoxels

public VolumeViewerOptions maxAllowedStepInVoxels(double s)

numSourceGroups

public VolumeViewerOptions numSourceGroups(int n)

Set how many source groups there are initially.

Parameters:

n - How many source groups to create initially.

msgOverlay

public VolumeViewerOptions msgOverlay(bdv.viewer.animate.MessageOverlayAnimator o)

transformEventHandlerFactory

public VolumeViewerOptions transformEventHandlerFactory(bdv.TransformEventHandlerFactory f)

inputTriggerConfig

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

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

Parameters:

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

shareKeyPressedEvents

public VolumeViewerOptions 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 VolumeViewerOptions keymapManager(bdv.ui.keymap.KeymapManager keymapManager)

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

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

appearanceManager

public VolumeViewerOptions appearanceManager(bdv.ui.appearance.AppearanceManager appearanceManager)

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

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