bdv.viewer

Class ViewerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

bdv.viewer.AbstractViewerPanel

bdv.viewer.ViewerPanel

All Implemented Interfaces:

OverlayRenderer, PainterThread.Paintable, RequestRepaint, ViewerStateChangeListener, ImageObserver, MenuContainer, Serializable, Accessible

public class ViewerPanel
extends AbstractViewerPanel
implements OverlayRenderer, PainterThread.Paintable, ViewerStateChangeListener

A JPanel for viewing multiple of Sources. The panel contains a canvas and a time slider (if there are multiple time-points). Maintains a render state, the renderer, and basic navigation help overlays. It has it's own PainterThread for painting, which is started on construction (use to stop the PainterThread.

Author:

Tobias Pietzsch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ViewerPanel.RenderThreadFactory

Nested classes/interfaces inherited from class bdv.viewer.AbstractViewerPanel

AbstractViewerPanel.AlignPlane, AbstractViewerPanel.MouseCoordinateListener

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static AtomicInteger	panelNumber

Fields inherited from class bdv.viewer.AbstractViewerPanel

mouseCoordinates

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ViewerPanel(List<SourceAndConverter<?>> sources, int numTimePoints, CacheControl cacheControl)
ViewerPanel(List<SourceAndConverter<?>> sources, int numTimepoints, CacheControl cacheControl, ViewerOptions optional)

Method Summary

Modifier and Type	Method and Description
void	addGroup(SourceGroup group) Deprecated. Modify state() directly
void	addInterpolationModeListener(InterpolationModeListener listener) Deprecated. Use interpolationModeListeners().add( listener ).
void	addOverlayAnimator(OverlayAnimator animator) Add a new OverlayAnimator to the list of animators.
void	addRenderTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener) Deprecated. Use renderTransformListeners().add( listener ).
void	addRenderTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener, int index) Deprecated. Use renderTransformListeners().add( index, listener ).
void	addSource(SourceAndConverter<?> sourceAndConverter) Deprecated. Modify state() directly
void	addSources(Collection<SourceAndConverter<?>> sourceAndConverter) Deprecated. Modify state() directly
void	addTimePointListener(TimePointListener listener) Deprecated. Use timePointListeners().add( listener ).
void	addTimePointListener(TimePointListener listener, int index) Deprecated. Use timePointListeners().add( index, listener ).
void	addTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener) Deprecated. Use transformListeners().add( listener ).
void	addTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener, int index) Deprecated. Use transformListeners().add( index, listener ).
void	displayToGlobalCoordinates(double[] gPos) Set gPos to the display coordinates at gPos transformed into the global coordinate system.
void	displayToGlobalCoordinates(double x, double y, net.imglib2.RealPositionable gPos) Set gPos to the display coordinates (x,y,0)T transformed into the global coordinate system.
<P extends net.imglib2.RealLocalizable & net.imglib2.RealPositionable> void	displayToGlobalCoordinates(P gPos) Set gPos to the display coordinates at gPos transformed into the global coordinate system.
void	drawOverlays(Graphics g) Render overlays.
InteractiveDisplayCanvas	getDisplay() Get the viewer canvas.
Component	getDisplayComponent() Get the AWT Component of the viewer canvas.
org.scijava.ui.behaviour.io.InputTriggerConfig	getInputTriggerConfig()
ViewerOptions.Values	getOptionValues()
SourceInfoOverlayRenderer	getSourceInfoOverlayRenderer()
ViewerState	getState() Deprecated. Use state() instead. Get a copy of the current ViewerState.
TransformEventHandler	getTransformEventHandler()
VisibilityAndGrouping	getVisibilityAndGrouping() Deprecated. Modify state() directly Returns the VisibilityAndGrouping that can be used to modify visibility and currentness of sources and groups, as well as grouping of sources, and display mode.
org.scijava.listeners.Listeners<InterpolationModeListener>	interpolationModeListeners() Add/remove InterpolationModeListener to notify when the interpolation mode is changed..
void	nextTimePoint() Show the next time-point.
protected void	onMouseMoved()
void	paint() This is called by the painter thread to repaint the display.
void	previousTimePoint() Show the previous time-point.
void	removeAllSources() Deprecated. Modify state() directly
void	removeGroup(SourceGroup group) Deprecated. Modify state() directly
void	removeInterpolationModeListener(InterpolationModeListener listener) Deprecated. Use interpolationModeListeners().remove( listener ).
void	removeSource(Source<?> source) Deprecated. Modify state() directly
void	removeSources(Collection<Source<?>> sources) Deprecated. Modify state() directly
void	removeTimePointListener(TimePointListener listener) Deprecated. Use timePointListeners().remove( listener ).
void	removeTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener) Deprecated. Use transformListeners().remove( listener ) or renderTransformListeners().remove( listener ) (whichever the listener was added to).
org.scijava.listeners.Listeners<TransformListener<net.imglib2.realtransform.AffineTransform3D>>	renderTransformListeners() Add/remove TransformListeners to notify about viewer transformation changes.
void	requestRepaint() Repaint as soon as possible.
void	requestRepaint(net.imglib2.Interval screenInterval)
void	setCurrentViewerTransform(net.imglib2.realtransform.AffineTransform3D viewerTransform) Deprecated. Modify state() directly (state().setViewerTransform(t))
void	setDisplayMode(DisplayMode displayMode) Set the DisplayMode.
void	setInterpolation(Interpolation mode) Set the Interpolation mode.
void	setNumTimepoints(int numTimepoints) Set the number of available timepoints.
void	setTimepoint(int timepoint) Show the specified time-point.
void	setTransformAnimator(AbstractTransformAnimator animator)
DebugTilingOverlay	showDebugTileOverlay() Display overlay to show how the display is tiled for rendering.
void	showMessage(String msg) Display the specified message in a text overlay for a short time.
SynchronizedViewerState	state() Get the ViewerState.
void	stateFromXml(org.jdom2.Element parent)
org.jdom2.Element	stateToXml()
void	stop() Stop the painterThread and shutdown rendering ExecutorService.
org.scijava.listeners.Listeners<TimePointListener>	timePointListeners() Add/remove TimePointListener to notify about time-point changes.
void	toggleInterpolation() Switch to next interpolation mode.
org.scijava.listeners.Listeners<TransformListener<net.imglib2.realtransform.AffineTransform3D>>	transformListeners() Add/remove TransformListeners to notify about viewer transformation changes.
void	viewerStateChanged(ViewerStateChange change)

Methods inherited from class bdv.viewer.AbstractViewerPanel

align, getGlobalMouseCoordinates, getMouseCoordinates, requestFocusInWindow

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface bdv.viewer.OverlayRenderer

setCanvasSize

Field Detail

panelNumber

protected static final AtomicInteger panelNumber

Constructor Detail

ViewerPanel

public ViewerPanel(List<SourceAndConverter<?>> sources,
                   int numTimePoints,
                   CacheControl cacheControl)

ViewerPanel

public ViewerPanel(List<SourceAndConverter<?>> sources,
                   int numTimepoints,
                   CacheControl cacheControl,
                   ViewerOptions optional)

Parameters:

sources - the sources to display.

numTimepoints - number of available timepoints.

cacheControl - to control IO budgeting and fetcher queue.

optional - optional parameters. See ViewerOptions.options().

Method Detail

addSource

@Deprecated
public void addSource(SourceAndConverter<?> sourceAndConverter)

Deprecated. Modify state() directly

addSources

@Deprecated
public void addSources(Collection<SourceAndConverter<?>> sourceAndConverter)

Deprecated. Modify state() directly

removeSource

@Deprecated
public void removeSource(Source<?> source)

Deprecated. Modify state() directly

removeSources

@Deprecated
public void removeSources(Collection<Source<?>> sources)

Deprecated. Modify state() directly

removeAllSources

@Deprecated
public void removeAllSources()

Deprecated. Modify state() directly

addGroup

@Deprecated
public void addGroup(SourceGroup group)

Deprecated. Modify state() directly

removeGroup

@Deprecated
public void removeGroup(SourceGroup group)

Deprecated. Modify state() directly

displayToGlobalCoordinates

public void displayToGlobalCoordinates(double[] gPos)

Set gPos to the display coordinates at gPos transformed into the global coordinate system.

Parameters:

gPos - is set to the corresponding global coordinates.

displayToGlobalCoordinates

public <P extends net.imglib2.RealLocalizable & net.imglib2.RealPositionable> void displayToGlobalCoordinates(P gPos)

Set gPos to the display coordinates at gPos transformed into the global coordinate system.

Parameters:

gPos - is set to the corresponding global coordinates.

displayToGlobalCoordinates

public void displayToGlobalCoordinates(double x,
                                       double y,
                                       net.imglib2.RealPositionable gPos)

Set gPos to the display coordinates (x,y,0)^T transformed into the global coordinate system.

Parameters:

gPos - is set to the global coordinates at display (x,y,0)^T.

paint

public void paint()

Description copied from interface: PainterThread.Paintable

This is called by the painter thread to repaint the display.

Specified by:

paint in interface PainterThread.Paintable

requestRepaint

public void requestRepaint()

Repaint as soon as possible.

Specified by:

requestRepaint in interface RequestRepaint

requestRepaint

public void requestRepaint(net.imglib2.Interval screenInterval)

onMouseMoved

protected void onMouseMoved()

Overrides:

onMouseMoved in class AbstractViewerPanel

drawOverlays

public void drawOverlays(Graphics g)

Description copied from interface: OverlayRenderer

Render overlays.

Specified by:

drawOverlays in interface OverlayRenderer

viewerStateChanged

public void viewerStateChanged(ViewerStateChange change)

Specified by:

viewerStateChanged in interface ViewerStateChangeListener

setTransformAnimator

public void setTransformAnimator(AbstractTransformAnimator animator)

Specified by:

setTransformAnimator in class AbstractViewerPanel

toggleInterpolation

public void toggleInterpolation()

Switch to next interpolation mode. (Currently, there are two interpolation modes: nearest-neighbor and N-linear.)

setInterpolation

public void setInterpolation(Interpolation mode)

Set the Interpolation mode.

setDisplayMode

public void setDisplayMode(DisplayMode displayMode)

Set the DisplayMode.

setCurrentViewerTransform

@Deprecated
public void setCurrentViewerTransform(net.imglib2.realtransform.AffineTransform3D viewerTransform)

Deprecated. Modify state() directly (state().setViewerTransform(t))

setTimepoint

public void setTimepoint(int timepoint)

Show the specified time-point.

Parameters:

timepoint - time-point index.

nextTimePoint

public void nextTimePoint()

Show the next time-point.

previousTimePoint

public void previousTimePoint()

Show the previous time-point.

setNumTimepoints

public void setNumTimepoints(int numTimepoints)

Set the number of available timepoints. If numTimepoints == 1 this will hide the time slider, otherwise show it. If the currently displayed timepoint would be out of range with the new number of timepoints, the current timepoint is set to numTimepoints - 1.

This is equivalent to state().setNumTimepoints(numTimepoints}.

Parameters:

numTimepoints - number of available timepoints. Must be >= 1.

getState

@Deprecated
public ViewerState getState()

Deprecated. Use state() instead. Get a copy of the current ViewerState.

Returns:

a copy of the current ViewerState.

state

public SynchronizedViewerState state()

Get the ViewerState. This can be directly used for modifications, e.g., adding/removing sources etc. See SynchronizedViewerState for thread-safety considerations.

Specified by:

state in class AbstractViewerPanel

getDisplay

public InteractiveDisplayCanvas getDisplay()

Get the viewer canvas.

Specified by:

getDisplay in class AbstractViewerPanel

Returns:

the viewer canvas.

getDisplayComponent

public Component getDisplayComponent()

Get the AWT Component of the viewer canvas.

Specified by:

getDisplayComponent in class AbstractViewerPanel

Returns:

the viewer canvas.

getTransformEventHandler

public TransformEventHandler getTransformEventHandler()

showMessage

public void showMessage(String msg)

Display the specified message in a text overlay for a short time.

Specified by:

showMessage in class AbstractViewerPanel

Parameters:

msg - String to display. Should be just one line of text.

addOverlayAnimator

public void addOverlayAnimator(OverlayAnimator animator)

Add a new OverlayAnimator to the list of animators. The animation is immediately started. The new OverlayAnimator will remain in the list of animators until it OverlayAnimator.isComplete().

Specified by:

addOverlayAnimator in class AbstractViewerPanel

Parameters:

animator - animator to add.

interpolationModeListeners

public org.scijava.listeners.Listeners<InterpolationModeListener> interpolationModeListeners()

Add/remove InterpolationModeListener to notify when the interpolation mode is changed.. Listeners will be notified before calling requestRepaint() so they have the chance to interfere.

addInterpolationModeListener

@Deprecated
public void addInterpolationModeListener(InterpolationModeListener listener)

Deprecated. Use interpolationModeListeners().add( listener ).

removeInterpolationModeListener

@Deprecated
public void removeInterpolationModeListener(InterpolationModeListener listener)

Deprecated. Use interpolationModeListeners().remove( listener ).

renderTransformListeners

public org.scijava.listeners.Listeners<TransformListener<net.imglib2.realtransform.AffineTransform3D>> renderTransformListeners()

Add/remove TransformListeners to notify about viewer transformation changes. Listeners will be notified when a new image has been painted with the viewer transform used to render that image.

This happens immediately after that image is painted onto the screen, before any overlays are painted.

Specified by:

renderTransformListeners in class AbstractViewerPanel

addRenderTransformListener

@Deprecated
public void addRenderTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener)

Deprecated. Use renderTransformListeners().add( listener ).

addRenderTransformListener

@Deprecated
public void addRenderTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener,
                                                   int index)

Deprecated. Use renderTransformListeners().add( index, listener ).

transformListeners

public org.scijava.listeners.Listeners<TransformListener<net.imglib2.realtransform.AffineTransform3D>> transformListeners()

Add/remove TransformListeners to notify about viewer transformation changes. Listeners will be notified before calling requestRepaint() so they have the chance to interfere.

Specified by:

transformListeners in class AbstractViewerPanel

addTransformListener

@Deprecated
public void addTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener)

Deprecated. Use transformListeners().add( listener ).

addTransformListener

@Deprecated
public void addTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener,
                                             int index)

Deprecated. Use transformListeners().add( index, listener ).

removeTransformListener

@Deprecated
public void removeTransformListener(TransformListener<net.imglib2.realtransform.AffineTransform3D> listener)

Deprecated. Use transformListeners().remove( listener ) or renderTransformListeners().remove( listener ) (whichever the listener was added to).

timePointListeners

public org.scijava.listeners.Listeners<TimePointListener> timePointListeners()

Add/remove TimePointListener to notify about time-point changes. Listeners will be notified before calling requestRepaint() so they have the chance to interfere.

addTimePointListener

@Deprecated
public void addTimePointListener(TimePointListener listener)

Deprecated. Use timePointListeners().add( listener ).

addTimePointListener

@Deprecated
public void addTimePointListener(TimePointListener listener,
                                             int index)

Deprecated. Use timePointListeners().add( index, listener ).

removeTimePointListener

@Deprecated
public void removeTimePointListener(TimePointListener listener)

Deprecated. Use timePointListeners().remove( listener ).

stateToXml

public org.jdom2.Element stateToXml()

stateFromXml

public void stateFromXml(org.jdom2.Element parent)

getVisibilityAndGrouping

@Deprecated
public VisibilityAndGrouping getVisibilityAndGrouping()

Deprecated. Modify state() directly Returns the VisibilityAndGrouping that can be used to modify visibility and currentness of sources and groups, as well as grouping of sources, and display mode.

getOptionValues

public ViewerOptions.Values getOptionValues()

getInputTriggerConfig

public org.scijava.ui.behaviour.io.InputTriggerConfig getInputTriggerConfig()

Specified by:

getInputTriggerConfig in class AbstractViewerPanel

getSourceInfoOverlayRenderer

public SourceInfoOverlayRenderer getSourceInfoOverlayRenderer()

stop

public void stop()

Stop the painterThread and shutdown rendering ExecutorService.

showDebugTileOverlay

public DebugTilingOverlay showDebugTileOverlay()

Display overlay to show how the display is tiled for rendering. (For development and debugging purposes.)