org.openstreetmap.josm.gui.layer

Class AbstractTileSourceLayer<T extends AbstractTMSTileSource>

java.lang.Object

org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.ImageryLayer

org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer<T>

Type Parameters:

T - Tile Source class used for this layer

All Implemented Interfaces:

java.awt.image.ImageObserver, TileLoaderListener, ProjectionChangeListener, ImageryFilterSettings.FilterChangeListener, TileSourceDisplaySettings.DisplaySettingsChangeListener, MapViewPaintable, NavigatableComponent.ZoomChangeListener, Destroyable

Direct Known Subclasses:

AbstractCachedTileSourceLayer

public abstract class AbstractTileSourceLayer<T extends AbstractTMSTileSource>
extends ImageryLayer
implements java.awt.image.ImageObserver, TileLoaderListener, NavigatableComponent.ZoomChangeListener, ImageryFilterSettings.FilterChangeListener, TileSourceDisplaySettings.DisplaySettingsChangeListener

Base abstract class that supports displaying images provided by TileSource. It might be TMS source, WMS or WMTS It implements all standard functions of tilesource based layers: autozoom, tile reloads, layer saving, loading,etc.

Since:

3715, 8526 (copied from TMSLayer)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractTileSourceLayer.AutoLoadTilesAction
private class	AbstractTileSourceLayer.AutoZoomAction
private class	AbstractTileSourceLayer.DecreaseZoomAction
private class	AbstractTileSourceLayer.DeepTileSet
private class	AbstractTileSourceLayer.FlushTileCacheAction
private class	AbstractTileSourceLayer.IncreaseZoomAction
private class	AbstractTileSourceLayer.LoadAllTilesAction
private class	AbstractTileSourceLayer.LoadErroneusTilesAction
private class	AbstractTileSourceLayer.LoadTileAction
private static class	AbstractTileSourceLayer.MenuAddition Class to store a menu action and the class it belongs to.
class	AbstractTileSourceLayer.PrecacheTask Task responsible for precaching imagery along the gpx track
private class	AbstractTileSourceLayer.ShowErrorsAction
private class	AbstractTileSourceLayer.ShowTileInfoAction
private static class	AbstractTileSourceLayer.TileHolder Simple class to keep clickedTile within hookUpMapView
private class	AbstractTileSourceLayer.TileSet
private static class	AbstractTileSourceLayer.TileSetInfo
class	AbstractTileSourceLayer.TileSourceLayerPopup Tile source layer popup menu.
private class	AbstractTileSourceLayer.TileSourcePainter
private class	AbstractTileSourceLayer.ZoomToBestAction
private class	AbstractTileSourceLayer.ZoomToNativeLevelAction

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

ImageryLayer.ApplyOffsetAction, ImageryLayer.OffsetAction

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 java.awt.event.MouseAdapter	adapter
private ImageryAdjustAction	adjustAction
private AttributionSupport	attribution
private AbstractTileSourceLayer.TileHolder	clickedTileHolder
private TileCoordinateConverter	coordinateConverter
int	currentZoomLevel Zoomlevel at which tiles is currently downloaded.
private TileSourceDisplaySettings	displaySettings
private static java.awt.Font	InfoFont
private javax.swing.Timer	invalidateLaterTimer A timer that is used to delay invalidation events if required.
static int	MAX_ZOOM maximum zoom level supported
private static java.util.List<AbstractTileSourceLayer.MenuAddition>	menuAdditions additional layer menu actions
static int	MIN_ZOOM minium zoom level supported
private AbstractTileSourceLayer.TileSet	nullTileSet
private static java.lang.String	PREFERENCE_PREFIX
static IntegerProperty	PROP_MAX_ZOOM_LVL maximum zoom level to show to user
static IntegerProperty	PROP_MIN_ZOOM_LVL minimum zoom level to show to user
protected TileCache	tileCache
protected TileLoader	tileLoader
protected T	tileSource
static IntegerProperty	ZOOM_OFFSET Offset between calculated zoom level and zoom level used to download and show tiles.

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

icon, info, PROP_FADE_AMOUNT, PROP_FADE_COLOR, PROP_SHARPEN_LEVEL

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

FILTER_STATE_PROP, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractTileSourceLayer(ImageryInfo info) Creates Tile Source based Imagery Layer based on Imagery Info

Method Summary

Modifier and Type	Method and Description
private static boolean	actionSupportLayers(java.util.List<Layer> layers)
MapViewPaintable.LayerPainter	attachToMapView(MapViewPaintable.MapViewEvent event) This method is called whenever this layer is added to a map view.
static int	checkMaxZoomLvl(int maxZoomLvl, TileSource ts) Checks zoom level against settings
static int	checkMinZoomLvl(int minZoomLvl, TileSource ts) Checks zoom level against settings
void	clearTileCache(ProgressMonitor monitor) Clears the tile cache.
java.io.File	createAndOpenSaveFileChooser() Creates a new "Save" dialog for this layer and makes it visible. When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
protected TileSourceDisplaySettings	createDisplaySettings() This method creates the TileSourceDisplaySettings object.
protected MapViewPaintable.LayerPainter	createMapViewPainter(MapViewPaintable.MapViewEvent event) Creates a new LayerPainter.
boolean	decreaseZoomLevel() Zoom out from map.
void	destroy() Called, when the layer is removed from the mapview and is going to be destroyed.
void	displace(double dx, double dy) Deprecated. Use TileSourceDisplaySettings
void	displaySettingsChanged(TileSourceDisplaySettings.DisplaySettingsChangeEvent e) Called whenever the display settings have changed.
AbstractTileSourceLayer.PrecacheTask	downloadAreaToCache(ProgressMonitor progressMonitor, java.util.List<LatLon> points, double bufferX, double bufferY) Calculates tiles, that needs to be downloaded to cache, gets a current tile loader and creates a task to download all of the tiles.
private void	drawImageInside(java.awt.Graphics g, java.awt.Image sourceImg, java.awt.geom.Rectangle2D source, java.awt.geom.Rectangle2D border)
private void	drawInViewArea(java.awt.Graphics2D g, MapView mv, ProjectionBounds pb)
protected int	estimateTileCacheSize()
void	filterChanged() Invoked when the filter is changed.
protected javax.swing.Action	getAdjustAction()
protected int	getBestZoom()
javax.swing.Action[]	getCommonEntries() Returns the common menu entries.
TileSourceDisplaySettings	getDisplaySettings() Gets the TileSourceDisplaySettings instance associated with this tile source.
double	getDx() Deprecated. Use TileSourceDisplaySettings.getDx()
double	getDy() Deprecated. Use TileSourceDisplaySettings.getDy()
protected java.util.Map<java.lang.String,java.lang.String>	getHeaders(T tileSource)
java.lang.Object	getInfoComponent()
javax.swing.Action[]	getLayerListEntries() Returns the contextual menu entries in layer list dialog.
private java.awt.Image	getLoadedTileImage(Tile tile) Returns the image for the given tile image is loaded.
protected int	getMaxZoomLvl()
static int	getMaxZoomLvl(TileSource ts)
private java.util.List<javax.swing.Action>	getMenuAdditions() Prepare list of additional layer context menu entries.
javax.swing.Action[]	getMenuEntries() Returns list of actions.
protected int	getMinZoomLvl()
static int	getMinZoomLvl(TileSource ts)
private Tile	getOrCreateTile(int x, int y, int zoom)
private Tile	getOrCreateTile(TilePosition tilePosition)
private double	getScaleFactor(int zoom) Returns average number of screen pixels per tile pixel for current mapview
private ICoordinate	getShiftedCoord(EastNorth en)
private LatLon	getShiftedLatLon(EastNorth en)
private LatLon	getShiftedLatLon(ICoordinate latLon)
private Tile	getTile(int x, int y, int zoom) Returns tile at given position.
private Tile	getTile(TilePosition tilePosition)
private Tile	getTileForPixelpos(int px, int py) Returns tile for a pixel position.
protected abstract TileLoaderFactory	getTileLoaderFactory()
protected AbstractTileSourceLayer.TileSet	getTileSet(EastNorth topLeft, EastNorth botRight, int zoom) Create a TileSet by EastNorth bbox taking a layer shift in account
protected AbstractTileSourceLayer.TileSet	getTileSet(LatLon topLeft, LatLon botRight, int zoom) Create a TileSet by known LatLon bbox without layer shift correction
private static <S extends AbstractTMSTileSource> AbstractTileSourceLayer.TileSetInfo	getTileSetInfo(AbstractTileSourceLayer.TileSet ts)
protected abstract T	getTileSource() Creates and returns a new TileSource instance depending on ImageryLayer.info specified in the constructor.
java.lang.String	getToolTipText()
private AbstractTileSourceLayer.TileSet	getVisibleTileSet()
void	hookUpMapView() Creates popup menu items and binds to mouse actions
private boolean	imageLoaded(java.awt.Image i)
boolean	imageUpdate(java.awt.Image img, int infoflags, int x, int y, int width, int height)
boolean	increaseZoomLevel() Zoom in, go closer to map.
private void	initializeIfRequired()
protected void	initTileSource(T tileSource)
private void	invalidateLater() Invalidate the layer at a time in the future so taht the user still sees the interface responsive.
boolean	isChanged() Check changed status of layer
boolean	isSavable() Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).
protected void	loadAllErrorTiles(boolean force)
protected void	loadAllTiles(boolean force)
private boolean	loadTile(Tile tile, boolean force)
private void	myDrawString(java.awt.Graphics g, java.lang.String text, int x, int y)
void	paint(java.awt.Graphics2D g, MapView mv, Bounds bounds) Paint the dataset using the engine set.
private java.util.List<Tile>	paintTileImages(java.awt.Graphics g, AbstractTileSourceLayer.TileSet ts)
private java.util.List<Tile>	paintTileImages(java.awt.Graphics g, AbstractTileSourceLayer.TileSet ts, int zoom, Tile border)
private void	paintTileText(AbstractTileSourceLayer.TileSet ts, Tile tile, java.awt.Graphics g, MapView mv, int zoom, Tile t)
protected void	redraw() Initiates a repaint of Main.map
static void	registerMenuAddition(javax.swing.Action addition) Register an additional layer context menu entry.
static void	registerMenuAddition(javax.swing.Action addition, java.lang.Class<? extends AbstractTileSourceLayer<?>> clazz) Register an additional layer context menu entry for a imagery layer class.
static void	setMaxZoomLvl(int maxZoomLvl) Sets maximum zoom level, that layer will attempt show
static void	setMinZoomLvl(int minZoomLvl) Sets minimum zoom level, that layer will attempt show
void	setOffset(double dx, double dy) Deprecated. Use TileSourceDisplaySettings
boolean	setZoomLevel(int zoom) Sets the zoom level of the layer
private Tile	tempCornerTile(Tile t)
void	tileLoadingFinished(Tile tile, boolean success) Will be called if a new Tile has been loaded successfully.
void	visitBoundingBox(BoundingXYVisitor v)
void	zoomChanged() This fires every time the user changes the zoom, but also (due to ZoomChangeListener) - on all changes to visible map (panning/zooming)
boolean	zoomDecreaseAllowed() Check if zooming out is allowed
boolean	zoomIncreaseAllowed()

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

addImageProcessor, applyImageProcessors, create, createImageProcessor, getFadeColor, getFadeColorWithAlpha, getFilterSettings, getIcon, getImageProcessors, getInfo, getOffsetMenuItem, getOffsetMenuItem, getPPD, isMergable, mergeFrom, removeImageProcessor, toString

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

addPropertyChangeListener, checkSaveConditions, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getBaseColorProperty, getColorProperty, getDefaultLayerPosition, getName, getOpacity, getViewProjectionBounds, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible

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

addInvalidationListener, invalidate, removeInvalidationListener

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCE_PREFIX

private static final java.lang.String PREFERENCE_PREFIX

See Also:

Constant Field Values

MAX_ZOOM

public static final int MAX_ZOOM

maximum zoom level supported

See Also:

Constant Field Values

MIN_ZOOM

public static final int MIN_ZOOM

minium zoom level supported

See Also:

Constant Field Values

InfoFont

private static final java.awt.Font InfoFont

menuAdditions

private static java.util.List<AbstractTileSourceLayer.MenuAddition> menuAdditions

additional layer menu actions

PROP_MIN_ZOOM_LVL

public static final IntegerProperty PROP_MIN_ZOOM_LVL

minimum zoom level to show to user

PROP_MAX_ZOOM_LVL

public static final IntegerProperty PROP_MAX_ZOOM_LVL

maximum zoom level to show to user

currentZoomLevel

public int currentZoomLevel

Zoomlevel at which tiles is currently downloaded. Initial zoom lvl is set to bestZoom

attribution

private final AttributionSupport attribution

clickedTileHolder

private final AbstractTileSourceLayer.TileHolder clickedTileHolder

ZOOM_OFFSET

public static final IntegerProperty ZOOM_OFFSET

Offset between calculated zoom level and zoom level used to download and show tiles. Negative values will result in lower resolution of imagery useful in "retina" displays, positive values will result in higher resolution

tileCache

protected TileCache tileCache

tileSource

protected T extends AbstractTMSTileSource tileSource

tileLoader

protected TileLoader tileLoader

invalidateLaterTimer

private final javax.swing.Timer invalidateLaterTimer

A timer that is used to delay invalidation events if required.

adapter

private final java.awt.event.MouseAdapter adapter

displaySettings

private final TileSourceDisplaySettings displaySettings

adjustAction

private final ImageryAdjustAction adjustAction

coordinateConverter

private TileCoordinateConverter coordinateConverter

nullTileSet

private final AbstractTileSourceLayer.TileSet nullTileSet

Constructor Detail

AbstractTileSourceLayer

public AbstractTileSourceLayer(ImageryInfo info)

Creates Tile Source based Imagery Layer based on Imagery Info

Parameters:

info - imagery info

Method Detail

createDisplaySettings

protected TileSourceDisplaySettings createDisplaySettings()

This method creates the TileSourceDisplaySettings object. Subclasses may implement it to e.g. change the prefix.

Returns:

The object.

Since:

10568

getDisplaySettings

public TileSourceDisplaySettings getDisplaySettings()

Gets the TileSourceDisplaySettings instance associated with this tile source.

Returns:

The tile source display settings

Since:

10568

filterChanged

public void filterChanged()

Description copied from interface: ImageryFilterSettings.FilterChangeListener

Invoked when the filter is changed.

Specified by:

filterChanged in interface ImageryFilterSettings.FilterChangeListener

getTileLoaderFactory

protected abstract TileLoaderFactory getTileLoaderFactory()

getTileSource

protected abstract T getTileSource()

Creates and returns a new TileSource instance depending on ImageryLayer.info specified in the constructor.

Returns:

TileSource for specified ImageryInfo

Throws:

java.lang.IllegalArgumentException - when Imagery is not supported by layer

getHeaders

protected java.util.Map<java.lang.String,java.lang.String> getHeaders(T tileSource)

initTileSource

protected void initTileSource(T tileSource)

tileLoadingFinished

public void tileLoadingFinished(Tile tile,
                                boolean success)

Description copied from interface: TileLoaderListener

Will be called if a new Tile has been loaded successfully. Loaded can mean downloaded or loaded from file cache.

Specified by:

tileLoadingFinished in interface TileLoaderListener

Parameters:

tile - The tile

success - true if the tile has been loaded successfully, false otherwise

clearTileCache

public void clearTileCache(ProgressMonitor monitor)

Clears the tile cache. If the current tileLoader is an instance of OsmTileLoader, a new TmsTileClearController is created and passed to the according clearCache method.

Parameters:

monitor - not used in this implementation - as cache clear is instaneus

redraw

protected void redraw()

Initiates a repaint of Main.map

See Also:

Main.map, Component.repaint(), To trigger a repaint of all places where the layer is displayed.

getDx

@Deprecated
public double getDx()

Deprecated. Use TileSourceDisplaySettings.getDx()

Gets the x displacement of this layer. To be removed end of 2016

Overrides:

getDx in class ImageryLayer

Returns:

The x displacement.

getDy

@Deprecated
public double getDy()

Deprecated. Use TileSourceDisplaySettings.getDy()

Gets the y displacement of this layer. To be removed end of 2016

Overrides:

getDy in class ImageryLayer

Returns:

The y displacement.

displace

@Deprecated
public void displace(double dx,
                                 double dy)

Deprecated. Use TileSourceDisplaySettings

To be removed end of 2016

Overrides:

displace in class ImageryLayer

Parameters:

dx - deprecated

dy - deprecated

setOffset

@Deprecated
public void setOffset(double dx,
                                  double dy)

Deprecated. Use TileSourceDisplaySettings

Sets the displacement offset of this layer. The layer is automatically invalidated. To be removed end of 2016

Overrides:

setOffset in class ImageryLayer

Parameters:

dx - The x offset

dy - The y offset

getInfoComponent

public java.lang.Object getInfoComponent()

Overrides:

getInfoComponent in class ImageryLayer

getAdjustAction

protected javax.swing.Action getAdjustAction()

Specified by:

getAdjustAction in class ImageryLayer

getScaleFactor

private double getScaleFactor(int zoom)

Returns average number of screen pixels per tile pixel for current mapview

Parameters:

zoom - zoom level

Returns:

average number of screen pixels per tile pixel

getBestZoom

protected int getBestZoom()

actionSupportLayers

private static boolean actionSupportLayers(java.util.List<Layer> layers)

hookUpMapView

public void hookUpMapView()

Creates popup menu items and binds to mouse actions

Overrides:

hookUpMapView 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.

initializeIfRequired

private void initializeIfRequired()

createMapViewPainter

protected MapViewPaintable.LayerPainter createMapViewPainter(MapViewPaintable.MapViewEvent event)

Description copied from class: AbstractMapViewPaintable

Creates a new LayerPainter.

Overrides:

createMapViewPainter in class AbstractMapViewPaintable

Parameters:

event - The event that triggered the creation.

Returns:

The painter.

estimateTileCacheSize

protected int estimateTileCacheSize()

displaySettingsChanged

public void displaySettingsChanged(TileSourceDisplaySettings.DisplaySettingsChangeEvent e)

Description copied from interface: TileSourceDisplaySettings.DisplaySettingsChangeListener

Called whenever the display settings have changed.

Specified by:

displaySettingsChanged in interface TileSourceDisplaySettings.DisplaySettingsChangeListener

Parameters:

e - The change event.

checkMaxZoomLvl

public static int checkMaxZoomLvl(int maxZoomLvl,
                                  TileSource ts)

Checks zoom level against settings

Parameters:

maxZoomLvl - zoom level to check

ts - tile source to crosscheck with

Returns:

maximum zoom level, not higher than supported by tilesource nor set by the user

checkMinZoomLvl

public static int checkMinZoomLvl(int minZoomLvl,
                                  TileSource ts)

Checks zoom level against settings

Parameters:

minZoomLvl - zoom level to check

ts - tile source to crosscheck with

Returns:

minimum zoom level, not higher than supported by tilesource nor set by the user

getMaxZoomLvl

public static int getMaxZoomLvl(TileSource ts)

Parameters:

ts - TileSource for which we want to know maximum zoom level

Returns:

maximum max zoom level, that will be shown on layer

getMinZoomLvl

public static int getMinZoomLvl(TileSource ts)

Parameters:

ts - TileSource for which we want to know minimum zoom level

Returns:

minimum zoom level, that will be shown on layer

setMaxZoomLvl

public static void setMaxZoomLvl(int maxZoomLvl)

Sets maximum zoom level, that layer will attempt show

Parameters:

maxZoomLvl - maximum zoom level

setMinZoomLvl

public static void setMinZoomLvl(int minZoomLvl)

Sets minimum zoom level, that layer will attempt show

Parameters:

minZoomLvl - minimum zoom level

zoomChanged

public void zoomChanged()

This fires every time the user changes the zoom, but also (due to ZoomChangeListener) - on all changes to visible map (panning/zooming)

Specified by:

zoomChanged in interface NavigatableComponent.ZoomChangeListener

getMaxZoomLvl

protected int getMaxZoomLvl()

getMinZoomLvl

protected int getMinZoomLvl()

zoomIncreaseAllowed

public boolean zoomIncreaseAllowed()

Returns:

if its allowed to zoom in

increaseZoomLevel

public boolean increaseZoomLevel()

Zoom in, go closer to map.

Returns:

true, if zoom increasing was successful, false otherwise

setZoomLevel

public boolean setZoomLevel(int zoom)

Sets the zoom level of the layer

Parameters:

zoom - zoom level

Returns:

true, when zoom has changed to desired value, false if it was outside supported zoom levels

zoomDecreaseAllowed

public boolean zoomDecreaseAllowed()

Check if zooming out is allowed

Returns:

true, if zooming out is allowed (currentZoomLevel > minZoomLevel)

decreaseZoomLevel

public boolean decreaseZoomLevel()

Zoom out from map.

Returns:

true, if zoom increasing was successfull, false othervise

tempCornerTile

private Tile tempCornerTile(Tile t)

getOrCreateTile

private Tile getOrCreateTile(TilePosition tilePosition)

getOrCreateTile

private Tile getOrCreateTile(int x,
                             int y,
                             int zoom)

getTile

private Tile getTile(TilePosition tilePosition)

getTile

private Tile getTile(int x,
                     int y,
                     int zoom)

Returns tile at given position. This can and will return null for tiles that are not already in the cache.

Parameters:

x - tile number on the x axis of the tile to be retrieved

y - tile number on the y axis of the tile to be retrieved

zoom - zoom level of the tile to be retrieved

Returns:

tile at given position

loadTile

private boolean loadTile(Tile tile,
                         boolean force)

getVisibleTileSet

private AbstractTileSourceLayer.TileSet getVisibleTileSet()

loadAllTiles

protected void loadAllTiles(boolean force)

loadAllErrorTiles

protected void loadAllErrorTiles(boolean force)

imageUpdate

public boolean imageUpdate(java.awt.Image img,
                           int infoflags,
                           int x,
                           int y,
                           int width,
                           int height)

Specified by:

imageUpdate in interface java.awt.image.ImageObserver

invalidateLater

private void invalidateLater()

Invalidate the layer at a time in the future so taht the user still sees the interface responsive.

imageLoaded

private boolean imageLoaded(java.awt.Image i)

getLoadedTileImage

private java.awt.Image getLoadedTileImage(Tile tile)

Returns the image for the given tile image is loaded. Otherwise returns null.

Parameters:

tile - the Tile for which the image should be returned

Returns:

the image of the tile or null.

drawImageInside

private void drawImageInside(java.awt.Graphics g,
                             java.awt.Image sourceImg,
                             java.awt.geom.Rectangle2D source,
                             java.awt.geom.Rectangle2D border)

paintTileImages

private java.util.List<Tile> paintTileImages(java.awt.Graphics g,
                                             AbstractTileSourceLayer.TileSet ts)

paintTileImages

private java.util.List<Tile> paintTileImages(java.awt.Graphics g,
                                             AbstractTileSourceLayer.TileSet ts,
                                             int zoom,
                                             Tile border)

myDrawString

private void myDrawString(java.awt.Graphics g,
                          java.lang.String text,
                          int x,
                          int y)

paintTileText

private void paintTileText(AbstractTileSourceLayer.TileSet ts,
                           Tile tile,
                           java.awt.Graphics g,
                           MapView mv,
                           int zoom,
                           Tile t)

getShiftedLatLon

private LatLon getShiftedLatLon(EastNorth en)

getShiftedCoord

private ICoordinate getShiftedCoord(EastNorth en)

getShiftedLatLon

private LatLon getShiftedLatLon(ICoordinate latLon)

getTileSet

protected AbstractTileSourceLayer.TileSet getTileSet(EastNorth topLeft,
                                                     EastNorth botRight,
                                                     int zoom)

Create a TileSet by EastNorth bbox taking a layer shift in account

Parameters:

topLeft - top-left lat/lon

botRight - bottom-right lat/lon

zoom - zoom level

Returns:

the tile set

Since:

10651

getTileSet

protected AbstractTileSourceLayer.TileSet getTileSet(LatLon topLeft,
                                                     LatLon botRight,
                                                     int zoom)

Create a TileSet by known LatLon bbox without layer shift correction

Parameters:

topLeft - top-left lat/lon

botRight - bottom-right lat/lon

zoom - zoom level

Returns:

the tile set

Since:

10651

getTileSetInfo

private static <S extends AbstractTMSTileSource> AbstractTileSourceLayer.TileSetInfo getTileSetInfo(AbstractTileSourceLayer.TileSet ts)

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

drawInViewArea

private void drawInViewArea(java.awt.Graphics2D g,
                            MapView mv,
                            ProjectionBounds pb)

getTileForPixelpos

private Tile getTileForPixelpos(int px,
                                int py)

Returns tile for a pixel position.

This isn't very efficient, but it is only used when the user right-clicks on the map.

Parameters:

px - pixel X coordinate

py - pixel Y coordinate

Returns:

Tile at pixel position

registerMenuAddition

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

Register an additional layer context menu entry.

Parameters:

addition - additional menu action

Since:

11197

registerMenuAddition

public static void registerMenuAddition(javax.swing.Action addition,
                                        java.lang.Class<? extends AbstractTileSourceLayer<?>> clazz)

Register an additional layer context menu entry for a imagery layer class. The menu entry is valid for the specified class and subclasses thereof only.

Example:

 TMSLayer.registerMenuAddition(new TMSSpecificAction(), TMSLayer.class);
 

Parameters:

addition - additional menu action

clazz - class the menu action is registered for

Since:

11197

getMenuAdditions

private java.util.List<javax.swing.Action> getMenuAdditions()

Prepare list of additional layer context menu entries. The list is empty if there are no additional menu entries.

Returns:

list of additional layer context menu entries

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

getLayerListEntries

public javax.swing.Action[] getLayerListEntries()

Returns the contextual menu entries in layer list dialog.

Returns:

the contextual menu entries in layer list dialog

getCommonEntries

public javax.swing.Action[] getCommonEntries()

Returns the common menu entries.

Returns:

the common menu entries

getToolTipText

public java.lang.String getToolTipText()

Specified by:

getToolTipText in class Layer

Returns:

A small tooltip hint about some statistics for this layer.

visitBoundingBox

public void visitBoundingBox(BoundingXYVisitor v)

Specified by:

visitBoundingBox in class Layer

isChanged

public boolean isChanged()

Description copied from class: Layer

Check changed status of layer

Overrides:

isChanged in class Layer

Returns:

True if layer was changed since last paint

downloadAreaToCache

public AbstractTileSourceLayer.PrecacheTask downloadAreaToCache(ProgressMonitor progressMonitor,
                                                                java.util.List<LatLon> points,
                                                                double bufferX,
                                                                double bufferY)

Calculates tiles, that needs to be downloaded to cache, gets a current tile loader and creates a task to download all of the tiles. Buffer contains at least one tile. To prevent accidental clear of the queue, new download executor is created with separate queue

Parameters:

progressMonitor - progress monitor for download task

points - lat/lon coordinates to download

bufferX - how many units in current Coordinate Reference System to cover in X axis in both sides

bufferY - how many units in current Coordinate Reference System to cover in Y axis in both sides

Returns:

precache task representing download task

isSavable

public boolean isSavable()

Description copied from class: Layer

Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).

Overrides:

isSavable in class Layer

Returns:

true if this layer can be saved to a file

createAndOpenSaveFileChooser

public java.io.File createAndOpenSaveFileChooser()

Description copied from class: Layer

Creates a new "Save" dialog for this layer and makes it visible.
When the user has chosen a file, checks the file extension, and confirms overwrite if needed.

Overrides:

createAndOpenSaveFileChooser in class Layer

Returns:

The output File

See Also:

SaveActionBase.createAndOpenSaveFileChooser(java.lang.String, org.openstreetmap.josm.actions.ExtensionFileFilter)

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