LocationComponentPluginImpl

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

Constructors

LocationComponentPluginImpl
Link copied to clipboard
fun LocationComponentPluginImpl()

Functions

open override fun addOnIndicatorAccuracyRadiusChangedListener(listener: OnIndicatorAccuracyRadiusChangedListener)

Adds a listener that gets invoked when indicator accuracy radius changes.

addOnIndicatorBearingChangedListener
Link copied to clipboard
open override fun addOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Adds a listener that gets invoked when indicator bearing changes.

addOnIndicatorPositionChangedListener
Link copied to clipboard
open override fun addOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Adds a listener that gets invoked when indicator position changes.

bind
Link copied to clipboard
open override fun bind(context: Context, attrs: AttributeSet?, pixelRatio: Float)

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

cleanup
Link copied to clipboard
open fun cleanup()
getLocationProvider
Link copied to clipboard
open override fun getLocationProvider(): LocationProvider?

Get the current LocationProvider under usage with the LocationComponentPlugin.

getSettings
Link copied to clipboard
abstract fun getSettings(): LocationComponentSettings
getSettings2
Link copied to clipboard
abstract fun getSettings2(): LocationComponentSettings2
initialize
Link copied to clipboard
open fun initialize()
isLocatedAt
Link copied to clipboard
open override fun isLocatedAt(point: Point, listener: PuckLocatedAtPointListener)

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

onAccuracyRadiusUpdated
Link copied to clipboard
open override fun onAccuracyRadiusUpdated(vararg radius: Double, options: ValueAnimator.() -> Unit?)

Called whenever the accuracy radius is updated.

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

Called whenever the bearing is updated.

onDelegateProvider
Link copied to clipboard
open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

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

Called whenever the location is updated.

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

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

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

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 onPuckLocationAnimatorDefaultOptionsUpdated(options: ValueAnimator.() -> Unit)

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

onStart
Link copied to clipboard
open override fun onStart()

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

onStop
Link copied to clipboard
open override fun onStop()

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

onStyleChanged
Link copied to clipboard
open override fun onStyleChanged(styleDelegate: StyleInterface)

Called when a new Style is loaded.

Removes a listener that gets invoked when indicator accuracy radius changes.

removeOnIndicatorBearingChangedListener
Link copied to clipboard
open override fun removeOnIndicatorBearingChangedListener(listener: OnIndicatorBearingChangedListener)

Removes a listener that gets invoked when indicator bearing changes.

open override fun removeOnIndicatorPositionChangedListener(listener: OnIndicatorPositionChangedListener)

Removes a listener that gets invoked when indicator position changes.

setLocationProvider
Link copied to clipboard
open override fun setLocationProvider(locationProvider: LocationProvider)

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

updateSettings
Link copied to clipboard
abstract fun updateSettings(block: LocationComponentSettings.() -> Unit)
updateSettings2
Link copied to clipboard
abstract fun updateSettings2(block: LocationComponentSettings2.() -> Unit)

Properties

accuracyRingBorderColor
Link copied to clipboard
abstract var accuracyRingBorderColor: Int
accuracyRingColor
Link copied to clipboard
abstract var accuracyRingColor: Int
enabled
Link copied to clipboard
abstract var enabled: Boolean
layerAbove
Link copied to clipboard
abstract var layerAbove: String?
layerBelow
Link copied to clipboard
abstract var layerBelow: String?
locationPuck
Link copied to clipboard
abstract var locationPuck: LocationPuck
puckBearingEnabled
Link copied to clipboard
abstract var puckBearingEnabled: Boolean
puckBearingSource
Link copied to clipboard
abstract var puckBearingSource: PuckBearingSource
pulsingColor
Link copied to clipboard
abstract var pulsingColor: Int
pulsingEnabled
Link copied to clipboard
abstract var pulsingEnabled: Boolean
pulsingMaxRadius
Link copied to clipboard
abstract var pulsingMaxRadius: Float
showAccuracyRing
Link copied to clipboard
abstract var showAccuracyRing: Boolean