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	isAllDismissTrackingOnGesture() Returns if all tracking modes will be dismissed when a gesture occurs.
boolean	isBearingTrackingDisabled() Retyrns uf bearing tracking is disabled
boolean	isDismissBearingTrackingOnGesture() Returns if bearing will disabled when a gesture occurs
boolean	isDismissLocationTrackingOnGesture() Returns if the location tracking will be disabled when a gesture occurs
boolean	isDismissTrackingOnGesture() Deprecated. use @link #isAllDismissTrackingOnGestureinstead
boolean	isLocationTrackingDisabled() Returns if location tracking is disabled
void	setDismissAllTrackingOnGesture(boolean dismissTrackingOnGesture) Set the dismissal of the tracking modes if a gesture occurs.
void	setDismissBearingTrackingOnGesture(boolean dismissBearingTrackingOnGesture) Set the dismissal of the bearing tracking modes if a gesture occurs.
void	setDismissLocationTrackingOnGesture(boolean dismissLocationTrackingOnGesture) Set the dismissal of the tracking modes if a gesture occurs.
void	setDismissTrackingOnGesture(boolean dismissTrackingOnGesture) Deprecated. use @link #setDismissAllTrackingOnGesture instead
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 MyLocationView 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

@Deprecated
public boolean isDismissTrackingOnGesture()

Deprecated. use @link #isAllDismissTrackingOnGestureinstead

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

Returns:

True to indicate the tracking modes will be dismissed.

isAllDismissTrackingOnGesture

public boolean isAllDismissTrackingOnGesture()

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

Returns:

True to indicate that location and bearing tracking will be dismissed.

setDismissTrackingOnGesture

@Deprecated
public void setDismissTrackingOnGesture(boolean dismissTrackingOnGesture)

Deprecated. use @link #setDismissAllTrackingOnGesture instead

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

Parameters:

dismissTrackingOnGesture - True to dismiss the tracking modes.

setDismissAllTrackingOnGesture

public void setDismissAllTrackingOnGesture(boolean dismissTrackingOnGesture)

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

Parameters:

dismissTrackingOnGesture - True to dismiss all the tracking modes.

setDismissLocationTrackingOnGesture

public void setDismissLocationTrackingOnGesture(boolean dismissLocationTrackingOnGesture)

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

Parameters:

dismissLocationTrackingOnGesture - True to dismiss the location tracking mode.

isDismissLocationTrackingOnGesture

public boolean isDismissLocationTrackingOnGesture()

Returns if the location tracking will be disabled when a gesture occurs

Returns:

True if location tracking will be disabled.

setDismissBearingTrackingOnGesture

public void setDismissBearingTrackingOnGesture(boolean dismissBearingTrackingOnGesture)

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

Parameters:

dismissBearingTrackingOnGesture - True to dimsiss the bearinf tracking mode

isDismissBearingTrackingOnGesture

public boolean isDismissBearingTrackingOnGesture()

Returns if bearing will disabled when a gesture occurs

Returns:

True if bearing tracking will be disabled

isLocationTrackingDisabled

public boolean isLocationTrackingDisabled()

Returns if location tracking is disabled

Returns:

True if location tracking is disabled.

isBearingTrackingDisabled

public boolean isBearingTrackingDisabled()

Retyrns uf bearing tracking is disabled

Returns:

True if bearing tracking will be disabled.