org.osmdroid.views.overlay

Class MinimapOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.TilesOverlay

org.osmdroid.views.overlay.MinimapOverlay

All Implemented Interfaces:

IOverlayMenuProvider, OverlayConstants

public class MinimapOverlay
extends TilesOverlay

Draws a mini-map as an overlay layer. It currently uses its own MapTileProviderBasic or a tile provider supplied to it. Do NOT share a tile provider amongst multiple tile drawing overlays - it will create an under-sized cache.

Author:

Marc Kurtz

Nested Class Summary

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

Overlay.Snappable

Field Summary

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

mDebugPaint, MENU_MAP_MODE, MENU_OFFLINE, MENU_TILE_SOURCE_STARTING_ID, mTileProvider

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

mResourceProxy, mScale, SHADOW_X_SKEW, SHADOW_Y_SCALE

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

DEBUGMODE, DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
MinimapOverlay(android.content.Context pContext, android.os.Handler pTileRequestCompleteHandler) Creates a MinimapOverlay that uses its own MapTileProviderBasic.
MinimapOverlay(android.content.Context pContext, android.os.Handler pTileRequestCompleteHandler, MapTileProviderBase pTileProvider) Creates a MinimapOverlay with the supplied tile provider.
MinimapOverlay(android.content.Context pContext, android.os.Handler pTileRequestCompleteHandler, MapTileProviderBase pTileProvider, int pZoomDifference) Creates a MinimapOverlay with the supplied tile provider.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	draw(android.graphics.Canvas c, MapView osmv, boolean shadow) Draw the overlay over the map.
int	getHeight() Gets the height of the mini-map in pixels
int	getPadding() Gets the number of pixels from the lower-right corner to offset the mini-map
int	getWidth() Gets the width of the mini-map in pixels
int	getZoomDifference()
boolean	isOptionsMenuEnabled() Can be used to signal to external callers that this Overlay should not be used for providing option menu items.
boolean	onDoubleTap(android.view.MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
boolean	onLongPress(android.view.MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
boolean	onSingleTapUp(android.view.MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
protected void	onTileReadyToDraw(android.graphics.Canvas c, android.graphics.drawable.Drawable currentMapTile, android.graphics.Rect tileRect)
void	setHeight(int height) Sets the height of the mini-map in pixels
void	setPadding(int padding) Sets the number of pixels from the lower-right corner to offset the mini-map
void	setTileSource(ITileSource pTileSource)
void	setWidth(int width) Sets the width of the mini-map in pixels
void	setZoomDifference(int zoomDifference)

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

drawTiles, getLoadingBackgroundColor, getLoadingLineColor, getMaximumZoomLevel, getMinimumZoomLevel, getOvershootTileCache, onCreateOptionsMenu, onDetach, onOptionsItemSelected, onPrepareOptionsMenu, setLoadingBackgroundColor, setLoadingLineColor, setOptionsMenuEnabled, setOvershootTileCache, setUseDataConnection, useDataConnection

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

drawAt, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onScroll, onShowPress, onSingleTapConfirmed, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

MinimapOverlay

public MinimapOverlay(android.content.Context pContext,
              android.os.Handler pTileRequestCompleteHandler,
              MapTileProviderBase pTileProvider,
              int pZoomDifference)

Creates a MinimapOverlay with the supplied tile provider. The Handler passed in is typically the same handler being used by the main map. The MapTileProviderBase passed in cannot be the same tile provider used in the TilesOverlay, it must be a new instance.

Parameters:

pContext - a context

pTileRequestCompleteHandler - a handler for the tile request complete notifications

pTileProvider - a tile provider

MinimapOverlay

public MinimapOverlay(android.content.Context pContext,
              android.os.Handler pTileRequestCompleteHandler,
              MapTileProviderBase pTileProvider)

Creates a MinimapOverlay with the supplied tile provider. The Handler passed in is typically the same handler being used by the main map. The MapTileProviderBase passed in cannot be the same tile provider used in the TilesOverlay, it must be a new instance.

Parameters:

pContext - a context

pTileRequestCompleteHandler - a handler for the tile request complete notifications

pTileProvider - a tile provider

MinimapOverlay

public MinimapOverlay(android.content.Context pContext,
              android.os.Handler pTileRequestCompleteHandler)

Creates a MinimapOverlay that uses its own MapTileProviderBasic. The Handler passed in is typically the same handler being used by the main map.

Parameters:

pContext - a context

pTileRequestCompleteHandler - a handler for tile request complete notifications

Method Detail

setTileSource

public void setTileSource(ITileSource pTileSource)

getZoomDifference

public int getZoomDifference()

setZoomDifference

public void setZoomDifference(int zoomDifference)

draw

protected void draw(android.graphics.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.

Overrides:

draw in class TilesOverlay

onTileReadyToDraw

protected void onTileReadyToDraw(android.graphics.Canvas c,
                     android.graphics.drawable.Drawable currentMapTile,
                     android.graphics.Rect tileRect)

Overrides:

onTileReadyToDraw in class TilesOverlay

onSingleTapUp

public boolean onSingleTapUp(android.view.MotionEvent pEvent,
                    MapView pMapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onSingleTapUp in class Overlay

onDoubleTap

public boolean onDoubleTap(android.view.MotionEvent pEvent,
                  MapView pMapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onDoubleTap in class Overlay

onLongPress

public boolean onLongPress(android.view.MotionEvent pEvent,
                  MapView pMapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onLongPress in class Overlay

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

Overrides:

isOptionsMenuEnabled in class TilesOverlay

setWidth

public void setWidth(int width)

Sets the width of the mini-map in pixels

Parameters:

width - the width to set in pixels

getWidth

public int getWidth()

Gets the width of the mini-map in pixels

Returns:

the width in pixels

setHeight

public void setHeight(int height)

Sets the height of the mini-map in pixels

Parameters:

height - the height to set in pixels

getHeight

public int getHeight()

Gets the height of the mini-map in pixels

Returns:

the height in pixels

setPadding

public void setPadding(int padding)

Sets the number of pixels from the lower-right corner to offset the mini-map

Parameters:

padding - the padding to set in pixels

getPadding

public int getPadding()

Gets the number of pixels from the lower-right corner to offset the mini-map

Returns:

the padding in pixels