mapbox-maps-android/com.mapbox.maps.plugin.viewport/ViewportPluginImpl

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

androidJvm

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

Functions

addStatusObserver

androidJvm

open override fun addStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Adds ViewportStatusObserver to observe the status change.

cleanup

androidJvm

open override fun cleanup()

Called when the map is destroyed.

equals

androidJvm

open operator fun equals(other: Any?): Boolean

hashCode

androidJvm

open fun hashCode(): Int

idle

androidJvm

open override fun idle()

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

initialize

androidJvm

open fun initialize()

makeDefaultViewportTransition

androidJvm

open override fun makeDefaultViewportTransition(options: DefaultViewportTransitionOptions): DefaultViewportTransition

Create a default ViewportTransition instance with provided DefaultViewportTransitionOptions.

makeFollowPuckViewportState

androidJvm

open override fun makeFollowPuckViewportState(options: FollowPuckViewportStateOptions): FollowPuckViewportState

Create a FollowPuckViewportState instance with provided FollowPuckViewportStateOptions.

makeImmediateViewportTransition

androidJvm

open override fun makeImmediateViewportTransition(): ViewportTransition

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

makeOverviewViewportState

androidJvm

open override fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState

Create an OverviewViewportState instance with provided OverviewViewportStateOptions.

onDelegateProvider

androidJvm

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

removeStatusObserver

androidJvm

open override fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)

Removes ViewportStatusObserver.

toString

androidJvm

open fun toString(): String

transitionTo

androidJvm

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

Executes a transition to requested state.

Properties

defaultTransition

androidJvm

open lateinit override var defaultTransition: ViewportTransition

DefaultViewportTransition with default optionsThis transition is used unless overridden by one of the registered transitions.

options

androidJvm

open override var options: ViewportOptions

Options that impact the ViewportPlugin.

status

androidJvm

open override var status: ViewportStatus

Returns current ViewportStatus.