wip code cleanup and docs updates.

Author: Seth Bourget

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxRouteLineAndArrowActivity.kt

@@ -64,11 +64,4 @@
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintBottom_toBottomOf="parent"
         android:visibility="invisible"/>
-
-    <androidx.appcompat.widget.AppCompatButton
-        android:id="@+id/btnTemp"
-        android:layout_width="wrap_content"
-        android:layout_height="wrap_content"
-        app:layout_constraintStart_toStartOf="parent"
-        app:layout_constraintBottom_toTopOf="@id/startNavigation"/>
 </androidx.constraintlayout.widget.ConstraintLayout>

examples/src/main/res/layout/layout_activity_routeline_example.xml

@@ -64,7 +64,7 @@ import kotlin.math.max
 import kotlin.math.sin
 import kotlin.math.sqrt
 
-object MapboxRouteLineUtils {
+internal object MapboxRouteLineUtils {
 
     private const val LOG_CATEGORY = "MapboxRouteLineUtils"
     internal const val VANISH_POINT_STOP_GAP = .00000000001
@@ -488,7 +488,7 @@ object MapboxRouteLineUtils {
      * @return a list of items representing the distance offset of each route leg and the color
      * used to represent the traffic congestion.
      */
-    internal fun calculateRouteLineSegments(
+    fun calculateRouteLineSegments(
         route: NavigationRoute,
         trafficBackfillRoadClasses: List<String>,
         isPrimaryRoute: Boolean,
@@ -877,7 +877,7 @@ object MapboxRouteLineUtils {
     private fun generateFeatureCollection(route: NavigationRouteLine): RouteFeatureData =
         generateRouteFeatureData(route.route, route.identifier)
 
-    private fun  calculateGranularDistances(
+    private fun calculateGranularDistances(
         stepsPoints: List<List<List<Point>>>
     ): RouteLineGranularDistances {
         var distance = 0.0
@@ -955,41 +955,64 @@ object MapboxRouteLineUtils {
         )
     }
 
-    fun getFillerPointsForStepPoints(nextSteps: Array<RouteLineDistancesIndex>): List<RouteLineDistancesIndex> {
+    /**
+     * Adds equally spaced [RouteLineDistancesIndex] points between each of the inputted steps and
+     * returns a collection of the original [RouteLineDistancesIndex] points with the newly created
+     * points between them.
+     *
+     * @param steps a collection of [RouteLineDistancesIndex] representing step points
+     * @return a collection of RouteLineDistancesIndex
+     */
+    fun getFillerPointsForStepPoints(steps: Array<RouteLineDistancesIndex>): List<RouteLineDistancesIndex> {
         val fillerPoints = mutableListOf<RouteLineDistancesIndex>()
-        nextSteps.forEachIndexed { index, routeLineDistancesIndex ->
-            if (index < nextSteps.lastIndex) {
-                getFillerPoints(routeLineDistancesIndex, nextSteps[index + 1]).apply {
+        steps.forEachIndexed { index, routeLineDistancesIndex ->
+            if (index < steps.lastIndex) {
+                getFillerPoints(routeLineDistancesIndex, steps[index + 1]).apply {
                     fillerPoints.addAll(this)
                 }
             }
         }
         return fillerPoints
     }
 
-    //todo the variable names below should be named better
-    fun getFillerPoints(startPoint: RouteLineDistancesIndex, endPoint: RouteLineDistancesIndex): List<RouteLineDistancesIndex> {
-        val gapDist = 1.0 // meters
-        val turfDistance = TurfMeasurement.distance(startPoint.point, endPoint.point, TurfConstants.UNIT_METERS)
+    /**
+     * Creates equally spaced [RouteLineDistancesIndex] points between the start point and end points
+     * and returns a collection with the start point and end point with the newly created
+     * points between them.
+     *
+     * @param startPoint the starting RouteLineDistancesIndex
+     * @param endPoint the ending RouteLineDistancesIndex
+     * @return a collection of the start and end points and the points generated here
+     */
+    private fun getFillerPoints(
+        startPoint: RouteLineDistancesIndex,
+        endPoint: RouteLineDistancesIndex
+    ): List<RouteLineDistancesIndex> {
+        val gapDistanceInMeters = 1.0
+        val turfDistance = TurfMeasurement.distance(
+            startPoint.point,
+            endPoint.point,
+            TurfConstants.UNIT_METERS
+        )
         val fillerPoints = mutableListOf<RouteLineDistancesIndex>()
         val bearing = TurfMeasurement.bearing(startPoint.point, endPoint.point)
-        var lastCalculatedPoint = startPoint
-        val count = (turfDistance / gapDist).toInt()
+        val numPointsToCreate = (turfDistance / gapDistanceInMeters).toInt()
         val delta = startPoint.distanceRemaining - endPoint.distanceRemaining
-        val itemDist = delta / count
+        val itemDistance = delta / numPointsToCreate
+        var lastCalculatedPoint = startPoint
+        var distanceRemaining = startPoint.distanceRemaining
 
         fillerPoints.add(startPoint)
-        var dist = startPoint.distanceRemaining
-        repeat(count) {
+        repeat(numPointsToCreate) {
             val fillerPoint = TurfMeasurement.destination(
                 lastCalculatedPoint.point,
-                gapDist,
+                gapDistanceInMeters,
                 bearing,
                 TurfConstants.UNIT_METERS
             )
 
-            dist -= itemDist
-            fillerPoints.add(RouteLineDistancesIndex(fillerPoint, dist))
+            distanceRemaining -= itemDistance
+            fillerPoints.add(RouteLineDistancesIndex(fillerPoint, distanceRemaining))
             lastCalculatedPoint = fillerPoints.last()
         }
         return fillerPoints

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/route/line/MapboxRouteLineUtils.kt

@@ -4,8 +4,6 @@ import androidx.annotation.ColorInt
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
-import com.mapbox.geojson.Feature
-import com.mapbox.geojson.FeatureCollection
 import com.mapbox.geojson.Point
 import com.mapbox.maps.MapboxMap
 import com.mapbox.maps.extension.style.expressions.generated.Expression

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/route/line/PointProvider.kt

@@ -1,14 +1,12 @@
 package com.mapbox.navigation.ui.maps.route.line.api
 
 import android.graphics.Color
-import android.util.Log
 import android.util.LruCache
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.api.directions.v5.models.RouteOptions
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
 import com.mapbox.geojson.FeatureCollection
-import com.mapbox.geojson.LineString
 import com.mapbox.geojson.Point
 import com.mapbox.maps.MapboxMap
 import com.mapbox.maps.QueriedFeature
@@ -19,7 +17,6 @@ import com.mapbox.maps.Style
 import com.mapbox.maps.extension.style.layers.Layer
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentPluginImpl
 import com.mapbox.maps.plugin.locationcomponent.OnIndicatorPositionChangedListener
-import com.mapbox.navigation.base.internal.utils.isSameRoute
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.toDirectionsRoutes
 import com.mapbox.navigation.base.trip.model.RouteProgress
@@ -36,7 +33,6 @@ import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.gr
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup1SourceLayerIds
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup2SourceLayerIds
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup3SourceLayerIds
-import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.routePointsProvider
 import com.mapbox.navigation.ui.maps.route.RouteLayerConstants
 import com.mapbox.navigation.ui.maps.route.line.model.ClosestRouteValue
 import com.mapbox.navigation.ui.maps.route.line.model.ExtractedRouteRestrictionData
@@ -62,9 +58,6 @@ import com.mapbox.navigation.ui.utils.internal.ifNonNull
 import com.mapbox.navigation.utils.internal.InternalJobControlFactory
 import com.mapbox.navigation.utils.internal.logW
 import com.mapbox.navigation.utils.internal.parallelMap
-import com.mapbox.turf.TurfConstants
-import com.mapbox.turf.TurfException
-import com.mapbox.turf.TurfMisc
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async
 import kotlinx.coroutines.cancelChildren
@@ -539,7 +532,6 @@ class MapboxRouteLineApi(
     ) {
         jobControl.scope.launch(Dispatchers.Main) {
             mutex.withLock {
-                //routeLineOptions.vanishingRouteLine?.vanishPointOffset = 0.0 //todo remove this?
                 activeLegIndex = INVALID_ACTIVE_LEG_INDEX
                 routes.clear()
                 routeFeatureData.clear()
@@ -723,11 +715,11 @@ class MapboxRouteLineApi(
     }
 
     fun updateUpcomingRoutePointIndex(routeProgress: RouteProgress) {
-        // todo del me
+        // todo delete me
     }
 
     fun updateVanishingPointState(state: RouteProgressState) {
-        // todo del me
+        // todo delete me
     }
 
     /**
@@ -1072,6 +1064,7 @@ class MapboxRouteLineApi(
             distinctNewRoutes.find { it.id == metadata.navigationRoute.id } != null
         }
 
+        // todo is this still needed?
         // ifNonNull(distinctNewRoutes.firstOrNull()) { primaryRouteCandidate ->
         //     if (!primaryRouteCandidate.directionsRoute.isSameRoute(primaryRoute?.directionsRoute)) {
         //         routeLineOptions.vanishingRouteLine?.vanishPointOffset = 0.0
@@ -1510,8 +1503,4 @@ class MapboxRouteLineApi(
                 jobControl.scope
             )
         }.cacheResult(alternativelyStyleSegmentsNotInLegCache)
-
-    fun deleteMeGetTreePoints(): List<Point> {
-        return routeLineOptions.vanishingRouteLine!!.deleteMeGetTreePoints()
-    }
 }