com.mapbox.mapboxsdk.maps.widgets

Class CompassView

java.lang.Object

AppCompatImageView

com.mapbox.mapboxsdk.maps.widgets.CompassView

All Implemented Interfaces:

FocalPointChangeListener, java.lang.Runnable

public final class CompassView
extends AppCompatImageView
implements java.lang.Runnable, FocalPointChangeListener

UI element overlaid on a map to show the map's bearing when it isn't true north (0.0). Tapping the compass resets the bearing to true north and hides the compass.

You can change the behaviour of this View during initialisation with MapboxMapOptions, and xml attributes. While running you can use UiSettings.

Constructor Summary

Constructors

Constructor and Description
CompassView(android.content.Context context)
CompassView(android.content.Context context, android.util.AttributeSet attrs)
CompassView(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
void	fadeCompassViewFacingNorth(boolean compassFadeFacingNorth)
boolean	isFacingNorth()
boolean	isFadeCompassViewFacingNorth()
boolean	isHidden()
void	onFocalPointChanged(android.graphics.PointF pointF)
void	run()
void	setEnabled(boolean enabled)
void	setMapboxMap(MapboxMap mapboxMap)
void	update(double bearing) Updates the direction of the compass.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompassView

public CompassView(android.content.Context context)

CompassView

public CompassView(android.content.Context context,
                   android.util.AttributeSet attrs)

CompassView

public CompassView(android.content.Context context,
                   android.util.AttributeSet attrs,
                   int defStyleAttr)

Method Detail

setMapboxMap

public void setMapboxMap(MapboxMap mapboxMap)

isHidden

public boolean isHidden()

isFacingNorth

public boolean isFacingNorth()

setEnabled

public void setEnabled(boolean enabled)

update

public void update(double bearing)

Updates the direction of the compass.

Parameters:

bearing - the direction value of the map

fadeCompassViewFacingNorth

public void fadeCompassViewFacingNorth(boolean compassFadeFacingNorth)

isFadeCompassViewFacingNorth

public boolean isFadeCompassViewFacingNorth()

run

public void run()

Specified by:

run in interface java.lang.Runnable

onFocalPointChanged

public void onFocalPointChanged(android.graphics.PointF pointF)

Specified by:

onFocalPointChanged in interface FocalPointChangeListener