Mapbox Maps Android/com.mapbox.maps.plugin.location/LocationPluginImpl/setCameraMode

setCameraMode

Sets the camera mode, which determines how the map camera will track the rendered location.

When camera is transitioning to a new mode, it will reject inputs like .zoomWhileTracking or .tiltWhileTracking. Use OnLocationCameraTransitionListener to listen for the transition state.

CameraMode.NONE: No camera tracking
CameraMode.NONE_COMPASS: Camera does not track location, but does track compass bearing
CameraMode.NONE_GPS: Camera does not track location, but does track GPS bearing
CameraMode.TRACKING: Camera tracks the user location
CameraMode.TRACKING_COMPASS: Camera tracks the user location, with bearing provided by a compass
CameraMode.TRACKING_GPS: Camera tracks the user location, with normalized bearing
CameraMode.TRACKING_GPS_NORTH: Camera tracks the user location, with bearing always set to north

Parameters

cameraMode

one of the modes found in CameraMode

transitionListener

callback that's going to be invoked when the transition animation finishes

fun setCameraMode(cameraMode: CameraMode, transitionListener: OnLocationCameraTransitionListener?)

Sets the camera mode, which determines how the map camera will track the rendered location.

When camera is transitioning to a new mode, it will reject inputs like .zoomWhileTracking or .tiltWhileTracking. Use OnLocationCameraTransitionListener to listen for the transition state.

Set values of zoom, bearing and pitch that the camera will transition to. If null is passed to any of those, current value will be used for that parameter instead. If the camera is already tracking, provided values are ignored.

CameraMode.NONE: No camera tracking
CameraMode.NONE_COMPASS: Camera does not track location, but does track compass bearing
CameraMode.NONE_GPS: Camera does not track location, but does track GPS bearing
CameraMode.TRACKING: Camera tracks the user location
CameraMode.TRACKING_COMPASS: Camera tracks the user location, with bearing provided by a compass
CameraMode.TRACKING_GPS: Camera tracks the user location, with normalized bearing
CameraMode.TRACKING_GPS_NORTH: Camera tracks the user location, with bearing always set to north

Parameters

bearing

target bearing, set to null to use current camera position

cameraMode

one of the modes found in CameraMode

pitch

target pitch, set to null to use current camera position

transitionDuration

duration of the transition in milliseconds

transitionListener

callback that's going to be invoked when the transition animation finishes

zoom

target zoom, set to null to use current camera position

fun setCameraMode(cameraMode: CameraMode, transitionDuration: Long, zoom: Double?, bearing: Double?, pitch: Double?, transitionListener: OnLocationCameraTransitionListener?)