org.openstreetmap.josm.gui.layer.geoimage

Class GeoImageLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.AbstractModifiableLayer

org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer

All Implemented Interfaces:

ImageData.ImageDataUpdateListener, Lockable, ProjectionChangeListener, DownloadFromServer, JumpToMarkerActions.JumpToMarkerLayer, MapViewPaintable, SaveToFile, UploadToServer, NavigatableComponent.ZoomChangeListener, Destroyable

public class GeoImageLayer
extends AbstractModifiableLayer
implements JumpToMarkerActions.JumpToMarkerLayer, NavigatableComponent.ZoomChangeListener, ImageData.ImageDataUpdateListener

Layer displaying geottaged pictures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	GeoImageLayer.ImageMouseListener
(package private) static class	GeoImageLayer.Loader Loads a set of images, while displaying a dialog that indicates what the plugin is currently doing.

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.Layer

Layer.LayerAction, Layer.LayerGpxExportAction, Layer.LayerSaveAction, Layer.LayerSaveAsAction, Layer.MultiLayerAction, Layer.SeparatorLayerAction

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

AbstractMapViewPaintable.CompatibilityModeLayerPainter

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.layer.MapViewPaintable

MapViewPaintable.LayerPainter, MapViewPaintable.MapViewEvent, MapViewPaintable.PaintableInvalidationEvent, MapViewPaintable.PaintableInvalidationListener

Field Summary

Fields

Modifier and Type	Field and Description
private MainLayerManager.ActiveLayerChangeListener	activeLayerChangeListener
private boolean	cycleModeArmed Image cycle mode flag.
private ImageData	data
(package private) GpxLayer	gpxFauxLayer
(package private) GpxLayer	gpxLayer
private javax.swing.Icon	icon
private java.awt.Point	lastSelPos Mouse position where the last image was selected.
private MapFrame.MapModeChangeListener	mapModeListener
private static java.util.List<javax.swing.Action>	menuAdditions
private java.awt.event.MouseAdapter	mouseAdapter
private java.awt.event.MouseMotionAdapter	mouseMotionAdapter
private java.awt.image.BufferedImage	offscreenBuffer
private javax.swing.Icon	selectedIcon
private java.awt.Point	startPoint The mouse point
private static java.util.List<MapMode>	supportedMapModes
(package private) boolean	thumbsLoaded
private ThumbsLoader	thumbsloader
private java.util.concurrent.ExecutorService	thumbsLoaderExecutor
private boolean	thumbsLoaderRunning
private boolean	updateOffscreenBuffer
(package private) boolean	useThumbs

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer

FILTER_STATE_PROP, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

Constructors

Constructor and Description
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, boolean useThumbs) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, java.lang.String name) Constructs a new GeoImageLayer.
GeoImageLayer(java.util.List<ImageEntry> data, GpxLayer gpxLayer, java.lang.String name, boolean useThumbs) Constructs a new GeoImageLayer.

Method Summary

Modifier and Type	Method and Description
MapViewPaintable.LayerPainter	attachToMapView(MapViewPaintable.MapViewEvent event) This method is called whenever this layer is added to a map view.
private void	clearOtherCurrentPhotos() Clears the currentPhoto of the other GeoImageLayer's.
static void	create(java.util.Collection<java.io.File> files, GpxLayer gpxLayer) Create a GeoImageLayer asynchronously
void	destroy() Called, when the layer is removed from the mapview and is going to be destroyed.
java.lang.String	getChangesetSourceTag() Get the source for the layer
GpxLayer	getFauxGpxLayer() Returns a faux GPX layer built from the images or the associated GPX layer.
GpxLayer	getGpxLayer() Returns the associated GPX layer.
javax.swing.Icon	getIcon() Return a representative small image for this layer.
ImageData	getImageData() Returns the image data store being used by this layer
java.util.List<ImageEntry>	getImages() Get list of images in layer.
java.lang.Object	getInfoComponent() Gets the layer information to display to the user.
javax.swing.Action[]	getMenuEntries() Returns list of actions.
private int	getPhotoIdxUnderMouse(java.awt.event.MouseEvent evt) Returns index of the image that matches the position of the mouse event.
private int	getPhotoIdxUnderMouse(java.awt.event.MouseEvent evt, boolean cycle) Returns index of the image that matches the position of the mouse event.
ImageEntry	getPhotoUnderMouse(java.awt.event.MouseEvent evt) Returns the image that matches the position of the mouse event.
java.lang.String	getToolTipText()
void	hookUpMapView() Initialization code, that depends on Main.map.mapView.
void	imageDataUpdated(ImageData data) Called when the data change
private java.lang.String	infoText() Prepare the string that is displayed if layer information is requested.
boolean	isMergable(Layer other)
boolean	isModified() Determines if data managed by this layer has been modified.
private boolean	isPhotoIdxUnderMouse(int idx, java.awt.event.MouseEvent evt) Check if the position of the mouse event is within the rectangle of the photo icon or thumbnail.
private static boolean	isSupportedMapMode(MapMode mapMode) Determines if the functionality of this layer is available in the specified map mode.
boolean	isUseThumbs() Returns the current thumbnail display status.
void	jumpToNextMarker() Jump (move the viewport) to the next marker.
void	jumpToPreviousMarker() Jump (move the viewport) to the previous marker.
void	mergeFrom(Layer from) Merges the given layer into this layer.
void	paint(java.awt.Graphics2D g, MapView mv, Bounds bounds) Paint the dataset using the engine set.
private void	paintImage(ImageEntry e, MapView mv, java.awt.Rectangle clip, java.awt.Graphics2D tempG) Paint one image.
static void	registerMenuAddition(javax.swing.Action addition) Register actions on the layer
static void	registerSupportedMapMode(MapMode mapMode) Registers a map mode for which the functionality of this layer should be available.
private static java.awt.Dimension	scaledDimension(java.awt.Image thumb)
void	selectedImageChanged(ImageData data) Called when the selection change
void	setUseThumbs(boolean useThumbs) Enables or disables the display of thumbnails.
void	showCurrentPhoto() Show current photo on map and in image viewer.
void	startLoadThumbs() Start to load thumbnails.
void	stopLoadThumbs() Stop to load thumbnails.
void	thumbsLoaded() Called to signal that the loading of thumbnails has finished.
void	updateBufferAndRepaint() Marks the offscreen buffer to be updated.
void	visitBoundingBox(BoundingXYVisitor v) Visits the content bounds of this layer.
void	zoomChanged() Method called when the zoom area has changed.

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractModifiableLayer

createUploadTask, getUploadDialog, isDownloadable, isLocked, isUploadable, isUploadDiscouraged, isUploadInProgress, lock, onPostSaveToFile, onPostUploadToServer, requiresSaveToFile, requiresUploadToServer, unlock

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer

addPropertyChangeListener, checkSaveConditions, createAndOpenSaveFileChooser, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getDefaultLayerPosition, getName, getOpacity, getViewProjectionBounds, hasColor, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, isSavable, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setColor, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible, toString

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

addInvalidationListener, createMapViewPainter, invalidate, removeInvalidationListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.gui.layer.SaveToFile

isSavable

Field Detail

menuAdditions

private static java.util.List<javax.swing.Action> menuAdditions

supportedMapModes

private static volatile java.util.List<MapMode> supportedMapModes

data

private final ImageData data

gpxLayer

GpxLayer gpxLayer

gpxFauxLayer

GpxLayer gpxFauxLayer

icon

private final javax.swing.Icon icon

selectedIcon

private final javax.swing.Icon selectedIcon

useThumbs

boolean useThumbs

thumbsLoaderExecutor

private final java.util.concurrent.ExecutorService thumbsLoaderExecutor

thumbsloader

private ThumbsLoader thumbsloader

thumbsLoaderRunning

private boolean thumbsLoaderRunning

thumbsLoaded

volatile boolean thumbsLoaded

offscreenBuffer

private java.awt.image.BufferedImage offscreenBuffer

updateOffscreenBuffer

private boolean updateOffscreenBuffer

mouseAdapter

private java.awt.event.MouseAdapter mouseAdapter

mouseMotionAdapter

private java.awt.event.MouseMotionAdapter mouseMotionAdapter

mapModeListener

private MapFrame.MapModeChangeListener mapModeListener

activeLayerChangeListener

private MainLayerManager.ActiveLayerChangeListener activeLayerChangeListener

lastSelPos

private java.awt.Point lastSelPos

Mouse position where the last image was selected.

startPoint

private java.awt.Point startPoint

The mouse point

cycleModeArmed

private boolean cycleModeArmed

Image cycle mode flag. It is possible that a mouse button release triggers multiple mouseReleased() events. To prevent the cycling in such a case we wait for the next mouse button press event before it is cycled to the next image.

Constructor Detail

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     java.lang.String name)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

name - Layer name

Since:

6392

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     boolean useThumbs)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

useThumbs - Thumbnail display flag

Since:

6392

GeoImageLayer

public GeoImageLayer(java.util.List<ImageEntry> data,
                     GpxLayer gpxLayer,
                     java.lang.String name,
                     boolean useThumbs)

Constructs a new GeoImageLayer.

Parameters:

data - The list of images to display

gpxLayer - The associated GPX layer

name - Layer name

useThumbs - Thumbnail display flag

Since:

6392

Method Detail

create

public static void create(java.util.Collection<java.io.File> files,
                          GpxLayer gpxLayer)

Create a GeoImageLayer asynchronously

Parameters:

files - the list of image files to display

gpxLayer - the gpx layer

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Layer

Return a representative small image for this layer. The image must not be larger than 64 pixel in any dimension.

Specified by:

getIcon in class Layer

Returns:

layer icon

registerMenuAddition

public static void registerMenuAddition(javax.swing.Action addition)

Register actions on the layer

Parameters:

addition - the action to be added

getMenuEntries

public javax.swing.Action[] getMenuEntries()

Description copied from class: Layer

Returns list of actions. Action can implement LayerAction interface when it needs to be represented by other menu component than JMenuItem or when it supports multiple layers. Actions that support multiple layers should also have correct equals implementation. Use Layer.SeparatorLayerAction.INSTANCE instead of new JSeparator

Specified by:

getMenuEntries in class Layer

Returns:

menu actions for this layer

infoText

private java.lang.String infoText()

Prepare the string that is displayed if layer information is requested.

Returns:

String with layer information

getInfoComponent

public java.lang.Object getInfoComponent()

Description copied from class: Layer

Gets the layer information to display to the user. This is used if the user requests information about this layer. It should display a description of the layer content.

Specified by:

getInfoComponent in class Layer

Returns:

Either a String or a Component describing the layer.

getToolTipText

public java.lang.String getToolTipText()

Specified by:

getToolTipText in class Layer

Returns:

A small tooltip hint about some statistics for this layer.

isModified

public boolean isModified()

Determines if data managed by this layer has been modified. That is the case if one image has modified GPS data.

Specified by:

isModified in class AbstractModifiableLayer

Returns:

true if data has been modified; false, otherwise

isMergable

public boolean isMergable(Layer other)

Specified by:

isMergable in class Layer

Parameters:

other - The other layer that is tested to be mergable with this.

Returns:

Whether the other layer can be merged into this layer.

mergeFrom

public void mergeFrom(Layer from)

Description copied from class: Layer

Merges the given layer into this layer. Throws if the layer types are incompatible.

Specified by:

mergeFrom in class Layer

Parameters:

from - The layer that get merged into this one. After the merge, the other layer is not usable anymore and passing to one others mergeFrom should be one of the last things to do with a layer.

scaledDimension

private static java.awt.Dimension scaledDimension(java.awt.Image thumb)

paintImage

private void paintImage(ImageEntry e,
                        MapView mv,
                        java.awt.Rectangle clip,
                        java.awt.Graphics2D tempG)

Paint one image.

Parameters:

e - Image to be painted

mv - Map view

clip - Bounding rectangle of the current clipping area

tempG - Temporary offscreen buffer

paint

public void paint(java.awt.Graphics2D g,
                  MapView mv,
                  Bounds bounds)

Description copied from interface: MapViewPaintable

Paint the dataset using the engine set.

Specified by:

paint in interface MapViewPaintable

Parameters:

g - Graphics

mv - The object that can translate GeoPoints to screen coordinates.

bounds - Bounding box

visitBoundingBox

public void visitBoundingBox(BoundingXYVisitor v)

Description copied from class: Layer

Visits the content bounds of this layer. The behavior of this method depends on the layer, but each implementation should attempt to cover the relevant content of the layer in this method.

Specified by:

visitBoundingBox in class Layer

Parameters:

v - The visitor that gets notified about the contents of this layer.

showCurrentPhoto

public void showCurrentPhoto()

Show current photo on map and in image viewer.

isPhotoIdxUnderMouse

private boolean isPhotoIdxUnderMouse(int idx,
                                     java.awt.event.MouseEvent evt)

Check if the position of the mouse event is within the rectangle of the photo icon or thumbnail.

Parameters:

idx - the image index

evt - Mouse event

Returns:

true if the photo matches the mouse position, false otherwise

getPhotoIdxUnderMouse

private int getPhotoIdxUnderMouse(java.awt.event.MouseEvent evt,
                                  boolean cycle)

Returns index of the image that matches the position of the mouse event.

Parameters:

evt - Mouse event

cycle - Set to true to cycle through the photos at the current mouse position if multiple icons or thumbnails overlap. If set to false the topmost photo will be used.

Returns:

Image index at mouse position, range 0 .. size-1, or -1 if there is no image at the mouse position

getPhotoIdxUnderMouse

private int getPhotoIdxUnderMouse(java.awt.event.MouseEvent evt)

Returns index of the image that matches the position of the mouse event. The topmost photo is picked if multiple icons or thumbnails overlap.

Parameters:

evt - Mouse event

Returns:

Image index at mouse position, range 0 .. size-1, or -1 if there is no image at the mouse position

getPhotoUnderMouse

public ImageEntry getPhotoUnderMouse(java.awt.event.MouseEvent evt)

Returns the image that matches the position of the mouse event. The topmost photo is picked of multiple icons or thumbnails overlap.

Parameters:

evt - Mouse event

Returns:

Image at mouse position, or null if there is no image at the mouse position

Since:

6392

clearOtherCurrentPhotos

private void clearOtherCurrentPhotos()

Clears the currentPhoto of the other GeoImageLayer's. Otherwise there could be multiple selected photos.

registerSupportedMapMode

public static void registerSupportedMapMode(MapMode mapMode)

Registers a map mode for which the functionality of this layer should be available.

Parameters:

mapMode - Map mode to be registered

Since:

6392

isSupportedMapMode

private static boolean isSupportedMapMode(MapMode mapMode)

Determines if the functionality of this layer is available in the specified map mode. SelectAction and SelectLassoAction are supported by default, other map modes can be registered.

Parameters:

mapMode - Map mode to be checked

Returns:

true if the map mode is supported, false otherwise

hookUpMapView

public void hookUpMapView()

Description copied from class: Layer

Initialization code, that depends on Main.map.mapView. It is always called in the event dispatching thread. Note that Main.map is null as long as no layer has been added, so do not execute code in the constructor, that assumes Main.map.mapView is not null. If you need to execute code when this layer is added to the map view, use AbstractMapViewPaintable.attachToMapView(org.openstreetmap.josm.gui.layer.MapViewPaintable.MapViewEvent)

Overrides:

hookUpMapView in class Layer

destroy

public void destroy()

Description copied from class: Layer

Called, when the layer is removed from the mapview and is going to be destroyed. This is because the Layer constructor can not add itself safely as listener to the layerlist dialog, because there may be no such dialog yet (loaded via command line parameter).

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class Layer

attachToMapView

public MapViewPaintable.LayerPainter attachToMapView(MapViewPaintable.MapViewEvent event)

Description copied from class: AbstractMapViewPaintable

This method is called whenever this layer is added to a map view.

You need to return a painter here. The MapViewPaintable.LayerPainter.detachFromMapView(org.openstreetmap.josm.gui.layer.MapViewPaintable.MapViewEvent) method is called when the layer is removed from that map view. You are free to reuse painters.

You should always call the super method. See AbstractMapViewPaintable.createMapViewPainter(org.openstreetmap.josm.gui.layer.MapViewPaintable.MapViewEvent) if you want to influence painter creation.

This replaces Layer.hookUpMapView() in the long run.

Overrides:

attachToMapView in class AbstractMapViewPaintable

Parameters:

event - the event.

Returns:

A layer painter.

zoomChanged

public void zoomChanged()

Description copied from interface: NavigatableComponent.ZoomChangeListener

Method called when the zoom area has changed.

Specified by:

zoomChanged in interface NavigatableComponent.ZoomChangeListener

startLoadThumbs

public void startLoadThumbs()

Start to load thumbnails.

stopLoadThumbs

public void stopLoadThumbs()

Stop to load thumbnails. Can be called at any time to make sure that the thumbnail loader is stopped.

thumbsLoaded

public void thumbsLoaded()

Called to signal that the loading of thumbnails has finished. Usually called from ThumbsLoader in another thread.

updateBufferAndRepaint

public void updateBufferAndRepaint()

Marks the offscreen buffer to be updated.

getImages

public java.util.List<ImageEntry> getImages()

Get list of images in layer.

Returns:

List of images in layer

getImageData

public ImageData getImageData()

Returns the image data store being used by this layer

Returns:

imageData

Since:

14590

getGpxLayer

public GpxLayer getGpxLayer()

Returns the associated GPX layer.

Returns:

The associated GPX layer

getFauxGpxLayer

public GpxLayer getFauxGpxLayer()

Returns a faux GPX layer built from the images or the associated GPX layer.

Returns:

A faux GPX layer or the associated GPX layer

Since:

14802

jumpToNextMarker

public void jumpToNextMarker()

Description copied from interface: JumpToMarkerActions.JumpToMarkerLayer

Jump (move the viewport) to the next marker.

Specified by:

jumpToNextMarker in interface JumpToMarkerActions.JumpToMarkerLayer

jumpToPreviousMarker

public void jumpToPreviousMarker()

Description copied from interface: JumpToMarkerActions.JumpToMarkerLayer

Jump (move the viewport) to the previous marker.

Specified by:

jumpToPreviousMarker in interface JumpToMarkerActions.JumpToMarkerLayer

isUseThumbs

public boolean isUseThumbs()

Returns the current thumbnail display status. true: thumbnails are displayed, false: an icon is displayed instead of thumbnails.

Returns:

Current thumbnail display status

Since:

6392

setUseThumbs

public void setUseThumbs(boolean useThumbs)

Enables or disables the display of thumbnails. Does not update the display.

Parameters:

useThumbs - New thumbnail display status

Since:

6392

selectedImageChanged

public void selectedImageChanged(ImageData data)

Description copied from interface: ImageData.ImageDataUpdateListener

Called when the selection change

Specified by:

selectedImageChanged in interface ImageData.ImageDataUpdateListener

Parameters:

data - the image data

imageDataUpdated

public void imageDataUpdated(ImageData data)

Description copied from interface: ImageData.ImageDataUpdateListener

Called when the data change

Specified by:

imageDataUpdated in interface ImageData.ImageDataUpdateListener

Parameters:

data - the image data

getChangesetSourceTag

public java.lang.String getChangesetSourceTag()

Description copied from class: Layer

Get the source for the layer

Overrides:

getChangesetSourceTag in class Layer

Returns:

The string for the changeset source tag or null