DefaultImageCanvas (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.display.DefaultImageCanvas

All Implemented Interfaces:

ImageCanvas, Pannable, Zoomable
```
public class DefaultImageCanvas
extends Object
implements ImageCanvas
```
The DefaultImageCanvas maintains a viewport, a zoom scale and a center coordinate that it uses to map viewport pixels to display coordinates. It also maintains an abstract mouse cursor.
The canvas sends a PanZoomEvent whenever it is panned or zoomed. It sends a MouseCursorEvent whenever the mouse cursor changes.

Author:

Lee Kamentsky, Curtis Rueden, Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

DefaultImageCanvas(ImageDisplay display)

Constructors
Constructor and Description
`DefaultImageCanvas(ImageDisplay display)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IntCoords`	`dataToPanelCoords(RealCoords dataCoords)` Converts the given data coordinates into panel coordinates.
`double`	`getBestZoomLevel(double fractionalScale)` Gets the closest step-wise zoom factor below the given scale.
`MouseCursor`	`getCursor()` Gets the current mouse cursor.
`ImageDisplay`	`getDisplay()` Gets the canvas's display.
`double`	`getInitialScale()` Gets the scale to use when reverting after zooming.
`RealCoords`	`getPanCenter()` Gets the coordinates of the data space point currently displayed in the center of the viewport.
`IntCoords`	`getPanOffset()` Gets the absolute offset of the viewport in pixels from the top left.
`int`	`getViewportHeight()` Gets the current height of the canvas viewport in panel coordinates.
`int`	`getViewportWidth()` Gets the current width of the canvas viewport in panel coordinates.
`double`	`getZoomFactor()` Gets the current zoom level.
`boolean`	`isInImage(IntCoords point)` Tests whether a given point in the panel falls within the boundaries of the display space.
`void`	`pan(IntCoords delta)` Adjusts the pan by the given (X, Y) amount in panel space.
`void`	`pan(RealCoords delta)` Adjusts the pan by the given (X, Y) amount.
`RealCoords`	`panelToDataCoords(IntCoords panelCoords)` Converts the given panel coordinates into data coordinates.
`void`	`panReset()` Resets the pan origin to the center of the display.
`void`	`setCursor(MouseCursor cursor)` Sets the mouse to the given `MouseCursor` type.
`void`	`setInitialScale(double zoomFactor)` Sets the scale to use when reverting after zooming.
`void`	`setPanCenter(IntCoords center)` Pans to the given absolute (X, Y) position in panel coordinate space.
`void`	`setPanCenter(RealCoords center)` Pans to the given absolute (X, Y) position in data coordinate space.
`void`	`setViewportSize(int width, int height)` Sets the dimensions of the viewport in panel coordinates.
`void`	`setZoom(double factor)` Zooms to the given scale factor, without changing the viewport's center.
`void`	`setZoomAndCenter(double factor)` Zooms to the given scale factor, recentering the viewport at the center of the data space.
`void`	`setZoomAndCenter(double factor, RealCoords center)` Zooms to the given scale factor, recentering the viewport at the specified data coordinates.
`void`	`setZoomAtPoint(double factor, IntCoords pos)` Zooms to the given scale factor, such that the specified position in panel coordinates remains at the same place in the viewport.
`void`	`setZoomAtPoint(double factor, RealCoords pos)` Zooms to the given scale factor, such that the specified position in data coordinates remains at the same place in the viewport.
`void`	`zoomIn()` Zooms in by the default amount, without changing the viewport's center.
`void`	`zoomIn(IntCoords pos)` Zooms in by the default amount, such that the specified position in panel coordinates remains at the same place in the viewport.
`void`	`zoomIn(RealCoords pos)` Zooms in by the default amount, such that the specified position in data coordinates remains at the same place in the viewport.
`void`	`zoomOut()` Zooms out by the default amount, without changing the viewport's center.
`void`	`zoomOut(IntCoords pos)` Zooms out by the default amount, such that the specified position in panel coordinates remains at the same place in the viewport.
`void`	`zoomOut(RealCoords pos)` Zooms out by the default amount, such that the specified position in data coordinates remains at the same place in the viewport.
`void`	`zoomToFit(IntRect viewportBox)` Zooms the viewport to fit the given bounding box in panel coordinates.
`void`	`zoomToFit(RealRect viewportBox)` Zoom the viewport to fit the given bounding box in data coordinates.

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

- Constructor Detail
  - DefaultImageCanvas
```
public DefaultImageCanvas(ImageDisplay display)
```
- Method Detail
  - getDisplay
```
public ImageDisplay getDisplay()
```
    Description copied from interface: ImageCanvas
    
    Gets the canvas's display.
    
    Specified by:
    
    getDisplay in interface ImageCanvas
  - getViewportWidth
```
public int getViewportWidth()
```
    Description copied from interface: ImageCanvas
    
    Gets the current width of the canvas viewport in panel coordinates.
    
    Specified by:
    
    getViewportWidth in interface ImageCanvas
  - getViewportHeight
```
public int getViewportHeight()
```
    Description copied from interface: ImageCanvas
    
    Gets the current height of the canvas viewport in panel coordinates.
    
    Specified by:
    
    getViewportHeight in interface ImageCanvas
  - setViewportSize
```
public void setViewportSize(int width,
                            int height)
```
    Description copied from interface: ImageCanvas
    
    Sets the dimensions of the viewport in panel coordinates.
    
    Specified by:
    
    setViewportSize in interface ImageCanvas
  - isInImage
```
public boolean isInImage(IntCoords point)
```
    Description copied from interface: ImageCanvas
    
    Tests whether a given point in the panel falls within the boundaries of the display space.
    
    Specified by:
    
    isInImage in interface ImageCanvas
    
    Parameters:
    
    point - The point to check, in panel coordinates.
  - panelToDataCoords
```
public RealCoords panelToDataCoords(IntCoords panelCoords)
```
    Description copied from interface: ImageCanvas
    
    Converts the given panel coordinates into data coordinates.
    
    Specified by:
    
    panelToDataCoords in interface ImageCanvas
  - dataToPanelCoords
```
public IntCoords dataToPanelCoords(RealCoords dataCoords)
```
    Description copied from interface: ImageCanvas
    
    Converts the given data coordinates into panel coordinates.
    
    Specified by:
    
    dataToPanelCoords in interface ImageCanvas
  - getCursor
```
public MouseCursor getCursor()
```
    Description copied from interface: ImageCanvas
    
    Gets the current mouse cursor.
    
    Specified by:
    
    getCursor in interface ImageCanvas
  - setCursor
```
public void setCursor(MouseCursor cursor)
```
    Description copied from interface: ImageCanvas
    
    Sets the mouse to the given MouseCursor type.
    
    Specified by:
    
    setCursor in interface ImageCanvas
  - getPanCenter
```
public RealCoords getPanCenter()
```
    Description copied from interface: Pannable
    
    Gets the coordinates of the data space point currently displayed in the center of the viewport.
    
    Specified by:
    
    getPanCenter in interface Pannable
    
    Returns:
    
    Pan center coordinates, in data coordinate space.
  - getPanOffset
```
public IntCoords getPanOffset()
```
    Description copied from interface: Pannable
    
    Gets the absolute offset of the viewport in pixels from the top left.
    
    Specified by:
    
    getPanOffset in interface Pannable
    
    Returns:
    
    Pan offset in pixels; note that this value is not in panel coordinate space, since the pan offset in panel coordinate space is always (0, 0).
  - setPanCenter
```
public void setPanCenter(RealCoords center)
```
    Description copied from interface: Pannable
    
    Pans to the given absolute (X, Y) position in data coordinate space.
    
    Specified by:
    
    setPanCenter in interface Pannable
    
    Parameters:
    
    center - Absolute coordinates, in data coordinate space.
  - setPanCenter
```
public void setPanCenter(IntCoords center)
```
    Description copied from interface: Pannable
    
    Pans to the given absolute (X, Y) position in panel coordinate space.
    
    Specified by:
    
    setPanCenter in interface Pannable
    
    Parameters:
    
    center - Absolute coordinates, in panel coordinate space.
  - pan
```
public void pan(RealCoords delta)
```
    Description copied from interface: Pannable
    
    Adjusts the pan by the given (X, Y) amount.
    
    Specified by:
    
    pan in interface Pannable
    
    Parameters:
    
    delta - Pan modifier, in data coordinate space.
  - pan
```
public void pan(IntCoords delta)
```
    Description copied from interface: Pannable
    
    Adjusts the pan by the given (X, Y) amount in panel space.
    
    Specified by:
    
    pan in interface Pannable
    
    Parameters:
    
    delta - Pan modifier, in panel coordinate space.
  - panReset
```
public void panReset()
```
    Description copied from interface: Pannable
    
    Resets the pan origin to the center of the display.
    
    Specified by:
    
    panReset in interface Pannable
  - setZoom
```
public void setZoom(double factor)
```
    Description copied from interface: Zoomable
    
    Zooms to the given scale factor, without changing the viewport's center.
    
    Specified by:
    
    setZoom in interface Zoomable
    
    Parameters:
    
    factor - The new scale factor.
  - setZoomAtPoint
```
public void setZoomAtPoint(double factor,
                           RealCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms to the given scale factor, such that the specified position in data coordinates remains at the same place in the viewport.
    This is useful for repeatedly zooming at a chosen point in the data.
    
    Specified by:
    
    setZoomAtPoint in interface Zoomable
    
    Parameters:
    
    factor - The new scale factor.
    
    pos - The data coordinates to keep in the same place within the viewport.
  - setZoomAtPoint
```
public void setZoomAtPoint(double factor,
                           IntCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms to the given scale factor, such that the specified position in panel coordinates remains at the same place in the viewport.
    This is useful for repeatedly zooming at a clicked point.
    
    Specified by:
    
    setZoomAtPoint in interface Zoomable
    
    Parameters:
    
    factor - The new scale factor.
    
    pos - The panel coordinates to keep in the same place within the viewport.
  - setZoomAndCenter
```
public void setZoomAndCenter(double factor)
```
    Description copied from interface: Zoomable
    
    Zooms to the given scale factor, recentering the viewport at the center of the data space.
    
    Specified by:
    
    setZoomAndCenter in interface Zoomable
    
    Parameters:
    
    factor - The new scale factor.
  - setZoomAndCenter
```
public void setZoomAndCenter(double factor,
                             RealCoords center)
```
    Description copied from interface: Zoomable
    
    Zooms to the given scale factor, recentering the viewport at the specified data coordinates.
    
    Specified by:
    
    setZoomAndCenter in interface Zoomable
    
    Parameters:
    
    factor - The new scale factor.
    
    center - Absolute coordinates, in data coordinate space.
  - zoomIn
```
public void zoomIn()
```
    Description copied from interface: Zoomable
    
    Zooms in by the default amount, without changing the viewport's center.
    
    Specified by:
    
    zoomIn in interface Zoomable
  - zoomIn
```
public void zoomIn(RealCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms in by the default amount, such that the specified position in data coordinates remains at the same place in the viewport.
    
    Specified by:
    
    zoomIn in interface Zoomable
    
    Parameters:
    
    pos - The data coordinates to keep in the same place within the viewport.
  - zoomIn
```
public void zoomIn(IntCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms in by the default amount, such that the specified position in panel coordinates remains at the same place in the viewport.
    
    Specified by:
    
    zoomIn in interface Zoomable
    
    Parameters:
    
    pos - The panel coordinates to keep in the same place within the viewport.
  - zoomOut
```
public void zoomOut()
```
    Description copied from interface: Zoomable
    
    Zooms out by the default amount, without changing the viewport's center.
    
    Specified by:
    
    zoomOut in interface Zoomable
  - zoomOut
```
public void zoomOut(RealCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms out by the default amount, such that the specified position in data coordinates remains at the same place in the viewport.
    
    Specified by:
    
    zoomOut in interface Zoomable
    
    Parameters:
    
    pos - The data coordinates to keep in the same place within the viewport.
  - zoomOut
```
public void zoomOut(IntCoords pos)
```
    Description copied from interface: Zoomable
    
    Zooms out by the default amount, such that the specified position in panel coordinates remains at the same place in the viewport.
    
    Specified by:
    
    zoomOut in interface Zoomable
    
    Parameters:
    
    pos - The panel coordinates to keep in the same place within the viewport.
  - zoomToFit
```
public void zoomToFit(IntRect viewportBox)
```
    Description copied from interface: Zoomable
    
    Zooms the viewport to fit the given bounding box in panel coordinates.
    
    Specified by:
    
    zoomToFit in interface Zoomable
    
    Parameters:
    
    viewportBox - The viewport bounding box, in panel coordinates.
  - zoomToFit
```
public void zoomToFit(RealRect viewportBox)
```
    Description copied from interface: Zoomable
    
    Zoom the viewport to fit the given bounding box in data coordinates.
    
    Specified by:
    
    zoomToFit in interface Zoomable
    
    Parameters:
    
    viewportBox - The viewport bounding box, in data coordinates.
  - getZoomFactor
```
public double getZoomFactor()
```
    Description copied from interface: Zoomable
    
    Gets the current zoom level.
    
    Specified by:
    
    getZoomFactor in interface Zoomable
  - getInitialScale
```
public double getInitialScale()
```
    Description copied from interface: Zoomable
    
    Gets the scale to use when reverting after zooming.
    
    Specified by:
    
    getInitialScale in interface Zoomable
  - setInitialScale
```
public void setInitialScale(double zoomFactor)
```
    Description copied from interface: Zoomable
    
    Sets the scale to use when reverting after zooming.
    
    Specified by:
    
    setInitialScale in interface Zoomable
  - getBestZoomLevel
```
public double getBestZoomLevel(double fractionalScale)
```
    Description copied from interface: Zoomable
    
    Gets the closest step-wise zoom factor below the given scale.
    
    Specified by:
    
    getBestZoomLevel in interface Zoomable

Class DefaultImageCanvas

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultImageCanvas

Method Detail

getDisplay

getViewportWidth

getViewportHeight

setViewportSize

isInImage

panelToDataCoords

dataToPanelCoords

getCursor

setCursor

getPanCenter

getPanOffset

setPanCenter

setPanCenter

pan

pan

panReset

setZoom

setZoomAtPoint

setZoomAtPoint

setZoomAndCenter

setZoomAndCenter

zoomIn

zoomIn

zoomIn

zoomOut

zoomOut

zoomOut

zoomToFit

zoomToFit

getZoomFactor

getInitialScale

setInitialScale

getBestZoomLevel