org.osmdroid.views.overlay.compass

Class CompassOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.compass.CompassOverlay

All Implemented Interfaces:

IOrientationConsumer, IOverlayMenuProvider, OverlayConstants

public class CompassOverlay
extends Overlay
implements IOverlayMenuProvider, IOrientationConsumer

Note: the compass overlay causes issues on API 8 devices. See https://github.com/osmdroid/osmdroid/issues/218

Note: this class can cause issues if you're also relying on MapView.addOnFirstLayoutListener(org.osmdroid.views.MapView.OnFirstLayoutListener) If you happen to be using both, see Issue 324

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 Bitmap	mCompassFrameBitmap
protected float	mCompassFrameCenterX
protected float	mCompassFrameCenterY
protected Bitmap	mCompassRoseBitmap
protected float	mCompassRoseCenterX
protected float	mCompassRoseCenterY
static int	MENU_COMPASS
protected long	mLastRender
protected MapView	mMapView
IOrientationProvider	mOrientationProvider
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
CompassOverlay(Context context, IOrientationProvider orientationProvider, MapView mapView)
CompassOverlay(Context context, MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	disableCompass() Disable orientation updates.
void	draw(Canvas c, Projection pProjection)
protected void	drawCompass(Canvas canvas, float bearing, Rect screenRect)
boolean	enableCompass() Enable receiving orientation updates from the provided IOrientationProvider and show a compass on the map.
boolean	enableCompass(IOrientationProvider orientationProvider)
float	getAzimuthOffset()
float	getOrientation()
IOrientationProvider	getOrientationProvider()
boolean	isCompassEnabled() If enabled, the map is receiving orientation updates and drawing your location on the map.
boolean	isCompassInCenter()
boolean	isOptionsMenuEnabled() Can be used to signal to external callers that this Overlay should not be used for providing option menu items.
boolean	isPointerMode()
boolean	onCreateOptionsMenu(Menu pMenu, int pMenuIdOffset, MapView pMapView)
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
boolean	onOptionsItemSelected(MenuItem pItem, int pMenuIdOffset, MapView pMapView)
void	onOrientationChanged(float orientation, IOrientationProvider source)
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
void	setAzimuthOffset(float f) An offset added to the bearing when drawing the compass.
void	setCompassCenter(float x, float y)
void	setCompassInCenter(boolean b) Put the compass in the center of the map regardless of the supplied coordinates.
void	setOptionsMenuEnabled(boolean pOptionsMenuEnabled)
void	setOrientationProvider(IOrientationProvider orientationProvider)
void	setPointerMode(boolean usePointArrow) The compass can operate in two modes.

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, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

mMapView

protected MapView mMapView

mOrientationProvider

public IOrientationProvider mOrientationProvider

mCompassFrameBitmap

protected Bitmap mCompassFrameBitmap

mCompassRoseBitmap

protected Bitmap mCompassRoseBitmap

mCompassFrameCenterX

protected final float mCompassFrameCenterX

mCompassFrameCenterY

protected final float mCompassFrameCenterY

mCompassRoseCenterX

protected final float mCompassRoseCenterX

mCompassRoseCenterY

protected final float mCompassRoseCenterY

mLastRender

protected long mLastRender

MENU_COMPASS

public static final int MENU_COMPASS

mScale

protected final float mScale

Constructor Detail

CompassOverlay

public CompassOverlay(Context context,
                      MapView mapView)

CompassOverlay

public CompassOverlay(Context context,
                      IOrientationProvider orientationProvider,
                      MapView mapView)

Method Detail

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

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

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

setCompassCenter

public void setCompassCenter(float x,
                             float y)

setCompassInCenter

public void setCompassInCenter(boolean b)

Put the compass in the center of the map regardless of the supplied coordinates.

isCompassInCenter

public boolean isCompassInCenter()

setAzimuthOffset

public void setAzimuthOffset(float f)

An offset added to the bearing when drawing the compass. eg. to account for local magnetic declination to indicate true north

getAzimuthOffset

public float getAzimuthOffset()

getOrientationProvider

public IOrientationProvider getOrientationProvider()

setOrientationProvider

public void setOrientationProvider(IOrientationProvider orientationProvider)
                            throws RuntimeException

Throws:

RuntimeException

drawCompass

protected void drawCompass(Canvas canvas,
                           float bearing,
                           Rect screenRect)

draw

public void draw(Canvas c,
                 Projection pProjection)

Overrides:

draw 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

onOrientationChanged

public void onOrientationChanged(float orientation,
                                 IOrientationProvider source)

Specified by:

onOrientationChanged in interface IOrientationConsumer

Parameters:

orientation - this is magnetic north, not true north

enableCompass

public boolean enableCompass(IOrientationProvider orientationProvider)

enableCompass

public boolean enableCompass()

Enable receiving orientation updates from the provided IOrientationProvider and show a compass on the map. You will likely want to call enableCompass() from your Activity's Activity.onResume() method, to enable the features of this overlay. Remember to call the corresponding disableCompass() in your Activity's Activity.onPause() method to turn off updates when in the background.

disableCompass

public void disableCompass()

Disable orientation updates. Note the behavior has changed since v6.0.0. This method no longer releases references to the orientation provider. Instead, that happens in the onDetached method.

isCompassEnabled

public boolean isCompassEnabled()

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

Returns:

true if enabled, false otherwise

getOrientation

public float getOrientation()

setPointerMode

public void setPointerMode(boolean usePointArrow)

The compass can operate in two modes.

• false - a conventional compass needle pointing north/south (false, default)
• true - a pointer arrow that indicates the device's real world orientation on the map (true)

A different picture is used in each case.

Parameters:

usePointArrow - if true the pointer arrow is used, otherwise a compass rose is used

Since:

6.0.0

isPointerMode

public boolean isPointerMode()

Returns:

true if we are in pointer mode, instead of compass mode

Since:

6.0.0