org.osmdroid.views.overlay

Class TilesOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.TilesOverlay

All Implemented Interfaces:

IOverlayMenuProvider, OverlayConstants

Direct Known Subclasses:

MinimapOverlay

public class TilesOverlay
extends Overlay
implements IOverlayMenuProvider

A TilesOverlay is responsible to display a MapTileIndex. These objects are the principle consumer of map tiles. see MapTileIndex for an overview of how tiles are acquired by this overlay.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TilesOverlay.CacheTileLooper A simple loop in order to collect all tiles' indices
protected class	TilesOverlay.OverlayTileLooper

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
static ColorFilter	INVERT_COLORS provides a night mode like affect by inverting the map tile colors
protected Paint	mDebugPaint
static int	MENU_MAP_MODE
static int	MENU_OFFLINE
static int	MENU_TILE_SOURCE_STARTING_ID
protected Projection	mProjection
protected MapTileProviderBase	mTileProvider Current tile source
protected RectL	mViewPort
(package private) static float[]	negate
protected Drawable	userSelectedLoadingDrawable

Fields inherited from class org.osmdroid.views.overlay.Overlay

mBounds, SHADOW_X_SKEW, SHADOW_Y_SCALE

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
TilesOverlay(MapTileProviderBase aTileProvider, Context aContext)
TilesOverlay(MapTileProviderBase aTileProvider, Context aContext, boolean horizontalWrapEnabled, boolean verticalWrapEnabled)

Method Summary

Modifier and Type	Method and Description
void	draw(Canvas c, MapView osmv, boolean shadow) Draw the overlay over the map.
void	drawTiles(Canvas c, Projection projection, double zoomLevel, RectL viewPort) This is meant to be a "pure" tile drawing function that doesn't take into account osmdroid-specific characteristics (like osmdroid's canvas's having 0,0 as the center rather than the upper-left corner).
protected Rect	getCanvasRect()
int	getLoadingBackgroundColor()
int	getLoadingLineColor()
int	getMaximumZoomLevel()
int	getMinimumZoomLevel()
protected Projection	getProjection()
boolean	isHorizontalWrapEnabled()
boolean	isOptionsMenuEnabled() Can be used to signal to external callers that this Overlay should not be used for providing option menu items.
boolean	isVerticalWrapEnabled()
boolean	onCreateOptionsMenu(Menu pMenu, int pMenuIdOffset, MapView pMapView)
void	onDetach(MapView pMapView) Override to perform clean up of resources before shutdown.
boolean	onOptionsItemSelected(MenuItem pItem, int pMenuIdOffset, MapView pMapView)
boolean	onPrepareOptionsMenu(Menu pMenu, int pMenuIdOffset, MapView pMapView)
protected void	onTileReadyToDraw(Canvas c, Drawable currentMapTile, Rect tileRect)
void	protectDisplayedTilesForCache(Canvas pCanvas, MapView pMapView) Populates the tile provider's memory cache with the list of displayed tiles
protected void	setCanvasRect(Rect pCanvasRect)
void	setColorFilter(ColorFilter filter) sets the current color filter, which is applied to tiles before being drawn to the screen.
void	setHorizontalWrapEnabled(boolean horizontalWrapEnabled)
void	setLoadingBackgroundColor(int pLoadingBackgroundColor) Set the color to use to draw the background while we're waiting for the tile to load.
void	setLoadingDrawable(Drawable drawable) See issue https://github.com/osmdroid/osmdroid/issues/330 customizable override for the grey grid
void	setLoadingLineColor(int pLoadingLineColor)
void	setOptionsMenuEnabled(boolean pOptionsMenuEnabled)
protected void	setProjection(Projection pProjection)
void	setUseDataConnection(boolean aMode) Set whether to use the network connection if it's available.
void	setVerticalWrapEnabled(boolean verticalWrapEnabled)
protected boolean	setViewPort(Canvas pCanvas, MapView pMapView) Get the area we are drawing to
boolean	useDataConnection() Whether to use the network connection if it's available.

Methods inherited from class org.osmdroid.views.overlay.Overlay

drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onPause, onResume, onScroll, onShowPress, onSingleTapConfirmed, onSingleTapUp, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

MENU_MAP_MODE

public static final int MENU_MAP_MODE

MENU_TILE_SOURCE_STARTING_ID

public static final int MENU_TILE_SOURCE_STARTING_ID

MENU_OFFLINE

public static final int MENU_OFFLINE

mTileProvider

protected final MapTileProviderBase mTileProvider

Current tile source

userSelectedLoadingDrawable

protected Drawable userSelectedLoadingDrawable

mDebugPaint

protected final Paint mDebugPaint

mViewPort

protected final RectL mViewPort

mProjection

protected Projection mProjection

negate

static final float[] negate

INVERT_COLORS

public static final ColorFilter INVERT_COLORS

provides a night mode like affect by inverting the map tile colors

Constructor Detail

TilesOverlay

public TilesOverlay(MapTileProviderBase aTileProvider,
                    Context aContext)

TilesOverlay

public TilesOverlay(MapTileProviderBase aTileProvider,
                    Context aContext,
                    boolean horizontalWrapEnabled,
                    boolean verticalWrapEnabled)

Method Detail

setLoadingDrawable

public void setLoadingDrawable(Drawable drawable)

See issue https://github.com/osmdroid/osmdroid/issues/330 customizable override for the grey grid

Parameters:

drawable -

Since:

5.2+

onDetach

public void onDetach(MapView pMapView)

Description copied from class: Overlay

Override to perform clean up of resources before shutdown. By default does nothing.

Overrides:

onDetach in class Overlay

getMinimumZoomLevel

public int getMinimumZoomLevel()

getMaximumZoomLevel

public int getMaximumZoomLevel()

useDataConnection

public boolean useDataConnection()

Whether to use the network connection if it's available.

setUseDataConnection

public void setUseDataConnection(boolean aMode)

Set whether to use the network connection if it's available.

Parameters:

aMode - if true use the network connection if it's available. if false don't use the network connection even if it's available.

protectDisplayedTilesForCache

public void protectDisplayedTilesForCache(Canvas pCanvas,
                                          MapView pMapView)

Populates the tile provider's memory cache with the list of displayed tiles

Since:

6.0.0

setViewPort

protected boolean setViewPort(Canvas pCanvas,
                              MapView pMapView)

Get the area we are drawing to

Returns:

true if the tiles are to be drawn

Since:

6.0.0

draw

public void draw(Canvas c,
                 MapView osmv,
                 boolean shadow)

Description copied from class: Overlay

Draw the overlay over the map. This will be called on all active overlays with shadow=true, to lay down the shadow layer, and then again on all overlays with shadow=false. Callers should check isEnabled() before calling draw(). By default, draws nothing. changed for 5.6 to be public see https://github.com/osmdroid/osmdroid/issues/466

Specified by:

draw in class Overlay

drawTiles

public void drawTiles(Canvas c,
                      Projection projection,
                      double zoomLevel,
                      RectL viewPort)

This is meant to be a "pure" tile drawing function that doesn't take into account osmdroid-specific characteristics (like osmdroid's canvas's having 0,0 as the center rather than the upper-left corner). Once the tile is ready to be drawn, it is passed to onTileReadyToDraw where custom manipulations can be made before drawing the tile.

setCanvasRect

protected void setCanvasRect(Rect pCanvasRect)

getCanvasRect

protected Rect getCanvasRect()

setProjection

protected void setProjection(Projection pProjection)

getProjection

protected Projection getProjection()

onTileReadyToDraw

protected void onTileReadyToDraw(Canvas c,
                                 Drawable currentMapTile,
                                 Rect tileRect)

setOptionsMenuEnabled

public void setOptionsMenuEnabled(boolean pOptionsMenuEnabled)

Specified by:

setOptionsMenuEnabled in interface IOverlayMenuProvider

isOptionsMenuEnabled

public boolean isOptionsMenuEnabled()

Description copied from interface: IOverlayMenuProvider

Can be used to signal to external callers that this Overlay should not be used for providing option menu items.

Specified by:

isOptionsMenuEnabled in interface IOverlayMenuProvider

onCreateOptionsMenu

public boolean onCreateOptionsMenu(Menu pMenu,
                                   int pMenuIdOffset,
                                   MapView pMapView)

Specified by:

onCreateOptionsMenu in interface IOverlayMenuProvider

onPrepareOptionsMenu

public boolean onPrepareOptionsMenu(Menu pMenu,
                                    int pMenuIdOffset,
                                    MapView pMapView)

Specified by:

onPrepareOptionsMenu in interface IOverlayMenuProvider

onOptionsItemSelected

public boolean onOptionsItemSelected(MenuItem pItem,
                                     int pMenuIdOffset,
                                     MapView pMapView)

Specified by:

onOptionsItemSelected in interface IOverlayMenuProvider

getLoadingBackgroundColor

public int getLoadingBackgroundColor()

setLoadingBackgroundColor

public void setLoadingBackgroundColor(int pLoadingBackgroundColor)

Set the color to use to draw the background while we're waiting for the tile to load.

Parameters:

pLoadingBackgroundColor - the color to use. If the value is Color.TRANSPARENT then there will be no loading tile.

getLoadingLineColor

public int getLoadingLineColor()

setLoadingLineColor

public void setLoadingLineColor(int pLoadingLineColor)

setColorFilter

public void setColorFilter(ColorFilter filter)

sets the current color filter, which is applied to tiles before being drawn to the screen. Use this to enable night mode or any other tile rendering adjustment as necessary. use null to clear. INVERT_COLORS provides color inversion for convenience and to support the previous night mode

Parameters:

filter -

Since:

5.1

isHorizontalWrapEnabled

public boolean isHorizontalWrapEnabled()

setHorizontalWrapEnabled

public void setHorizontalWrapEnabled(boolean horizontalWrapEnabled)

isVerticalWrapEnabled

public boolean isVerticalWrapEnabled()

setVerticalWrapEnabled

public void setVerticalWrapEnabled(boolean verticalWrapEnabled)