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. Notice, this class has some problems when the parent map view is rotation enabled. See https://github.com/osmdroid/osmdroid/issues/98 for a work around

Nested Class Summary

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

TilesOverlay.OverlayTileLooper

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

Overlay.Snappable

Field Summary

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

INVERT_COLORS, mDebugPaint, MENU_MAP_MODE, MENU_OFFLINE, MENU_SNAPSHOT, MENU_STATES, MENU_TILE_SOURCE_STARTING_ID, mProjection, mTileProvider, mViewPort, negate, 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
MinimapOverlay(Context pContext, Handler pTileRequestCompleteHandler) Creates a MinimapOverlay that uses its own MapTileProviderBasic.
MinimapOverlay(Context pContext, Handler pTileRequestCompleteHandler, MapTileProviderBase pTileProvider) Creates a MinimapOverlay with the supplied tile provider.
MinimapOverlay(Context pContext, Handler pTileRequestCompleteHandler, MapTileProviderBase pTileProvider, int pZoomDifference) Creates a MinimapOverlay with the supplied tile provider.

Method Summary

Modifier and Type	Method and Description
void	draw(Canvas c, Projection pProjection)
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(MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
boolean	onLongPress(MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
boolean	onSingleTapUp(MotionEvent pEvent, MapView pMapView) By default does nothing (return false).
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)
protected boolean	setViewPort(Canvas pCanvas, Projection pProjection) Get the area we are drawing to
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, getCanvasRect, getLoadingBackgroundColor, getLoadingLineColor, getMaximumZoomLevel, getMinimumZoomLevel, getProjection, getTileStates, isHorizontalWrapEnabled, isVerticalWrapEnabled, onCreateOptionsMenu, onDetach, onOptionsItemSelected, onPrepareOptionsMenu, onTileReadyToDraw, protectDisplayedTilesForCache, setCanvasRect, setColorFilter, setHorizontalWrapEnabled, setLoadingBackgroundColor, setLoadingDrawable, setLoadingLineColor, setOptionsMenuEnabled, setProjection, setUseDataConnection, setVerticalWrapEnabled, useDataConnection

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

draw, drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onPause, onResume, 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(Context pContext,
                      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(Context pContext,
                      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(Context pContext,
                      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

public void draw(Canvas c,
                 Projection pProjection)

Overrides:

draw in class TilesOverlay

onSingleTapUp

public boolean onSingleTapUp(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(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(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

setViewPort

protected boolean setViewPort(Canvas pCanvas,
                              Projection pProjection)

Description copied from class: TilesOverlay

Get the area we are drawing to

Overrides:

setViewPort in class TilesOverlay

Returns:

true if the tiles are to be drawn