mapbox-maps-android/com.mapbox.maps.plugin.compass/CompassViewPlugin

CompassViewPlugin

Concrete implementation of CompassPlugin.

open class CompassViewPlugin(viewImplProvider: (Context) -> CompassViewImpl, fadeAnimator: ValueAnimator, mainHandler: Handler) : CompassSettingsBase, CompassPlugin

Constructors

CompassViewPlugin

fun CompassViewPlugin(viewImplProvider: (Context) -> CompassViewImpl, fadeAnimator: ValueAnimator, mainHandler: Handler)

Types

Companion

Static variables and methods.

object Companion

Functions

addCompassClickListener

Add an OnClick listener to the presenter.

open override fun addCompassClickListener(onClickListener: OnCompassClickListener)

bind

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

open override fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View

cleanup

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

open override fun cleanup()

equals

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

getSettings

open override fun getSettings(): CompassSettings

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

onCameraMove

Called whenever camera position changes. Could be invoked from any thread when map starts rendering.

open override fun onCameraMove(lat: Double, lon: Double, zoom: Double, pitch: Double, bearing: Double, padding: Array<Double>)

onCompassClicked

Invoked when the compass view is clicked.

open override fun onCompassClicked()

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onPluginView

Provides a view instances returned in bind after it's been added to the MapView.

open override fun onPluginView(view: View)

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()

removeCompassClickListener

Remove an OnClick listener from the presenter.

open override fun removeCompassClickListener(onClickListener: OnCompassClickListener)

toString

open override fun toString(): String

updateSettings

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

Properties

clickable

open override var clickable: Boolean

enabled

Defines whether the plugins is enabled or disabled.

open override var enabled: Boolean

fadeWhenFacingNorth

open override var fadeWhenFacingNorth: Boolean

image

open override var image: Drawable?

marginBottom

open override var marginBottom: Float

marginLeft

open override var marginLeft: Float

marginRight

open override var marginRight: Float

marginTop

open override var marginTop: Float

opacity

open override var opacity: Float

position

open override var position: Int

rotation

open override var rotation: Float

visibility

open override var visibility: Boolean