Mapbox Maps Android/com.mapbox.maps.plugin.locationcomponent/LocationComponentPluginImpl

LocationComponentPluginImpl

Default implementation of the LocationComponentPlugin, it renders the configured location puck to the user's current location.

class LocationComponentPluginImpl : LocationComponentSettingsBase, LocationComponentPlugin, LocationConsumer

Constructors

fun LocationComponentPluginImpl()

Functions

addOnIndicatorBearingChangedListener

Adds a listener that gets invoked when indicator bearing changes.

open override fun addOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

addOnIndicatorPositionChangedListener

Adds a listener that gets invoked when indicator position changes.

open override fun addOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

bind

Bind the ViewPlugin with current map context. This will create a View that will be added to the MapView.

open override fun bind(context: Context, attrs: AttributeSet?, pixelRatio: Float)

cleanup

open override fun cleanup()

equals

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

getLocationProvider

Get the current LocationProvider under usage with the LocationComponentPlugin.

open override fun getLocationProvider(): LocationProvider?

getSettings

open override fun getSettings(): LocationComponentSettings

hashCode

open override fun hashCode(): Int

initialize

open override fun initialize()

isLocatedAt

Check whether the rendered location puck is on the given point.

open override fun isLocatedAt(point: Point, listener: PuckLocatedAtPointListener)

onBearingUpdated

Called whenever the bearing is updated.

open override fun onBearingUpdated(vararg bearing: DoubleArray, options: ValueAnimator.() -> Unit?)

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onLocationUpdated

Called whenever the location is updated.

open override fun onLocationUpdated(vararg location: Array<out Point>, options: ValueAnimator.() -> Unit?)

onPuckBearingAnimatorDefaultOptionsUpdated

Update ValueAnimator options that will be used to animate between bearing Double updates by default. This will apply to all upcoming updates.

open override fun onPuckBearingAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

onPuckLocationAnimatorDefaultOptionsUpdated

Update ValueAnimator options that will be used to animate between Point updates by default. This will apply to all upcoming updates.

open override fun onPuckLocationAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

onStart

Called whenever activity's/fragment's lifecycle is entering a "started" state.

open override fun onStart()

onStop

Called whenever activity's/fragment's lifecycle is entering a "stopped" state.

open override fun onStop()

onStyleChanged

Called when a new Style is loaded.

open override fun onStyleChanged(styleDelegate: StyleInterface)

removeOnIndicatorBearingChangedListener

Removes a listener that gets invoked when indicator bearing changes.

open override fun removeOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

removeOnIndicatorPositionChangedListener

Removes a listener that gets invoked when indicator position changes.

open override fun removeOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

setLocationProvider

Set the LocationProvider, it will replace the default location provider provided by the LocationComponentPlugin.

open override fun setLocationProvider(locationProvider: LocationProvider)

toString

open override fun toString(): String

updateSettings

open override fun updateSettings(block: LocationComponentSettings.() -> Unit)

Properties

enabled

open override var enabled: Boolean

layerAbove

open override var layerAbove: String?

layerBelow

open override var layerBelow: String?

locationPuck

open override var locationPuck: LocationPuck

pulsingColor

open override var pulsingColor: Int

pulsingEnabled

open override var pulsingEnabled: Boolean

pulsingMaxRadius

open override var pulsingMaxRadius: Float