Skip to content

Commit cb71365

Browse files
author
Seth Bourget
committed
Modified the initialize layers behavior to always apply the current options even if it means removing the existing layers.
1 parent 1419bb1 commit cb71365

File tree

7 files changed

+306
-2
lines changed

7 files changed

+306
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Mapbox welcomes participation and contributions from everyone.
3030
- Each newly instantiated MapboxRouteArrowView class will initialize the layers with the provided options on the first render call. Previously this would only be done if the layers hadn't already been initialized. [#6466](https://github.com/mapbox/mapbox-navigation-android/pull/6466)
3131
- Fixed an issue where the first voice instruction might have been played twice. [#6766](https://github.com/mapbox/mapbox-navigation-android/pull/6766)
3232
- Changed distance formatting: now all the imperial distances down to 0.1 miles will be represented in miles, while the smaller ones - in feet. [#6775](https://github.com/mapbox/mapbox-navigation-android/pull/6775)
33+
- Updated behavior of `MapboxRouteLineView::initializeLayers` to always reset the route line related layers with the options provided even if it means removing existing layers in order to apply the options. [#6793](https://github.com/mapbox/mapbox-navigation-android/pull/6793)
3334

3435
## Mapbox Navigation SDK 2.10.0-rc.1 - 16 December, 2022
3536
### Changelog

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import com.mapbox.maps.EdgeInsets
2222
import com.mapbox.maps.MapboxMap
2323
import com.mapbox.maps.Style
2424
import com.mapbox.maps.extension.observable.eventdata.MapLoadingErrorEventData
25+
import com.mapbox.maps.extension.style.expressions.generated.Expression
2526
import com.mapbox.maps.extension.style.layers.properties.generated.Visibility
2627
import com.mapbox.maps.plugin.LocationPuck2D
2728
import com.mapbox.maps.plugin.animation.MapAnimationOptions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
android:layout_width="wrap_content"
3131
android:layout_height="wrap_content"
3232
app:layout_constraintStart_toStartOf="parent"
33-
app:layout_constraintBottom_toBottomOf="parent"
33+
app:layout_constraintBottom_toTopOf="parent"
3434
android:orientation="horizontal"
3535
android:background="#ffffff"
3636
android:padding="8dp">

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1751,4 +1751,31 @@ internal object MapboxRouteLineUtils {
17511751
.iconIgnorePlacement(true)
17521752
.iconKeepUpright(true)
17531753
}
1754+
1755+
internal fun removeLayersAndSources(style: Style) {
1756+
style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_1_SOURCE_ID)
1757+
style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_2_SOURCE_ID)
1758+
style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_3_SOURCE_ID)
1759+
style.removeStyleSource(RouteLayerConstants.WAYPOINT_SOURCE_ID)
1760+
style.removeStyleLayer(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
1761+
style.removeStyleLayer(RouteLayerConstants.BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
1762+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAIL_CASING)
1763+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAIL)
1764+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_CASING)
1765+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_MAIN)
1766+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAFFIC)
1767+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_RESTRICTED)
1768+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAIL_CASING)
1769+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAIL)
1770+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_CASING)
1771+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_MAIN)
1772+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAFFIC)
1773+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_RESTRICTED)
1774+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAIL_CASING)
1775+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAIL)
1776+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_CASING)
1777+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_MAIN)
1778+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAFFIC)
1779+
style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_RESTRICTED)
1780+
}
17541781
}

‎libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/route/line/api/MapboxRouteLineView.kt‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,32 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
142142
* the layers if they have not yet been initialized. If you have a use case for initializing
143143
* the layers in advance of any API calls this method may be used.
144144
*
145+
* If the layers already exist they will be removed and re-initialized with the options provided.
146+
*
145147
* Each [Layer] added to the map by this class is a persistent layer - it will survive style changes.
146148
* This means that if the data has not changed, it does not have to be manually redrawn after a style change.
147149
* See [Style.addPersistentStyleLayer].
148150
*
149151
* @param style a valid [Style] instance
150152
*/
151153
fun initializeLayers(style: Style) {
152-
MapboxRouteLineUtils.initializeLayers(style, options)
154+
resetLayers(style)
155+
}
156+
157+
/**
158+
* Updates the [MapboxRouteLineOptions] used for the route line related layers and initializes the layers.
159+
* If the layers already exist they will be removed and re-initialized with the options provided.
160+
*
161+
* Each [Layer] added to the map by this class is a persistent layer - it will survive style changes.
162+
* This means that if the data has not changed, it does not have to be manually redrawn after a style change.
163+
* See [Style.addPersistentStyleLayer].
164+
*
165+
* @param style a valid [Style] instance
166+
* @param options used for the route line related layers.
167+
*/
168+
fun initializeLayers(style: Style, options: MapboxRouteLineOptions) {
169+
this.options = options
170+
resetLayers(style)
153171
}
154172

155173
/**
@@ -862,4 +880,26 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
862880
}
863881
}
864882
}
883+
884+
private fun resetLayers(style: Style) {
885+
sourceToFeatureMap.clear()
886+
sourceToFeatureMap[MapboxRouteLineUtils.layerGroup1SourceKey] = RouteLineFeatureId(null)
887+
sourceToFeatureMap[MapboxRouteLineUtils.layerGroup2SourceKey] = RouteLineFeatureId(null)
888+
sourceToFeatureMap[MapboxRouteLineUtils.layerGroup3SourceKey] = RouteLineFeatureId(null)
889+
primaryRouteLineLayerGroup = setOf()
890+
listOf(
891+
RouteLayerConstants.LAYER_GROUP_1_SOURCE_ID,
892+
RouteLayerConstants.LAYER_GROUP_2_SOURCE_ID,
893+
RouteLayerConstants.LAYER_GROUP_3_SOURCE_ID,
894+
RouteLayerConstants.WAYPOINT_SOURCE_ID
895+
).forEach {
896+
updateSource(
897+
style,
898+
it,
899+
FeatureCollection.fromFeatures(listOf())
900+
)
901+
}
902+
MapboxRouteLineUtils.removeLayersAndSources(style)
903+
MapboxRouteLineUtils.initializeLayers(style, options)
904+
}
865905
}

‎libnavui-maps/src/test/java/com/mapbox/navigation/ui/maps/internal/route/line/MapboxRouteLineUtilsTest.kt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2028,6 +2028,41 @@ class MapboxRouteLineUtilsTest {
20282028
assertFalse(result)
20292029
}
20302030

2031+
@Test
2032+
fun removeLayersAndSources() {
2033+
val style = mockk<Style> {
2034+
every { removeStyleLayer(any()) } returns ExpectedFactory.createNone()
2035+
every { removeStyleSource(any()) } returns ExpectedFactory.createNone()
2036+
}
2037+
2038+
MapboxRouteLineUtils.removeLayersAndSources(style)
2039+
2040+
verify { style.removeStyleSource(LAYER_GROUP_1_SOURCE_ID) }
2041+
verify { style.removeStyleSource(LAYER_GROUP_2_SOURCE_ID) }
2042+
verify { style.removeStyleSource(LAYER_GROUP_3_SOURCE_ID) }
2043+
verify { style.removeStyleSource(WAYPOINT_SOURCE_ID) }
2044+
verify { style.removeStyleLayer(TOP_LEVEL_ROUTE_LINE_LAYER_ID) }
2045+
verify { style.removeStyleLayer(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID) }
2046+
verify { style.removeStyleLayer(LAYER_GROUP_1_TRAIL_CASING) }
2047+
verify { style.removeStyleLayer(LAYER_GROUP_1_TRAIL) }
2048+
verify { style.removeStyleLayer(LAYER_GROUP_1_CASING) }
2049+
verify { style.removeStyleLayer(LAYER_GROUP_1_MAIN) }
2050+
verify { style.removeStyleLayer(LAYER_GROUP_1_TRAFFIC) }
2051+
verify { style.removeStyleLayer(LAYER_GROUP_1_RESTRICTED) }
2052+
verify { style.removeStyleLayer(LAYER_GROUP_2_TRAIL_CASING) }
2053+
verify { style.removeStyleLayer(LAYER_GROUP_2_TRAIL) }
2054+
verify { style.removeStyleLayer(LAYER_GROUP_2_CASING) }
2055+
verify { style.removeStyleLayer(LAYER_GROUP_2_MAIN) }
2056+
verify { style.removeStyleLayer(LAYER_GROUP_2_TRAFFIC) }
2057+
verify { style.removeStyleLayer(LAYER_GROUP_2_RESTRICTED) }
2058+
verify { style.removeStyleLayer(LAYER_GROUP_3_TRAIL_CASING) }
2059+
verify { style.removeStyleLayer(LAYER_GROUP_3_TRAIL) }
2060+
verify { style.removeStyleLayer(LAYER_GROUP_3_CASING) }
2061+
verify { style.removeStyleLayer(LAYER_GROUP_3_MAIN) }
2062+
verify { style.removeStyleLayer(LAYER_GROUP_3_TRAFFIC) }
2063+
verify { style.removeStyleLayer(LAYER_GROUP_3_RESTRICTED) }
2064+
}
2065+
20312066
private fun <T> listElementsAreEqual(
20322067
first: List<T>,
20332068
second: List<T>,

‎libnavui-maps/src/test/java/com/mapbox/navigation/ui/maps/route/line/api/MapboxRouteLineViewTest.kt‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import com.mapbox.maps.extension.style.layers.generated.BackgroundLayer
1616
import com.mapbox.maps.extension.style.layers.generated.LineLayer
1717
import com.mapbox.maps.extension.style.layers.getLayer
1818
import com.mapbox.maps.extension.style.layers.properties.generated.Visibility
19+
import com.mapbox.maps.extension.style.sources.Source
1920
import com.mapbox.maps.extension.style.sources.generated.GeoJsonSource
2021
import com.mapbox.maps.extension.style.sources.getSource
2122
import com.mapbox.navigation.testing.MainCoroutineRule
@@ -169,6 +170,88 @@ class MapboxRouteLineViewTest {
169170
every {
170171
setStyleSourceProperty(WAYPOINT_SOURCE_ID, any(), any())
171172
} returns ExpectedFactory.createNone()
173+
every { getSource(LAYER_GROUP_1_SOURCE_ID) } returns null
174+
every { getSource(LAYER_GROUP_2_SOURCE_ID) } returns null
175+
every { getSource(LAYER_GROUP_3_SOURCE_ID) } returns null
176+
every { getSource(WAYPOINT_SOURCE_ID) } returns null
177+
every {
178+
removeStyleSource(LAYER_GROUP_1_SOURCE_ID)
179+
} returns ExpectedFactory.createNone()
180+
every {
181+
removeStyleSource(LAYER_GROUP_2_SOURCE_ID)
182+
} returns ExpectedFactory.createNone()
183+
every {
184+
removeStyleSource(LAYER_GROUP_3_SOURCE_ID)
185+
} returns ExpectedFactory.createNone()
186+
every {
187+
removeStyleSource(WAYPOINT_SOURCE_ID)
188+
} returns ExpectedFactory.createNone()
189+
every {
190+
removeStyleSource(TOP_LEVEL_ROUTE_LINE_LAYER_ID)
191+
} returns ExpectedFactory.createNone()
192+
every {
193+
removeStyleSource(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
194+
} returns ExpectedFactory.createNone()
195+
every {
196+
removeStyleLayer(TOP_LEVEL_ROUTE_LINE_LAYER_ID)
197+
} returns ExpectedFactory.createNone()
198+
every {
199+
removeStyleLayer(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
200+
} returns ExpectedFactory.createNone()
201+
every {
202+
removeStyleLayer(LAYER_GROUP_1_TRAIL_CASING)
203+
} returns ExpectedFactory.createNone()
204+
every {
205+
removeStyleLayer(LAYER_GROUP_1_TRAIL)
206+
} returns ExpectedFactory.createNone()
207+
every {
208+
removeStyleLayer(LAYER_GROUP_1_CASING)
209+
} returns ExpectedFactory.createNone()
210+
every {
211+
removeStyleLayer(LAYER_GROUP_1_MAIN)
212+
} returns ExpectedFactory.createNone()
213+
every {
214+
removeStyleLayer(LAYER_GROUP_1_TRAFFIC)
215+
} returns ExpectedFactory.createNone()
216+
every {
217+
removeStyleLayer(LAYER_GROUP_1_RESTRICTED)
218+
} returns ExpectedFactory.createNone()
219+
every {
220+
removeStyleLayer(LAYER_GROUP_2_TRAIL_CASING)
221+
} returns ExpectedFactory.createNone()
222+
every {
223+
removeStyleLayer(LAYER_GROUP_2_TRAIL)
224+
} returns ExpectedFactory.createNone()
225+
every {
226+
removeStyleLayer(LAYER_GROUP_2_CASING)
227+
} returns ExpectedFactory.createNone()
228+
every {
229+
removeStyleLayer(LAYER_GROUP_2_MAIN)
230+
} returns ExpectedFactory.createNone()
231+
every {
232+
removeStyleLayer(LAYER_GROUP_2_TRAFFIC)
233+
} returns ExpectedFactory.createNone()
234+
every {
235+
removeStyleLayer(LAYER_GROUP_2_RESTRICTED)
236+
} returns ExpectedFactory.createNone()
237+
every {
238+
removeStyleLayer(LAYER_GROUP_3_TRAIL_CASING)
239+
} returns ExpectedFactory.createNone()
240+
every {
241+
removeStyleLayer(LAYER_GROUP_3_TRAIL)
242+
} returns ExpectedFactory.createNone()
243+
every {
244+
removeStyleLayer(LAYER_GROUP_3_CASING)
245+
} returns ExpectedFactory.createNone()
246+
every {
247+
removeStyleLayer(LAYER_GROUP_3_MAIN)
248+
} returns ExpectedFactory.createNone()
249+
every {
250+
removeStyleLayer(LAYER_GROUP_3_TRAFFIC)
251+
} returns ExpectedFactory.createNone()
252+
every {
253+
removeStyleLayer(LAYER_GROUP_3_RESTRICTED)
254+
} returns ExpectedFactory.createNone()
172255
}.also {
173256
mockCheckForLayerInitialization(it)
174257
}
@@ -179,6 +262,123 @@ class MapboxRouteLineViewTest {
179262
unmockkObject(MapboxRouteLineUtils)
180263
}
181264

265+
@Test
266+
fun initializeLayers_withOptions() {
267+
mockkObject(MapboxRouteLineUtils)
268+
val options = MapboxRouteLineOptions.Builder(ctx).build()
269+
val options2 = MapboxRouteLineOptions.Builder(ctx).withTolerance(59.0).build()
270+
val style = mockk<Style> {
271+
every {
272+
setStyleSourceProperty(LAYER_GROUP_1_SOURCE_ID, any(), any())
273+
} returns ExpectedFactory.createNone()
274+
every {
275+
setStyleSourceProperty(LAYER_GROUP_2_SOURCE_ID, any(), any())
276+
} returns ExpectedFactory.createNone()
277+
every {
278+
setStyleSourceProperty(LAYER_GROUP_3_SOURCE_ID, any(), any())
279+
} returns ExpectedFactory.createNone()
280+
every {
281+
setStyleSourceProperty(WAYPOINT_SOURCE_ID, any(), any())
282+
} returns ExpectedFactory.createNone()
283+
every { getSource(LAYER_GROUP_1_SOURCE_ID) } returns null
284+
every { getSource(LAYER_GROUP_2_SOURCE_ID) } returns null
285+
every { getSource(LAYER_GROUP_3_SOURCE_ID) } returns null
286+
every { getSource(WAYPOINT_SOURCE_ID) } returns null
287+
every {
288+
removeStyleSource(LAYER_GROUP_1_SOURCE_ID)
289+
} returns ExpectedFactory.createNone()
290+
every {
291+
removeStyleSource(LAYER_GROUP_2_SOURCE_ID)
292+
} returns ExpectedFactory.createNone()
293+
every {
294+
removeStyleSource(LAYER_GROUP_3_SOURCE_ID)
295+
} returns ExpectedFactory.createNone()
296+
every {
297+
removeStyleSource(WAYPOINT_SOURCE_ID)
298+
} returns ExpectedFactory.createNone()
299+
every {
300+
removeStyleSource(TOP_LEVEL_ROUTE_LINE_LAYER_ID)
301+
} returns ExpectedFactory.createNone()
302+
every {
303+
removeStyleSource(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
304+
} returns ExpectedFactory.createNone()
305+
every {
306+
removeStyleLayer(TOP_LEVEL_ROUTE_LINE_LAYER_ID)
307+
} returns ExpectedFactory.createNone()
308+
every {
309+
removeStyleLayer(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
310+
} returns ExpectedFactory.createNone()
311+
every {
312+
removeStyleLayer(LAYER_GROUP_1_TRAIL_CASING)
313+
} returns ExpectedFactory.createNone()
314+
every {
315+
removeStyleLayer(LAYER_GROUP_1_TRAIL)
316+
} returns ExpectedFactory.createNone()
317+
every {
318+
removeStyleLayer(LAYER_GROUP_1_CASING)
319+
} returns ExpectedFactory.createNone()
320+
every {
321+
removeStyleLayer(LAYER_GROUP_1_MAIN)
322+
} returns ExpectedFactory.createNone()
323+
every {
324+
removeStyleLayer(LAYER_GROUP_1_TRAFFIC)
325+
} returns ExpectedFactory.createNone()
326+
every {
327+
removeStyleLayer(LAYER_GROUP_1_RESTRICTED)
328+
} returns ExpectedFactory.createNone()
329+
every {
330+
removeStyleLayer(LAYER_GROUP_2_TRAIL_CASING)
331+
} returns ExpectedFactory.createNone()
332+
every {
333+
removeStyleLayer(LAYER_GROUP_2_TRAIL)
334+
} returns ExpectedFactory.createNone()
335+
every {
336+
removeStyleLayer(LAYER_GROUP_2_CASING)
337+
} returns ExpectedFactory.createNone()
338+
every {
339+
removeStyleLayer(LAYER_GROUP_2_MAIN)
340+
} returns ExpectedFactory.createNone()
341+
every {
342+
removeStyleLayer(LAYER_GROUP_2_TRAFFIC)
343+
} returns ExpectedFactory.createNone()
344+
every {
345+
removeStyleLayer(LAYER_GROUP_2_RESTRICTED)
346+
} returns ExpectedFactory.createNone()
347+
every {
348+
removeStyleLayer(LAYER_GROUP_3_TRAIL_CASING)
349+
} returns ExpectedFactory.createNone()
350+
every {
351+
removeStyleLayer(LAYER_GROUP_3_TRAIL)
352+
} returns ExpectedFactory.createNone()
353+
every {
354+
removeStyleLayer(LAYER_GROUP_3_CASING)
355+
} returns ExpectedFactory.createNone()
356+
every {
357+
removeStyleLayer(LAYER_GROUP_3_MAIN)
358+
} returns ExpectedFactory.createNone()
359+
every {
360+
removeStyleLayer(LAYER_GROUP_3_TRAFFIC)
361+
} returns ExpectedFactory.createNone()
362+
every {
363+
removeStyleLayer(LAYER_GROUP_3_RESTRICTED)
364+
} returns ExpectedFactory.createNone()
365+
}.also {
366+
mockCheckForLayerInitialization(it)
367+
}
368+
val view = MapboxRouteLineView(options)
369+
370+
view.initializeLayers(style, options2)
371+
372+
verify { MapboxRouteLineUtils.removeLayersAndSources(style) }
373+
verify { MapboxRouteLineUtils.initializeLayers(style, options2) }
374+
verify { style.getSource(LAYER_GROUP_1_SOURCE_ID) }
375+
verify { style.getSource(LAYER_GROUP_2_SOURCE_ID) }
376+
verify { style.getSource(LAYER_GROUP_3_SOURCE_ID) }
377+
verify { style.getSource(WAYPOINT_SOURCE_ID) }
378+
assertEquals(view.options, options2)
379+
unmockkObject(MapboxRouteLineUtils)
380+
}
381+
182382
@Test
183383
fun renderClearRouteLineValue() = coroutineRule.runBlockingTest {
184384
mockkStatic("com.mapbox.maps.extension.style.sources.SourceUtils")

0 commit comments

Comments
 (0)