UI Maps/com.mapbox.navigation.ui.maps.puck/LocationPuckOptions

LocationPuckOptions

class LocationPuckOptions

Gives options to specify either LocationPuck2D or LocationPuck3D references to the location puck to be displayed on top of map view in each of different navigation states.

If you want to use the same puck for all different navigation states you can invoke defaultPuck() on the Builder and that would be used for pucks in all navigation states.

Parameters

context

from which to reference puck drawables

freeDrivePuck

stores the puck appearance to be displayed in free drive state when in the NavigationCameraState.FOLLOWING

destinationPreviewPuck

stores the puck appearance to be displayed in destination preview state when in the NavigationCameraState.FOLLOWING

routePreviewPuck

stores the puck appearance to be displayed in route preview state when in the NavigationCameraState.FOLLOWING

activeNavigationPuck

stores the puck appearance to be displayed in active navigation state when in the NavigationCameraState.FOLLOWING

arrivalPuck

stores the puck appearance to be displayed in arrival state when in the NavigationCameraState.FOLLOWING

idlePuck

stores the puck appearance to be displayed for all navigation states when in the NavigationCameraState.IDLE or the NavigationCameraState.OVERVIEW

Types

class Builder(context: Context)

Builder of LocationPuckOptions

Functions

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

Regenerate whenever a change is made

open override fun hashCode(): Int

Regenerate whenever a change is made

fun toBuilder(): LocationPuckOptions.Builder

open override fun toString(): String

Regenerate whenever a change is made

Properties

activeNavigationPuck

val activeNavigationPuck: LocationPuck

val arrivalPuck: LocationPuck

val context: Context

destinationPreviewPuck

val destinationPreviewPuck: LocationPuck

val freeDrivePuck: LocationPuck

val idlePuck: LocationPuck

routePreviewPuck

val routePreviewPuck: LocationPuck