MapsIndoorsSDK/com.mapsindoors.core/MPDirectionsRenderer

MPDirectionsRenderer

class MPDirectionsRenderer

This allows for an easy way to display a route on the MapsIndoors map. Each leg of the route can be shown individually and can be navigated by manipulating the selected leg index. Various customization options are available to adjust the polyline styling and camera behavior.

Constructors

Link copied to clipboard
open fun MPDirectionsRenderer(@NonNull mapControl: MapControl)

Functions

Link copied to clipboard
open fun clear()
Clears the route from the map
Link copied to clipboard
open fun getSelectedLegFloorIndex(): Int
Gets the currently selected leg's floor index.
Link copied to clipboard
open fun isRouteLegButtonsShown(): Boolean
Checks whether the route leg buttons are enabled or disabled
Link copied to clipboard
open fun nextLeg()
Selects the next leg if possible.
Link copied to clipboard
open fun previousLeg()
Selects the previous leg if possible.
Link copied to clipboard
open fun selectLegIndex(legIndex: Int)
Manually set the selected leg index, on the set route.
Link copied to clipboard
open fun setAnimatedPolyline(animated: Boolean, repeating: Boolean, durationMs: Int)
Enable/Disable the polyline animation, when displaying a route element on the map
Link copied to clipboard
open fun setCameraAnimationDuration(durationMs: Int)
Set the duration of camera animations (ms).
Link copied to clipboard
open fun setCameraViewFitMode(fitMode: MPCameraViewFitMode)
Set the fit mode of the camera, when displaying route elements on the map.
Link copied to clipboard
open fun setCameraViewTilt(@FloatRange(from = 0.0, to = 90.0) tilt: Float)
Set the camera tilt.
Link copied to clipboard
open fun setLabel(@NonNull labelProperties: MPDirectionsLabel)
Overrides the default label for middle steps in a route.
Link copied to clipboard
open fun setOnLegSelectedListener(@Nullable legSelectedListener: OnLegSelectedListener)
Set a listener, which will be invoked when a new leg has been selected
Link copied to clipboard
open fun setPolylineColors(foreground: Int, background: Int)
Set the color of the displayed polyline
Link copied to clipboard
open fun setRoute(@NonNull route: MPRoute)
Set a route to be rendered.
Link copied to clipboard
open fun showRouteLegButtons(show: Boolean)
Enable/Disable the route end/start buttons from showing on the route.
Link copied to clipboard
open fun useContentOfNearbyLocations(@Nullable contextualInfoSettings: MPContextualInfoSettings)
If set, we will show labels and icons from nearby Locations as additional contextual information about the end positions of the rendered route segment.

Properties

Link copied to clipboard
Link copied to clipboard
val ROUTE_END_TAG: String = "END_MARKER"
Link copied to clipboard
val ROUTE_START_TAG: String = "START_MARKER"