MultiDThreePanesCanvas (SNT Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Canvas
  - - ij.gui.ImageCanvas
    - - sc.fiji.snt.hyperpanes.MultiDThreePanesCanvas

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, Cloneable, EventListener, Accessible

Direct Known Subclasses:

TracerCanvas
```
public class MultiDThreePanesCanvas
extends ImageCanvas
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Canvas
  Canvas.AccessibleAWTCanvas
- 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 boolean cursorLocked

protected PaneOwner owner

protected int plane

protected boolean waitingForRoiDrawing
- Fields inherited from class ij.gui.ImageCanvas
  crosshairCursor, defaultCursor, dstHeight, dstWidth, flags, handCursor, ij, imageHeight, imageUpdated, imageWidth, imp, lastZoomSX, lastZoomSY, magnification, MAX_MOUSEMOVE_ZOOM, moveCursor, srcRect, usePointer, xMouse, xMouseStart, xSrcStart, yMouse, yMouseStart, ySrcStart, zoomTargetOX, zoomTargetOY
- 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

Fields
Modifier and Type	Field and Description
`protected boolean`	`cursorLocked`
`protected PaneOwner`	`owner`
`protected int`	`plane`
`protected boolean`	`waitingForRoiDrawing`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MultiDThreePanesCanvas(ij.ImagePlus imagePlus, int plane)`
`protected`	`MultiDThreePanesCanvas(ij.ImagePlus imagePlus, PaneOwner owner, int plane)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disableEvents(boolean disable)` Sets whether mouse and key events should be waived back to IJ.
`protected void`	`drawCrosshairs(Graphics2D g, double x_on_screen, double y_on_screen)`
`protected void`	`drawOverlay(Graphics2D g)`
`Color`	`getAnnotationsColor()`
`PointInCanvas`	`getCursorPos()`
`Graphics2D`	`getGraphics2D(Graphics g)`
`BoundingBox`	`getViewPort()`
`boolean`	`isEventsDisabled()`
`void`	`mouseDragged(MouseEvent e)`
`int`	`myOffScreenX(int sx)` Converts a screen x-coordinate to an offscreen (image) x-coordinate.
`double`	`myOffScreenXD(int sx)` Converts a screen x-coordinate to a floating-point offscreen (image) x-coordinate.
`int`	`myOffScreenY(int sy)` Converts a screen y-coordinate to an offscreen (image) y-coordinate.
`double`	`myOffScreenYD(int sy)` Converts a screen y-coordinate to a floating-point offscreen (image) y-coordinate.
`int`	`myScreenX(int ox)` Converts an offscreen (image) x-coordinate to a screen x-coordinate.
`int`	`myScreenXD(double ox)` Converts a floating-point offscreen (image) x-coordinate to a screen x-coordinate.
`double`	`myScreenXDprecise(double ox)` Converts an offscreen (image) x-coordinate to a screen x-coordinate with floating-point precision.
`int`	`myScreenY(int oy)` Converts an offscreen (image) y-coordinate to a screen y-coordinate.
`int`	`myScreenYD(double oy)` Converts a floating-point offscreen (image) x-coordinate to a screen x-coordinate.
`double`	`myScreenYDprecise(double oy)` Converts an offscreen (image) y-coordinate to a screen y-coordinate with floating-point precision.
`static Object`	`newThreePanesCanvas(ij.ImagePlus imagePlus, PaneOwner owner, int plane)`
`void`	`restoreDefaultCursor()`
`void`	`scrollTo(int newOffscreenX, int newOffscreenY)`
`void`	`setAnnotationsColor(Color color)`
`void`	`setCanvasLabel(String label)` Sets the string to be rendered on canvas' upper left corner.
`void`	`setCrosshairs(double x, double y, double z, boolean display)` Deprecated.
`void`	`setCursorText(String cursorText)` Sets the string to be appended to the current cursor.
`void`	`setDrawCrosshairs(boolean drawCrosshairs)`
`protected void`	`setLockCursor(boolean lock)`
`void`	`setPaneOwner(PaneOwner owner)`
`protected void`	`setZoom(double zoomFactor)`
`protected void`	`triggerZoomEvent(boolean in, int off_screen_x, int off_screen_y)`
`void`	`updateCursor(double x, double y, double z)`
`void`	`updatePosition(double x, double y, double z)`
`void`	`zoomIn(int sx, int sy)`
`void`	`zoomOut(int sx, int sy)`

Methods inherited from class ij.gui.ImageCanvas
canEnlarge, cursorOverImage, disablePopupMenu, fitToWindow, getCursorLoc, getCustomRoi, getDisplayList, getHigherZoomLevel, getImage, getLowerZoomLevel, getMagnification, getModifiers, getOverlay, getPaintPending, getPreferredSize, getScaleToFit, getShowAllColor, getShowAllList, getShowAllROIs, getSliceNumber, getSrcRect, handlePopupMenu, handleRoiMouseDown, hideZoomIndicator, mouseClicked, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offScreenX, offScreenX2, offScreenXD, offScreenY, offScreenY2, offScreenYD, paint, repaintOverlay, resetDoubleBuffer, roiManagerSelect, screenX, screenXD, screenY, screenYD, scroll, setCursor, setCursor, setCustomRoi, setDisplayList, setDisplayList, setDisplayList, setDrawingColor, setDrawingSize, setImageUpdated, setMagnification, setOverlay, setPaintPending, setScaleToFit, setShowAllColor, setShowAllList, setShowAllROIs, setShowCursorStatus, setSize, setSourceRect, setupScroll, unzoom, update, zoom100Percent

Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - owner
```
protected PaneOwner owner
```
  - plane
```
protected int plane
```
  - waitingForRoiDrawing
```
protected boolean waitingForRoiDrawing
```
  - cursorLocked
```
protected boolean cursorLocked
```
- Constructor Detail
  - MultiDThreePanesCanvas
```
protected MultiDThreePanesCanvas(ij.ImagePlus imagePlus,
                                 PaneOwner owner,
                                 int plane)
```
  - MultiDThreePanesCanvas
```
protected MultiDThreePanesCanvas(ij.ImagePlus imagePlus,
                                 int plane)
```
- Method Detail
  - newThreePanesCanvas
```
public static Object newThreePanesCanvas(ij.ImagePlus imagePlus,
                                         PaneOwner owner,
                                         int plane)
```
  - setPaneOwner
```
public void setPaneOwner(PaneOwner owner)
```
  - setZoom
```
protected void setZoom(double zoomFactor)
```
  - drawOverlay
```
protected void drawOverlay(Graphics2D g)
```
  - getCursorPos
```
public PointInCanvas getCursorPos()
```
    Returns:
    
    the current X,Y position of the mouse cursor
  - getGraphics2D
```
public Graphics2D getGraphics2D(Graphics g)
```
  - triggerZoomEvent
```
protected void triggerZoomEvent(boolean in,
                                int off_screen_x,
                                int off_screen_y)
```
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface MouseMotionListener
    
    Overrides:
    
    mouseDragged in class ImageCanvas
  - zoomIn
```
public void zoomIn(int sx,
                   int sy)
```
    Overrides:
    
    zoomIn in class ImageCanvas
  - zoomOut
```
public void zoomOut(int sx,
                    int sy)
```
    Overrides:
    
    zoomOut in class ImageCanvas
  - drawCrosshairs
```
protected void drawCrosshairs(Graphics2D g,
                              double x_on_screen,
                              double y_on_screen)
```
  - updatePosition
```
public void updatePosition(double x,
                           double y,
                           double z)
```
  - setCrosshairs
```
@Deprecated
public void setCrosshairs(double x,
                                      double y,
                                      double z,
                                      boolean display)
```
    Deprecated.
  - updateCursor
```
public void updateCursor(double x,
                         double y,
                         double z)
```
  - scrollTo
```
public void scrollTo(int newOffscreenX,
                     int newOffscreenY)
```
  - myOffScreenX
```
public int myOffScreenX(int sx)
```
    Converts a screen x-coordinate to an offscreen (image) x-coordinate.
    
    Parameters:
    
    sx - the screen x coordinate
    
    Returns:
    
    the image x coordinate
  - myOffScreenY
```
public int myOffScreenY(int sy)
```
    Converts a screen y-coordinate to an offscreen (image) y-coordinate.
    
    Parameters:
    
    sy - the screen y coordinate
    
    Returns:
    
    the image y coordinate
  - myOffScreenXD
```
public double myOffScreenXD(int sx)
```
    Converts a screen x-coordinate to a floating-point offscreen (image) x-coordinate.
    
    Parameters:
    
    sx - the screen x coordinate
    
    Returns:
    
    the image x coordinate
  - myOffScreenYD
```
public double myOffScreenYD(int sy)
```
    Converts a screen y-coordinate to a floating-point offscreen (image) y-coordinate.
    
    Parameters:
    
    sy - the screen y coordinate
    
    Returns:
    
    the image y coordinate
  - myScreenX
```
public int myScreenX(int ox)
```
    Converts an offscreen (image) x-coordinate to a screen x-coordinate.
    
    Parameters:
    
    ox - the image x coordinate
    
    Returns:
    
    the screen x coordinate
  - myScreenY
```
public int myScreenY(int oy)
```
    Converts an offscreen (image) y-coordinate to a screen y-coordinate.
    
    Parameters:
    
    oy - the image y coordinate
    
    Returns:
    
    the screen y coordinate
  - myScreenXD
```
public int myScreenXD(double ox)
```
    Converts a floating-point offscreen (image) x-coordinate to a screen x-coordinate.
    
    Parameters:
    
    ox - the image x coordinate
    
    Returns:
    
    the screen x coordinate
  - myScreenXDprecise
```
public double myScreenXDprecise(double ox)
```
    Converts an offscreen (image) x-coordinate to a screen x-coordinate with floating-point precision.
    
    Parameters:
    
    ox - the image x coordinate
    
    Returns:
    
    the screen x coordinate
  - myScreenYD
```
public int myScreenYD(double oy)
```
    Converts a floating-point offscreen (image) x-coordinate to a screen x-coordinate.
    
    Parameters:
    
    oy - the image x coordinate
    
    Returns:
    
    the screen x coordinate
  - myScreenYDprecise
```
public double myScreenYDprecise(double oy)
```
    Converts an offscreen (image) y-coordinate to a screen y-coordinate with floating-point precision.
    
    Parameters:
    
    oy - the image y coordinate
    
    Returns:
    
    the screen y coordinate
  - restoreDefaultCursor
```
public void restoreDefaultCursor()
```
  - setCanvasLabel
```
public void setCanvasLabel(String label)
```
    Sets the string to be rendered on canvas' upper left corner.
    
    Parameters:
    
    label - the string to be displayed
  - setCursorText
```
public void setCursorText(String cursorText)
```
    Sets the string to be appended to the current cursor.
    
    Parameters:
    
    cursorText - the string to be displayed around the cursor
  - setAnnotationsColor
```
public void setAnnotationsColor(Color color)
```
  - getAnnotationsColor
```
public Color getAnnotationsColor()
```
  - getViewPort
```
public BoundingBox getViewPort()
```
  - isEventsDisabled
```
public boolean isEventsDisabled()
```
    Returns:
    
    whether SNT is being notified of mouse/key events
  - disableEvents
```
public void disableEvents(boolean disable)
```
    Sets whether mouse and key events should be waived back to IJ.
    
    Parameters:
    
    disable - If true, SNT will not be notified of mouse/keyboard events
  - setLockCursor
```
protected void setLockCursor(boolean lock)
```
  - setDrawCrosshairs
```
public void setDrawCrosshairs(boolean drawCrosshairs)
```

Class MultiDThreePanesCanvas

Nested Class Summary

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

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

Field Summary

Fields inherited from class ij.gui.ImageCanvas

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class ij.gui.ImageCanvas

Methods inherited from class java.awt.Canvas

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

owner

plane

waitingForRoiDrawing

cursorLocked

Constructor Detail

MultiDThreePanesCanvas

MultiDThreePanesCanvas

Method Detail

newThreePanesCanvas

setPaneOwner

setZoom

drawOverlay

getCursorPos

getGraphics2D

triggerZoomEvent

mouseDragged

zoomIn

zoomOut

drawCrosshairs

updatePosition

setCrosshairs

updateCursor

scrollTo

myOffScreenX

myOffScreenY

myOffScreenXD

myOffScreenYD

myScreenX

myScreenY

myScreenXD

myScreenXDprecise

myScreenYD

myScreenYDprecise

restoreDefaultCursor

setCanvasLabel

setCursorText

setAnnotationsColor

getAnnotationsColor

getViewPort

isEventsDisabled

disableEvents

setLockCursor

setDrawCrosshairs