com.mapbox.mapboxsdk.maps

Class TrackingSettings

java.lang.Object

com.mapbox.mapboxsdk.maps.TrackingSettings

public class TrackingSettings
extends java.lang.Object

Settings for the user location and bearing tracking of a MapboxMap.

Method Summary

Modifier and Type	Method and Description
int	getMyBearingTrackingMode() Returns the current user bearing tracking mode.
int	getMyLocationTrackingMode() Returns the current user location tracking mode.
boolean	isDismissTrackingOnGesture() Returns if the tracking modes will be dismissed when a gesture occurs.
boolean	isLocationTrackingDisabled() Return if location tracking is disabled
void	setDismissTrackingOnGesture(boolean dismissTrackingOnGesture) Set the dismissal of the tracking modes if a gesture occurs.
void	setMyBearingTrackingMode(int myBearingTrackingMode) Set the current my bearing tracking mode.
void	setMyLocationTrackingMode(int myLocationTrackingMode) Set the current my location tracking mode.

Methods inherited from class java.lang.Object

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

Method Detail

setMyLocationTrackingMode

public void setMyLocationTrackingMode(int myLocationTrackingMode)

Set the current my location tracking mode.

Will enable my location if not active.

See MyLocationTracking for different values.

Parameters:

myLocationTrackingMode - The location tracking mode to be used.

Throws:

java.lang.SecurityException - if no suitable permission is present

See Also:

MyLocationTracking

getMyLocationTrackingMode

public int getMyLocationTrackingMode()

Returns the current user location tracking mode.

Returns:

The current user location tracking mode. One of the values from MyLocationTracking.Mode.

See Also:

MyLocationTracking.Mode

setMyBearingTrackingMode

public void setMyBearingTrackingMode(int myBearingTrackingMode)

Set the current my bearing tracking mode.

Shows the direction the user is heading.

When location tracking is disabled the direction of UserLocationView is rotated When location tracking is enabled the MapView is rotated based on bearing value.

See MyBearingTracking for different values.

Parameters:

myBearingTrackingMode - The bearing tracking mode to be used.

Throws:

java.lang.SecurityException - if no suitable permission is present

See Also:

MyBearingTracking

getMyBearingTrackingMode

public int getMyBearingTrackingMode()

Returns the current user bearing tracking mode. See MyBearingTracking for possible return values.

Returns:

the current user bearing tracking mode.

See Also:

MyBearingTracking

isDismissTrackingOnGesture

public boolean isDismissTrackingOnGesture()

Returns if the tracking modes will be dismissed when a gesture occurs.

Returns:

True to indicate the tracking modes will be dismissed.

setDismissTrackingOnGesture

public void setDismissTrackingOnGesture(boolean dismissTrackingOnGesture)

Set the dismissal of the tracking modes if a gesture occurs.

Parameters:

dismissTrackingOnGesture - True to dismiss the tracking modes.

isLocationTrackingDisabled

public boolean isLocationTrackingDisabled()

Return if location tracking is disabled

Returns:

True if location tracking is disabled.