org.mapsforge.applications.android.samples

Class MyLocationOverlay

java.lang.Object

org.mapsforge.map.layer.Layer

org.mapsforge.applications.android.samples.MyLocationOverlay

All Implemented Interfaces:

android.location.LocationListener

public class MyLocationOverlay
extends org.mapsforge.map.layer.Layer
implements android.location.LocationListener

A thread-safe Layer implementation to display the current location. NOTE: This code really does not reflect Android best practice and used in production leads to bad user experience (e.g. long time to first fix, excessive battery use, non-compliance with the Android lifecycle...). Best use the new location services provided by Google Play Services. Also note that MyLocationOverlay needs to be added to a view before requesting location updates (otherwise no DisplayModel is set).

Field Summary

Fields inherited from class org.mapsforge.map.layer.Layer

displayModel

Constructor Summary

Constructors

Constructor and Description
MyLocationOverlay(android.content.Context context, org.mapsforge.map.model.MapViewPosition mapViewPosition, org.mapsforge.core.graphics.Bitmap bitmap) Constructs a new MyLocationOverlay with the default circle paints.
MyLocationOverlay(android.content.Context context, org.mapsforge.map.model.MapViewPosition mapViewPosition, org.mapsforge.core.graphics.Bitmap bitmap, org.mapsforge.core.graphics.Paint circleFill, org.mapsforge.core.graphics.Paint circleStroke) Constructs a new MyLocationOverlay with the given circle paints.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableMyLocation() Stops the receiving of location updates.
void	draw(org.mapsforge.core.model.BoundingBox boundingBox, byte zoomLevel, org.mapsforge.core.graphics.Canvas canvas, org.mapsforge.core.model.Point topLeftPoint)
boolean	enableMyLocation(boolean centerAtFirstFix) Enables the receiving of location updates from the most accurate LocationProvider available.
android.location.Location	getLastLocation()
boolean	isCenterAtNextFix()
boolean	isMyLocationEnabled()
boolean	isSnapToLocationEnabled()
static org.mapsforge.core.model.LatLong	locationToLatLong(android.location.Location location)
void	onDestroy()
void	onLocationChanged(android.location.Location location)
void	onProviderDisabled(String provider)
void	onProviderEnabled(String provider)
void	onStatusChanged(String provider, int status, android.os.Bundle extras)
void	setMinDistance(float minDistance) Minimum distance between location updates, in meters.
void	setMinTime(long minTime) Minimum time interval between location updates, in milliseconds.
void	setSnapToLocationEnabled(boolean snapToLocationEnabled)

Methods inherited from class org.mapsforge.map.layer.Layer

getPosition, isVisible, onAdd, onLongPress, onRemove, onTap, requestRedraw, setDisplayModel, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

MyLocationOverlay

public MyLocationOverlay(android.content.Context context,
                 org.mapsforge.map.model.MapViewPosition mapViewPosition,
                 org.mapsforge.core.graphics.Bitmap bitmap)

Constructs a new MyLocationOverlay with the default circle paints.

Parameters:

context - a reference to the application context.

mapViewPosition - the MapViewPosition whose location will be updated.

bitmap - a bitmap to display at the current location (might be null).

MyLocationOverlay

public MyLocationOverlay(android.content.Context context,
                 org.mapsforge.map.model.MapViewPosition mapViewPosition,
                 org.mapsforge.core.graphics.Bitmap bitmap,
                 org.mapsforge.core.graphics.Paint circleFill,
                 org.mapsforge.core.graphics.Paint circleStroke)

Constructs a new MyLocationOverlay with the given circle paints.

Parameters:

context - a reference to the application context.

mapViewPosition - the MapViewPosition whose location will be updated.

bitmap - a bitmap to display at the current location (might be null).

circleFill - the Paint used to fill the circle that represents the accuracy of the current location (might be null).

circleStroke - the Paint used to stroke the circle that represents the accuracy of the current location (might be null).

Method Detail

locationToLatLong

public static org.mapsforge.core.model.LatLong locationToLatLong(android.location.Location location)

Parameters:

location - the location whose geographical coordinates should be converted.

Returns:

a new LatLong with the geographical coordinates taken from the given location.

disableMyLocation

public void disableMyLocation()

Stops the receiving of location updates. Has no effect if location updates are already disabled.

draw

public void draw(org.mapsforge.core.model.BoundingBox boundingBox,
        byte zoomLevel,
        org.mapsforge.core.graphics.Canvas canvas,
        org.mapsforge.core.model.Point topLeftPoint)

Specified by:

draw in class org.mapsforge.map.layer.Layer

enableMyLocation

public boolean enableMyLocation(boolean centerAtFirstFix)

Enables the receiving of location updates from the most accurate LocationProvider available.

Parameters:

centerAtFirstFix - whether the map should be centered to the first received location fix.

Returns:

true if at least one location provider was found, false otherwise.

getLastLocation

public android.location.Location getLastLocation()

Returns:

the most-recently received location fix (might be null).

isCenterAtNextFix

public boolean isCenterAtNextFix()

Returns:

true if the map will be centered at the next received location fix, false otherwise.

isMyLocationEnabled

public boolean isMyLocationEnabled()

Returns:

true if the receiving of location updates is currently enabled, false otherwise.

isSnapToLocationEnabled

public boolean isSnapToLocationEnabled()

Returns:

true if the snap-to-location mode is enabled, false otherwise.

onDestroy

public void onDestroy()

Overrides:

onDestroy in class org.mapsforge.map.layer.Layer

onLocationChanged

public void onLocationChanged(android.location.Location location)

Specified by:

onLocationChanged in interface android.location.LocationListener

onProviderDisabled

public void onProviderDisabled(String provider)

Specified by:

onProviderDisabled in interface android.location.LocationListener

onProviderEnabled

public void onProviderEnabled(String provider)

Specified by:

onProviderEnabled in interface android.location.LocationListener

onStatusChanged

public void onStatusChanged(String provider,
                   int status,
                   android.os.Bundle extras)

Specified by:

onStatusChanged in interface android.location.LocationListener

setMinDistance

public void setMinDistance(float minDistance)

Minimum distance between location updates, in meters. You should call this before calling enableMyLocation(boolean).

setMinTime

public void setMinTime(long minTime)

Minimum time interval between location updates, in milliseconds. You should call this before calling enableMyLocation(boolean).

setSnapToLocationEnabled

public void setSnapToLocationEnabled(boolean snapToLocationEnabled)

Parameters:

snapToLocationEnabled - whether the map should be centered at each received location fix.