org.osmdroid.views.overlay.mylocation

Class MyLocationNewOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.mylocation.MyLocationNewOverlay

All Implemented Interfaces:

IOverlayMenuProvider, IMyLocationConsumer, Overlay.Snappable, OverlayConstants

public class MyLocationNewOverlay
extends Overlay
implements IMyLocationConsumer, IOverlayMenuProvider, Overlay.Snappable

Nested Class Summary

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

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enableAutoStop if true, when the user pans the map, follow my location will automatically disable if false, when the user pans the map, the map will continue to follow current location
protected Paint	mCirclePaint
protected Bitmap	mDirectionArrowBitmap
protected float	mDirectionArrowCenterX
protected float	mDirectionArrowCenterY
protected boolean	mDrawAccuracyEnabled
static int	MENU_MY_LOCATION
protected boolean	mIsFollowing
protected MapView	mMapView
IMyLocationProvider	mMyLocationProvider
protected Paint	mPaint
protected Bitmap	mPersonBitmap
protected PointF	mPersonHotspot Coordinates the feet of the person are located scaled for display density.
protected float	mScale

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
MyLocationNewOverlay(IMyLocationProvider myLocationProvider, MapView mapView)
MyLocationNewOverlay(MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	disableFollowLocation() Disables "follow" functionality.
void	disableMyLocation() Disable location updates
void	draw(Canvas c, Projection pProjection)
protected void	drawMyLocation(Canvas canvas, Projection pj, Location lastFix)
void	enableFollowLocation() Enables "follow" functionality.
boolean	enableMyLocation() Enable receiving location updates from the provided IMyLocationProvider and show your location on the maps.
boolean	enableMyLocation(IMyLocationProvider myLocationProvider)
boolean	getEnableAutoStop()
Location	getLastFix()
GeoPoint	getMyLocation() Return a GeoPoint of the last known location, or null if not known.
IMyLocationProvider	getMyLocationProvider()
boolean	isDrawAccuracyEnabled() If enabled, an accuracy circle will be drawn around your current position.
boolean	isFollowLocationEnabled() If enabled, the map will center on your current location and automatically scroll as you move.
boolean	isMyLocationEnabled() If enabled, the map is receiving location updates and drawing your location on the map.
boolean	isOptionsMenuEnabled() Can be used to signal to external callers that this Overlay should not be used for providing option menu items.
boolean	onCreateOptionsMenu(Menu pMenu, int pMenuIdOffset, MapView pMapView)
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
void	onLocationChanged(Location location, IMyLocationProvider source) Call when a provider has a new location to consume.
boolean	onOptionsItemSelected(MenuItem pItem, int pMenuIdOffset, MapView pMapView)
void	onPause() Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
boolean	onPrepareOptionsMenu(Menu pMenu, int pMenuIdOffset, MapView pMapView)
void	onResume() Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
boolean	onSnapToItem(int x, int y, Point snapPoint, IMapView mapView) Checks to see if the given x and y are close enough to an item resulting in snapping the current action (e.g.
boolean	onTouchEvent(MotionEvent event, MapView mapView) You can prevent all(!) other Touch-related events from happening! By default does nothing (return false).
boolean	runOnFirstFix(Runnable runnable) Queues a runnable to be executed as soon as we have a location fix.
void	setDirectionArrow(Bitmap personBitmap, Bitmap directionArrowBitmap) fix for https://github.com/osmdroid/osmdroid/issues/249
void	setDrawAccuracyEnabled(boolean drawAccuracyEnabled) If enabled, an accuracy circle will be drawn around your current position.
void	setEnableAutoStop(boolean value)
protected void	setLocation(Location location)
protected void	setMyLocationProvider(IMyLocationProvider myLocationProvider)
void	setOptionsMenuEnabled(boolean pOptionsMenuEnabled)
void	setPersonHotspot(float x, float y)
void	setPersonIcon(Bitmap icon) enabls you to change the my location 'person' icon at runtime.
protected void	stopLocationProvider()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

mPaint

protected Paint mPaint

mCirclePaint

protected Paint mCirclePaint

mScale

protected final float mScale

mPersonBitmap

protected Bitmap mPersonBitmap

mDirectionArrowBitmap

protected Bitmap mDirectionArrowBitmap

mMapView

protected MapView mMapView

mMyLocationProvider

public IMyLocationProvider mMyLocationProvider

enableAutoStop

protected boolean enableAutoStop

if true, when the user pans the map, follow my location will automatically disable if false, when the user pans the map, the map will continue to follow current location

mIsFollowing

protected boolean mIsFollowing

mDrawAccuracyEnabled

protected boolean mDrawAccuracyEnabled

mPersonHotspot

protected final PointF mPersonHotspot

Coordinates the feet of the person are located scaled for display density.

mDirectionArrowCenterX

protected float mDirectionArrowCenterX

mDirectionArrowCenterY

protected float mDirectionArrowCenterY

MENU_MY_LOCATION

public static final int MENU_MY_LOCATION

Constructor Detail

MyLocationNewOverlay

public MyLocationNewOverlay(MapView mapView)

MyLocationNewOverlay

public MyLocationNewOverlay(IMyLocationProvider myLocationProvider,
                            MapView mapView)

Method Detail

setDirectionArrow

public void setDirectionArrow(Bitmap personBitmap,
                              Bitmap directionArrowBitmap)

fix for https://github.com/osmdroid/osmdroid/issues/249

Parameters:

personBitmap -

directionArrowBitmap -

onResume

public void onResume()

Description copied from class: Overlay

Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806

Overrides:

onResume in class Overlay

onPause

public void onPause()

Description copied from class: Overlay

Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806

Overrides:

onPause in class Overlay

onDetach

public void onDetach(MapView mapView)

Description copied from class: Overlay

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

Overrides:

onDetach in class Overlay

setDrawAccuracyEnabled

public void setDrawAccuracyEnabled(boolean drawAccuracyEnabled)

If enabled, an accuracy circle will be drawn around your current position.

Parameters:

drawAccuracyEnabled - whether the accuracy circle will be enabled

isDrawAccuracyEnabled

public boolean isDrawAccuracyEnabled()

If enabled, an accuracy circle will be drawn around your current position.

Returns:

true if enabled, false otherwise

getMyLocationProvider

public IMyLocationProvider getMyLocationProvider()

setMyLocationProvider

protected void setMyLocationProvider(IMyLocationProvider myLocationProvider)

setPersonHotspot

public void setPersonHotspot(float x,
                             float y)

drawMyLocation

protected void drawMyLocation(Canvas canvas,
                              Projection pj,
                              Location lastFix)

draw

public void draw(Canvas c,
                 Projection pProjection)

Overrides:

draw in class Overlay

onSnapToItem

public boolean onSnapToItem(int x,
                            int y,
                            Point snapPoint,
                            IMapView mapView)

Description copied from interface: Overlay.Snappable

Checks to see if the given x and y are close enough to an item resulting in snapping the current action (e.g. zoom) to the item.

Specified by:

onSnapToItem in interface Overlay.Snappable

Parameters:

x - The x in screen coordinates.

y - The y in screen coordinates.

snapPoint - To be filled with the the interesting point (in screen coordinates) that is closest to the given x and y. Can be untouched if not snapping.

mapView - The MapView that is requesting the snap. Use MapView.getProjection() to convert between on-screen pixels and latitude/longitude pairs.

Returns:

Whether or not to snap to the interesting point.

setEnableAutoStop

public void setEnableAutoStop(boolean value)

getEnableAutoStop

public boolean getEnableAutoStop()

onTouchEvent

public boolean onTouchEvent(MotionEvent event,
                            MapView mapView)

Description copied from class: Overlay

You can prevent all(!) other Touch-related events from happening!
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:

onTouchEvent in class Overlay

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

getMyLocation

public GeoPoint getMyLocation()

Return a GeoPoint of the last known location, or null if not known.

getLastFix

public Location getLastFix()

enableFollowLocation

public void enableFollowLocation()

Enables "follow" functionality. The map will center on your current location and automatically scroll as you move. Scrolling the map in the UI will disable.

disableFollowLocation

public void disableFollowLocation()

Disables "follow" functionality.

isFollowLocationEnabled

public boolean isFollowLocationEnabled()

If enabled, the map will center on your current location and automatically scroll as you move. Scrolling the map in the UI will disable.

Returns:

true if enabled, false otherwise

onLocationChanged

public void onLocationChanged(Location location,
                              IMyLocationProvider source)

Description copied from interface: IMyLocationConsumer

Call when a provider has a new location to consume. This can be called on any thread.

Specified by:

onLocationChanged in interface IMyLocationConsumer

setLocation

protected void setLocation(Location location)

enableMyLocation

public boolean enableMyLocation(IMyLocationProvider myLocationProvider)

enableMyLocation

public boolean enableMyLocation()

Enable receiving location updates from the provided IMyLocationProvider and show your location on the maps. You will likely want to call enableMyLocation() from your Activity's Activity.onResume() method, to enable the features of this overlay. Remember to call the corresponding disableMyLocation() in your Activity's Activity.onPause() method to turn off updates when in the background.

disableMyLocation

public void disableMyLocation()

Disable location updates

stopLocationProvider

protected void stopLocationProvider()

isMyLocationEnabled

public boolean isMyLocationEnabled()

If enabled, the map is receiving location updates and drawing your location on the map.

Returns:

true if enabled, false otherwise

runOnFirstFix

public boolean runOnFirstFix(Runnable runnable)

Queues a runnable to be executed as soon as we have a location fix. If we already have a fix, we'll execute the runnable immediately and return true. If not, we'll hang on to the runnable and return false; as soon as we get a location fix, we'll run it in in a new thread.

setPersonIcon

public void setPersonIcon(Bitmap icon)

enabls you to change the my location 'person' icon at runtime. note that the hotspot is not updated with this method. see setPersonHotspot(float, float)

Parameters:

icon -