mapbox-maps-android/com.mapbox.maps.plugin.viewport.state/FollowPuckViewportState

FollowPuckViewportState

interface FollowPuckViewportState : ViewportState

The ViewportState that tracks the location puck's position.

Use ViewportPlugin.makeFollowPuckViewportState to create instances of FollowPuckViewportState.

Note: LocationComponentPlugin should be enabled to use this viewport state, and Users are responsible to create the viewport states and keep a reference to these states for future operations.

Functions

Link copied to clipboard
abstract fun observeDataSource(viewportStateDataObserver: ViewportStateDataObserver): Cancelable

Registers an observer to receive the cameras being generated by this ViewportState.

Link copied to clipboard
abstract fun startUpdatingCamera()

Indicates the current ViewportState is now responsible for updating the camera.

Link copied to clipboard
abstract fun stopUpdatingCamera()

Indicates the current ViewportState is no longer responsible for updating the camera.

Properties

Link copied to clipboard
abstract var options: FollowPuckViewportStateOptions

Describes the configuration options of the state.