ViewportPluginImpl

class ViewportPluginImpl(handler: Handler) : ViewportPlugin

Mapbox default implementation for ViewportPlugin.

The Viewport plugin allows to track objects on a map.

It provides a structured approach to organizing camera management logic into states and transitions between them.

at any given time, the viewport is either:

idle (not updating the camera)
in a state (camera is being managed by a ViewportState)
transitioning (camera is being managed by a ViewportTransition)

Constructors

ViewportPluginImpl

fun ViewportPluginImpl(handler: Handler = Handler(Looper.getMainLooper()))

Functions

addStatusObserver

open override fun addStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Adds ViewportStatusObserver to observe the status change.

cleanup

open override fun cleanup()

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

idle

open override fun idle()

Immediately goes to ViewportStatus.Idle state canceling all ongoing transitions.

initialize

open fun initialize()

makeDefaultViewportTransition

open override fun makeDefaultViewportTransition(options: DefaultViewportTransitionOptions): DefaultViewportTransition

Create a default ViewportTransition instance with provided DefaultViewportTransitionOptions.

makeFollowPuckViewportState

open override fun makeFollowPuckViewportState(options: FollowPuckViewportStateOptions): FollowPuckViewportState

Create a FollowPuckViewportState instance with provided FollowPuckViewportStateOptions.

makeImmediateViewportTransition

open override fun makeImmediateViewportTransition(): ViewportTransition

Create a ViewportTransition instance that transition to the target ViewportState immediately.

makeOverviewViewportState

open override fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState

Create an OverviewViewportState instance with provided OverviewViewportStateOptions.

onDelegateProvider

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

removeStatusObserver

open override fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Removes ViewportStatusObserver.

transitionTo

open override fun transitionTo(targetState: ViewportState, transition: ViewportTransition?, completionListener: CompletionListener?)

Executes a transition to requested state.

Properties

defaultTransition

open lateinit override var defaultTransition: ViewportTransition

DefaultViewportTransition with default options

options

open override var options: ViewportOptions

Options that impact the ViewportPlugin.

status

open override var status: ViewportStatus

Returns current ViewportStatus.