mapbox-maps-android/com.mapbox.maps.plugin.locationcomponent/LocationComponentPluginImpl

LocationComponentPluginImpl

class LocationComponentPluginImpl : LocationComponentSettingsBase, LocationComponentPlugin, LocationConsumer

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

Constructors

fun LocationComponentPluginImpl()

Functions

addOnIndicatorBearingChangedListener

open override fun addOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Adds a listener that gets invoked when indicator bearing changes.

addOnIndicatorPositionChangedListener

open override fun addOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Adds a listener that gets invoked when indicator position changes.

bind

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

Bind the ViewPlugin with current map context.

cleanup

open fun cleanup()

equals

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

getLocationProvider

open override fun getLocationProvider(): LocationProvider?

Get the current LocationProvider under usage with the LocationComponentPlugin.

getSettings

abstract fun getSettings(): LocationComponentSettings

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

isLocatedAt

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

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

onBearingUpdated

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

Called whenever the bearing is updated.

onDelegateProvider

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onLocationUpdated

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

Called whenever the location is updated.

onPuckBearingAnimatorDefaultOptionsUpdated

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

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

onPuckLocationAnimatorDefaultOptionsUpdated

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

Update ValueAnimator options that will be used to animate between Point updates by default.

onStart

open override fun onStart()

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

onStop

open override fun onStop()

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

onStyleChanged

open override fun onStyleChanged(styleDelegate: StyleInterface)

Called when a new Style is loaded.

removeOnIndicatorBearingChangedListener

open override fun removeOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Removes a listener that gets invoked when indicator bearing changes.

removeOnIndicatorPositionChangedListener

open override fun removeOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Removes a listener that gets invoked when indicator position changes.

setLocationProvider

open override fun setLocationProvider(locationProvider: LocationProvider)

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

toString

open fun toString(): String

updateSettings

abstract fun updateSettings(block: LocationComponentSettings.() -> Unit)

Properties

enabled

abstract var enabled: Boolean

layerAbove

abstract var layerAbove: String?

layerBelow

abstract var layerBelow: String?

locationPuck

abstract var locationPuck: LocationPuck

pulsingColor

abstract var pulsingColor: Int

pulsingEnabled

abstract var pulsingEnabled: Boolean

pulsingMaxRadius

abstract var pulsingMaxRadius: Float