Android SDK
API Reference
- Root
- attribution
- camera
- constants
- exceptions
- geometry
- http
- location
- location.engine
- location.modes
- location.permissions
- log
- maps
- maps.renderer
- maps.renderer.egl
- maps.renderer.glsurfaceview
- maps.renderer.textureview
- maps.widgets
- module.http
- module.loader
- net
- offline
- snapshotter
- storage
- style.expressions
- style.layers
- style.light
- style.sources
- style.types
- text
- utils
On This Page
Package com.mapbox.mapboxsdk.location.modes
Contains the Mapbox Location layer component camera and render modes.
Types
| Name | Summary |
|---|---|
| CameraMode | class CameraMode Contains the variety of camera modes which determine how the camera will track the user location. |
| RenderMode | class RenderMode Contains the variety of ways the user location can be rendered on the map. |
CameraMode
class CameraMode
Contains the variety of camera modes which determine how the camera will track the user location.
Types
| Name | Summary |
|---|---|
| Mode | @Retention(value = RetentionPolicy.SOURCE) annotation class Mode Determine the camera tracking behavior in the LocationComponent. |
Properties
| Name | Summary |
|---|---|
| NONE | val NONE: IntNo camera tracking. |
| NONE_COMPASS | val NONE_COMPASS: IntCamera does not track location, but does track compass bearing. |
| NONE_GPS | val NONE_GPS: IntCamera does not track location, but does track GPS Location bearing. |
| TRACKING | val TRACKING: IntCamera tracks the user location. |
| TRACKING_COMPASS | val TRACKING_COMPASS: IntCamera tracks the user location, with bearingprovided by a compass. |
| TRACKING_GPS | val TRACKING_GPS: IntCamera tracks the user location, with bearingprovided by a normalized getBearing. |
| TRACKING_GPS_NORTH | val TRACKING_GPS_NORTH: IntCamera tracks the user location, with bearingalways set to north (0). |
NONE
val NONE: Int
No camera tracking.
NONE_COMPASS
val NONE_COMPASS: Int
Camera does not track location, but does track compass bearing.
NONE_GPS
val NONE_GPS: Int
Camera does not track location, but does track GPS Location bearing.
TRACKING
val TRACKING: Int
Camera tracks the user location.
TRACKING_COMPASS
val TRACKING_COMPASS: Int
Camera tracks the user location, with bearingprovided by a compass.
TRACKING_GPS
val TRACKING_GPS: Int
Camera tracks the user location, with bearingprovided by a normalized getBearing.
TRACKING_GPS_NORTH
val TRACKING_GPS_NORTH: Int
Camera tracks the user location, with bearingalways set to north (0).
Mode
@Retention(value = RetentionPolicy.SOURCE)
annotation class Mode
Determine the camera tracking behavior in the LocationComponent.
Functions
| Name | Summary |
|---|---|
| annotationType | abstract fun annotationType(): Class |
| equals | abstract fun equals(p: Any): Boolean |
| hashCode | abstract fun hashCode(): Int |
| toString | abstract fun toString(): String |
RenderMode
class RenderMode
Contains the variety of ways the user location can be rendered on the map.
Types
| Name | Summary |
|---|---|
| Mode | @Retention(value = RetentionPolicy.SOURCE) annotation class Mode One of these constants should be used with setRenderMode. |
Properties
| Name | Summary |
|---|---|
| COMPASS | val COMPASS: IntTracking the user location with bearing consideredfrom a CompassEngine. |
| GPS | val GPS: IntTracking the user location with bearing considered from android.location.Location. |
| NORMAL | val NORMAL: IntBasic tracking is enabled, bearing ignored. |
COMPASS
val COMPASS: Int
Tracking the user location with bearing consideredfrom a CompassEngine.
GPS
val GPS: Int
Tracking the user location with bearing considered from android.location.Location.
NORMAL
val NORMAL: Int
Basic tracking is enabled, bearing ignored.
Mode
@Retention(value = RetentionPolicy.SOURCE)
annotation class Mode
One of these constants should be used with setRenderMode.Mode can be switched at anytime by calling the {@code setLocationLayerMode} method passingin the new mode you’d like the location layer to be in.
Functions
| Name | Summary |
|---|---|
| annotationType | abstract fun annotationType(): Class |
| equals | abstract fun equals(p: Any): Boolean |
| hashCode | abstract fun hashCode(): Int |
| toString | abstract fun toString(): String |