icy.canvas

Class Canvas2D

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

icy.canvas.IcyCanvas

icy.canvas.IcyCanvas2D

icy.canvas.Canvas2D

All Implemented Interfaces:

Layer.LayerListener, ChangeListener, ROITask.ROITaskListener, ViewerListener, LUTListener, SequenceListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class Canvas2D
extends IcyCanvas2D
implements ROITask.ROITaskListener

New Canvas 2D : default ICY 2D viewer.
Support translation / scale and rotation transformation.

Author:

Stephane

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Canvas2D.CanvasMap
class	Canvas2D.CanvasView

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class icy.canvas.IcyCanvas

PROPERTY_LAYERS_VISIBLE

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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
Canvas2D(Viewer viewer)

Method Summary

Methods

Modifier and Type	Method and Description
void	centerOn(java.awt.Rectangle region) Adjust view position and possibly scaling factor to ensure the specified region become visible.
void	centerOnImage(double x, double y) Center image on specified image position in canvas
void	changed(IcyCanvasEvent event) canvas changed (packed event).
void	customizeToolbar(javax.swing.JToolBar toolBar) Called by the parent viewer when building the toolbar.
void	fitCanvasToImage() Change canvas size (so viewer size) to get it fit with image dimension if possible
void	fitImageToCanvas() Change scale so image fit in canvas view dimension
void	fitImageToCanvas(boolean smooth) Change zoom so image fit in canvas view dimension
java.awt.image.BufferedImage	getARGBImage(int t, int z, int c, java.awt.image.BufferedImage out) Return an ARGB BufferedImage form of the image located at position [T, Z, C].
java.awt.Color	getBackgroundColor() Returns the background color
Canvas2D.CanvasMap	getCanvasMap() Return the Canvas2D.CanvasMap component of Canvas2D.
Canvas2DSettingPanel	getCanvasSettingPanel()
Canvas2D.CanvasView	getCanvasView() Return the Canvas2D.CanvasView component of Canvas2D.
int	getDestImageCanvasSizeX() Get destination image size X in canvas pixel coordinate
int	getDestImageCanvasSizeY() Get destination image size Y in canvas pixel coordinate
boolean	getFitToCanvas()
int	getOffsetX() X offset
int	getOffsetY() Y offset
java.awt.image.BufferedImage	getRenderedImage(int t, int z) Deprecated. Use getRenderedImage(t, z, -1, true) instead.
java.awt.image.BufferedImage	getRenderedImage(int t, int z, boolean canvasView) Deprecated. Use getRenderedImage(t, z, -1, canvasView) instead.
java.awt.image.BufferedImage	getRenderedImage(int t, int z, int c, boolean cv) Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
double	getRotation() We want angle to be in [0..2*PI]
double	getRotationZ() Z rotation angle (radian)
double	getScaleX() X scale factor
double	getScaleY() Y scale factor
java.awt.Component	getViewComponent()
double	getZoomFactor() Deprecated. use getScaleX() or getScaleY() instead
boolean	isBackgroundColorEnabled() Returns the background color enabled state
boolean	isSynchronizationSupported() Return true if this canvas support synchronization
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	refresh() Force canvas refresh
void	setBackgroundColor(java.awt.Color color) Sets the background color
void	setBackgroundColorEnabled(boolean value) Sets the background color enabled state
void	setFitToCanvas(boolean value) Sets the automatic 'fit to canvas' state
void	setOffset(int x, int y, boolean smooth) Set offset X and Y.
void	setRotation(double value, boolean smooth) Set rotation angle (radian).
void	setScale(double factor, boolean center, boolean smooth) Set zoom factor (this use the smart zoom position and smooth transition).
void	setScale(double x, double y, boolean smooth) Set zoom X and Y factor.
void	setScale(double x, double y, boolean mouseCentered, boolean smooth) Set zoom X and Y factor.
void	setZoom(float zoom) Deprecated. use setScale(...) instead
void	shutDown() Called by the viewer when canvas is closed to release some resources.
void	toolChanged(java.lang.String command)

Methods inherited from class icy.canvas.IcyCanvas2D

canvasToImage, canvasToImage, canvasToImage, canvasToImage, canvasToImageDelta, canvasToImageDelta, canvasToImageLogDelta, canvasToImageLogDelta, canvasToViewer, centerImage, centerOnImage, getCanvasSize, getCanvasVisibleRect, getImageCanvasSize, getImageSize, getImageVisibleRect, getInverseTransform, getMouseImagePos, getMouseImagePosX, getMouseImagePosY, getTransform, imageToCanvas, imageToCanvas, imageToCanvas, imageToCanvas, imageToCanvasDelta, imageToCanvasDelta, setMouseCanvasPos, setMouseCanvasPos, setMouseImagePos, setMouseImagePos, setMousePos, setPositionT, setPositionZ, viewerToCanvas

Methods inherited from class icy.canvas.IcyCanvas

addCanvasListener, addLayer, addLayer, addLayerListener, addLayersListener, addViewerToolbarComponents, addVisibleLayerToList, beginUpdate, canvasToImageC, canvasToImageDeltaC, canvasToImageDeltaT, canvasToImageDeltaX, canvasToImageDeltaY, canvasToImageDeltaZ, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaZ, canvasToImageLogDeltaZ, canvasToImageT, canvasToImageX, canvasToImageY, canvasToImageZ, create, endUpdate, getC, getCanvasClassName, getCanvasClassName, getCanvasOffsetC, getCanvasOffsetT, getCanvasOffsetX, getCanvasOffsetY, getCanvasOffsetZ, getCanvasPluginNames, getCanvasPlugins, getCanvasSize, getCanvasSizeC, getCanvasSizeT, getCanvasSizeX, getCanvasSizeY, getCanvasSizeZ, getCurrentImage, getDrawLayers, getFrameRate, getImage, getImage, getImageCanvasSize, getImageCanvasSizeC, getImageCanvasSizeT, getImageCanvasSizeX, getImageCanvasSizeY, getImageCanvasSizeZ, getImageLayer, getImageOffsetC, getImageOffsetT, getImageOffsetX, getImageOffsetY, getImageOffsetZ, getImageOverlay, getImageSize, getImageSizeC, getImageSizeT, getImageSizeX, getImageSizeY, getImageSizeZ, getLayer, getLayer, getLayer, getLayerListeners, getLayers, getLayers, getLayersPainter, getListeners, getLut, getMax, getMaxC, getMaxPosition, getMaxPosition5D, getMaxPositionC, getMaxPositionT, getMaxPositionX, getMaxPositionY, getMaxPositionZ, getMaxT, getMaxX, getMaxY, getMaxZ, getMouseImageInfosPanel, getMouseImagePos, getMouseImagePos5D, getMouseImagePosC, getMouseImagePosT, getMouseImagePosZ, getMousePos, getNumSelectedSamples, getOffset, getOffset5D, getOffsetC, getOffsetT, getOffsetZ, getOrderedLayersForEvent, getOverlays, getPanel, getPluginClassName, getPosition, getPosition5D, getPositionC, getPositionT, getPositionX, getPositionY, getPositionZ, getRenderedImage, getRenderedImage, getRenderedSequence, getRenderedSequence, getRenderedSequence, getRenderedSequence, getRotation, getRotationC, getRotationT, getRotationX, getRotationY, getScale, getScaleC, getScaleFactorC, getScaleFactorT, getScaleFactorX, getScaleFactorY, getScaleFactorZ, getScaleT, getScaleZ, getSequence, getSyncId, getT, getTNavigationPanel, getViewer, getVisibleLayers, getVisibleLayers, getVisibleOrderedLayersForEvent, getZ, getZNavigationPanel, hasLayer, hasLayer, hasLayer, imageToCanvasC, imageToCanvasDeltaC, imageToCanvasDeltaT, imageToCanvasDeltaX, imageToCanvasDeltaY, imageToCanvasDeltaZ, imageToCanvasT, imageToCanvasX, imageToCanvasY, imageToCanvasZ, isLayersVisible, isSynchHeader, isSynchMaster, isSynchOnCursor, isSynchOnSlice, isSynchOnView, isSynchronized, isSynchSlave, isUpdating, isVisible, keyTyped, layerChanged, lutChanged, mouseClick, mouseClick, mouseDrag, mouseDrag, mouseEntered, mouseEntered, mouseExited, mouseExited, mouseImagePositionChanged, mouseMove, mouseMove, mousePressed, mousePressed, mouseReleased, mouseReleased, mouseWheelMoved, mouseWheelMoved, offsetChanged, onChanged, removeCanvasListener, removeLayer, removeLayer, removeLayer, removeLayerListener, removeLayersListener, rotationChanged, scaleChanged, sequenceChanged, sequenceClosed, setC, setDrawLayers, setFrameRate, setLayersVisible, setMouseImagePos, setMouseImagePosC, setMouseImagePosT, setMouseImagePosX, setMouseImagePosY, setMouseImagePosZ, setMousePos, setOffset, setOffsetC, setOffsetT, setOffsetX, setOffsetY, setOffsetZ, setPosition, setPositionC, setPositionX, setPositionY, setRotation, setRotationC, setRotationT, setRotationX, setRotationY, setRotationZ, setScale, setScaleC, setScaleT, setScaleX, setScaleY, setScaleZ, setSyncId, setT, setZ, viewerChanged, viewerClosed

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Canvas2D

public Canvas2D(Viewer viewer)

Method Detail

shutDown

public void shutDown()

Description copied from class: IcyCanvas

Called by the viewer when canvas is closed to release some resources.
Be careful to not restore previous state here (as the colormap) because generally shutdown is called after the creation of the other canvas.

Overrides:

shutDown in class IcyCanvas

getCanvasSettingPanel

public Canvas2DSettingPanel getCanvasSettingPanel()

getViewComponent

public java.awt.Component getViewComponent()

Specified by:

getViewComponent in class IcyCanvas

Returns:

the main view component

getCanvasView

public Canvas2D.CanvasView getCanvasView()

Return the Canvas2D.CanvasView component of Canvas2D.

getCanvasMap

public Canvas2D.CanvasMap getCanvasMap()

Return the Canvas2D.CanvasMap component of Canvas2D.

customizeToolbar

public void customizeToolbar(javax.swing.JToolBar toolBar)

Description copied from class: IcyCanvas

Called by the parent viewer when building the toolbar.
This way the canvas can customize it by adding specific command for instance.

Overrides:

customizeToolbar in class IcyCanvas

Parameters:

toolBar - the parent toolbar to customize

fitImageToCanvas

public void fitImageToCanvas()

Description copied from class: IcyCanvas2D

Change scale so image fit in canvas view dimension

Overrides:

fitImageToCanvas in class IcyCanvas2D

fitImageToCanvas

public void fitImageToCanvas(boolean smooth)

Change zoom so image fit in canvas view dimension

fitCanvasToImage

public void fitCanvasToImage()

Description copied from class: IcyCanvas2D

Change canvas size (so viewer size) to get it fit with image dimension if possible

Overrides:

fitCanvasToImage in class IcyCanvas2D

centerOnImage

public void centerOnImage(double x,
                 double y)

Description copied from class: IcyCanvas2D

Center image on specified image position in canvas

Overrides:

centerOnImage in class IcyCanvas2D

centerOn

public void centerOn(java.awt.Rectangle region)

Description copied from class: IcyCanvas2D

Adjust view position and possibly scaling factor to ensure the specified region become visible.
It's up to the Canvas implementation to decide how to make the region visible.

Overrides:

centerOn in class IcyCanvas2D

Parameters:

region - the region we want to see

setOffset

public void setOffset(int x,
             int y,
             boolean smooth)

Set offset X and Y.

Parameters:

smooth - use smooth transition

setScale

public void setScale(double factor,
            boolean center,
            boolean smooth)

Set zoom factor (this use the smart zoom position and smooth transition).

Parameters:

center - if true then zoom is centered to current view else zoom is centered using current mouse position

smooth - use smooth transition

setScale

public void setScale(double x,
            double y,
            boolean mouseCentered,
            boolean smooth)

Set zoom X and Y factor.
This use the smart zoom position and smooth transition.

Parameters:

mouseCentered - if true the current mouse image position will becomes the center of viewport else the current mouse image position will keep its place.

smooth - use smooth transition

setScale

public void setScale(double x,
            double y,
            boolean smooth)

Set zoom X and Y factor.
This is direct affectation method without position modification.

Parameters:

smooth - use smooth transition

setZoom

@Deprecated
public void setZoom(float zoom)

Deprecated. use setScale(...) instead

Set zoom factor.
Only here for backward compatibility with ICY4IJ.
Zoom is center on image.

getDestImageCanvasSizeX

public int getDestImageCanvasSizeX()

Get destination image size X in canvas pixel coordinate

getDestImageCanvasSizeY

public int getDestImageCanvasSizeY()

Get destination image size Y in canvas pixel coordinate

isBackgroundColorEnabled

public boolean isBackgroundColorEnabled()

Returns the background color enabled state

setBackgroundColorEnabled

public void setBackgroundColorEnabled(boolean value)

Sets the background color enabled state

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the background color

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets the background color

getFitToCanvas

public boolean getFitToCanvas()

Returns:

the automatic 'fit to canvas' state

setFitToCanvas

public void setFitToCanvas(boolean value)

Sets the automatic 'fit to canvas' state

isSynchronizationSupported

public boolean isSynchronizationSupported()

Description copied from class: IcyCanvas

Return true if this canvas support synchronization

Overrides:

isSynchronizationSupported in class IcyCanvas

getOffsetX

public int getOffsetX()

Description copied from class: IcyCanvas

X offset

Overrides:

getOffsetX in class IcyCanvas

getOffsetY

public int getOffsetY()

Description copied from class: IcyCanvas

Y offset

Overrides:

getOffsetY in class IcyCanvas

getScaleX

public double getScaleX()

Description copied from class: IcyCanvas

X scale factor

Overrides:

getScaleX in class IcyCanvas

getScaleY

public double getScaleY()

Description copied from class: IcyCanvas

Y scale factor

Overrides:

getScaleY in class IcyCanvas

getRotationZ

public double getRotationZ()

Description copied from class: IcyCanvas

Z rotation angle (radian)

Overrides:

getRotationZ in class IcyCanvas

getZoomFactor

@Deprecated
public double getZoomFactor()

Deprecated. use getScaleX() or getScaleY() instead

Only here for backward compatibility with ICY4IJ plugin.

getRotation

public double getRotation()

We want angle to be in [0..2*PI]

setRotation

public void setRotation(double value,
               boolean smooth)

Set rotation angle (radian).

Parameters:

smooth - use smooth transition

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

Overrides:

keyPressed in class IcyCanvas

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

Overrides:

keyReleased in class IcyCanvas

refresh

public void refresh()

Description copied from class: IcyCanvas

Force canvas refresh

Specified by:

refresh in class IcyCanvas

getARGBImage

public java.awt.image.BufferedImage getARGBImage(int t,
                                        int z,
                                        int c,
                                        java.awt.image.BufferedImage out)

Return an ARGB BufferedImage form of the image located at position [T, Z, C].
If the 'out' image is not compatible with wanted image, a new image is returned.

getRenderedImage

public java.awt.image.BufferedImage getRenderedImage(int t,
                                            int z,
                                            int c,
                                            boolean cv)

Description copied from class: IcyCanvas

Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
Free feel to the canvas to handle or not a specific dimension.

Specified by:

getRenderedImage in class IcyCanvas

Parameters:

t - T position of wanted image (-1 for complete sequence)

z - Z position of wanted image (-1 for complete stack)

c - C position of wanted image (-1 for all channels)

cv - render with canvas view if true else use default sequence dimension

getRenderedImage

@Deprecated
public java.awt.image.BufferedImage getRenderedImage(int t,
                                                       int z)

Deprecated. Use getRenderedImage(t, z, -1, true) instead.

getRenderedImage

@Deprecated
public java.awt.image.BufferedImage getRenderedImage(int t,
                                                       int z,
                                                       boolean canvasView)

Deprecated. Use getRenderedImage(t, z, -1, canvasView) instead.

changed

public void changed(IcyCanvasEvent event)

Description copied from class: IcyCanvas

canvas changed (packed event).
do global changes processing here

Overrides:

changed in class IcyCanvas2D

toolChanged

public void toolChanged(java.lang.String command)

Specified by:

toolChanged in interface ROITask.ROITaskListener