net.imagej.display

Interface ImageCanvas

All Superinterfaces:

Pannable, Zoomable

All Known Implementing Classes:

DefaultImageCanvas

public interface ImageCanvas
extends Pannable, Zoomable

A canvas upon which an ImageDisplay draws its output.

An image canvas supports two different coordinate systems, and provides a mechanism for conversion between them. The first is panel coordinates, which are in pixels onscreen. The second is data coordinates, which match the linked ImageDisplay's original coordinate system.

Author:

Grant Harris, Curtis Rueden

Method Summary

Modifier and Type	Method and Description
IntCoords	dataToPanelCoords(RealCoords dataCoords) Converts the given data coordinates into panel coordinates.
MouseCursor	getCursor() Gets the current mouse cursor.
ImageDisplay	getDisplay() Gets the canvas's display.
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.
boolean	isInImage(IntCoords point) Tests whether a given point in the panel falls within the boundaries of the display space.
RealCoords	panelToDataCoords(IntCoords panelCoords) Converts the given panel coordinates into data coordinates.
void	setCursor(MouseCursor cursor) Sets the mouse to the given MouseCursor type.
void	setViewportSize(int width, int height) Sets the dimensions of the viewport in panel coordinates.

Methods inherited from interface net.imagej.display.Pannable

getPanCenter, getPanOffset, pan, pan, panReset, setPanCenter, setPanCenter

Methods inherited from interface net.imagej.display.Zoomable

getBestZoomLevel, getInitialScale, getZoomFactor, setInitialScale, setZoom, setZoomAndCenter, setZoomAndCenter, setZoomAtPoint, setZoomAtPoint, zoomIn, zoomIn, zoomIn, zoomOut, zoomOut, zoomOut, zoomToFit, zoomToFit

Method Detail

getDisplay

ImageDisplay getDisplay()

Gets the canvas's display.

getViewportWidth

int getViewportWidth()

Gets the current width of the canvas viewport in panel coordinates.

getViewportHeight

int getViewportHeight()

Gets the current height of the canvas viewport in panel coordinates.

setViewportSize

void setViewportSize(int width,
                     int height)

Sets the dimensions of the viewport in panel coordinates.

isInImage

boolean isInImage(IntCoords point)

Tests whether a given point in the panel falls within the boundaries of the display space.

Parameters:

point - The point to check, in panel coordinates.

panelToDataCoords

RealCoords panelToDataCoords(IntCoords panelCoords)

Converts the given panel coordinates into data coordinates.

dataToPanelCoords

IntCoords dataToPanelCoords(RealCoords dataCoords)

Converts the given data coordinates into panel coordinates.

getCursor

MouseCursor getCursor()

Gets the current mouse cursor.

setCursor

void setCursor(MouseCursor cursor)

Sets the mouse to the given MouseCursor type.