Trigger repaint after BitmapWidget is updated.

CHANGELOG.md

@@ -3,6 +3,8 @@
 Mapbox welcomes participation and contributions from everyone.
 
 # main
+## Features ✨ and improvements 🏁
+* Add `Widget.triggerRepaint` protected API and updated the `BitmapWidget` to trigger repaint after widget is updated.
 
 # 10.10.0-beta.1 November 03, 2022
 ## Features ✨ and improvements 🏁

sdk/api/metalava.txt

@@ -561,6 +561,7 @@ package com.mapbox.maps.renderer.widget {
     method public abstract void setPosition(com.mapbox.maps.renderer.widget.WidgetPosition widgetPosition);
     method public abstract void setRotation(float angleDegrees);
     method @Deprecated public abstract void setTranslation(float translateX, float translateY);
+    method protected final void triggerRepaint();
   }
 
   @com.mapbox.maps.MapboxExperimental public final class WidgetPosition {

sdk/api/sdk.api

@@ -561,6 +561,7 @@ public abstract class com/mapbox/maps/renderer/widget/Widget {
 	public abstract fun setPosition (Lcom/mapbox/maps/renderer/widget/WidgetPosition;)V
 	public abstract fun setRotation (F)V
 	public abstract fun setTranslation (FF)V
+	protected final fun triggerRepaint ()V
 }
 
 public final class com/mapbox/maps/renderer/widget/WidgetPosition {

sdk/src/main/java/com/mapbox/maps/MapController.kt

@@ -37,6 +37,7 @@ import com.mapbox.maps.renderer.MapboxRenderer
 import com.mapbox.maps.renderer.OnFpsChangedListener
 import com.mapbox.maps.renderer.RendererSetupErrorListener
 import com.mapbox.maps.renderer.widget.Widget
+import java.lang.ref.WeakReference
 
 internal class MapController : MapPluginProviderDelegate, MapControllable {
 
@@ -217,12 +218,17 @@ internal class MapController : MapPluginProviderDelegate, MapControllable {
   }
 
   override fun addWidget(widget: Widget) {
+    val weakThis = WeakReference(this)
+    widget.setRepaintTrigger {
+      weakThis.get()?.renderer?.scheduleRepaint()
+    }
     renderer.renderThread.addWidget(widget)
     renderer.scheduleRepaint()
   }
 
   override fun removeWidget(widget: Widget): Boolean {
     val wasRemoved = renderer.renderThread.removeWidget(widget)
+    widget.setRepaintTrigger(null)
     if (wasRemoved) {
       renderer.scheduleRepaint()
     }

sdk/src/main/java/com/mapbox/maps/renderer/widget/BitmapWidget.kt

@@ -95,13 +95,15 @@ open class BitmapWidget @JvmOverloads constructor(
    */
   fun updateBitmap(bitmap: Bitmap) {
     renderer.updateBitmap(bitmap)
+    triggerRepaint()
   }
 
   /**
    * Update the widget to the new position.
    */
   override fun setPosition(widgetPosition: WidgetPosition) {
     renderer.setPosition(widgetPosition)
+    triggerRepaint()
   }
 
   /**
@@ -136,6 +138,7 @@ open class BitmapWidget @JvmOverloads constructor(
    */
   override fun setRotation(angleDegrees: Float) {
     renderer.setRotation(angleDegrees = angleDegrees)
+    triggerRepaint()
   }
 
   /**

sdk/src/main/java/com/mapbox/maps/renderer/widget/Widget.kt

@@ -8,6 +8,15 @@ import com.mapbox.maps.MapboxExperimental
 @MapboxExperimental
 abstract class Widget internal constructor() {
   internal abstract val renderer: WidgetRenderer
+  private var repaintTrigger: (() -> Unit)? = null
+
+  /**
+   * Triggers a repaint of the widget, as well as the map.
+   * It will do nothing if the widget has not been added to the map.
+   */
+  protected fun triggerRepaint() {
+    repaintTrigger?.invoke()
+  }
 
   /**
    * Update the widget to the new position.
@@ -40,4 +49,9 @@ abstract class Widget internal constructor() {
    * Get absolute rotation of widget in degrees.
    */
   abstract fun getRotation(): Float
+
+  @JvmSynthetic
+  internal fun setRepaintTrigger(trigger: (() -> Unit)?) {
+    repaintTrigger = trigger
+  }
 }

sdk/src/test/java/com/mapbox/maps/MapControllerTest.kt

@@ -411,25 +411,29 @@ class MapControllerTest {
   @OptIn(MapboxExperimental::class)
   @Test
   fun addWidgetTest() {
-    val widget = createTestWidget()
+    val mockWidget = mockk<BitmapWidget>()
+    every { mockWidget.setRepaintTrigger(any()) } just runs
     val mockRenderThread = mockk<MapboxRenderThread>(relaxed = true)
     every { mockRenderer.renderThread } returns mockRenderThread
     every { mockRenderer.scheduleRepaint() } just runs
-    testMapController.addWidget(widget)
-    verifyOnce { mockRenderThread.addWidget(widget) }
+    testMapController.addWidget(mockWidget)
+    verifyOnce { mockRenderThread.addWidget(mockWidget) }
+    verifyOnce { mockWidget.setRepaintTrigger(any()) }
     verifyOnce { mockRenderer.scheduleRepaint() }
   }
 
   @OptIn(MapboxExperimental::class)
   @Test
   fun removeWidgetTest() {
-    val widget = createTestWidget()
+    val mockWidget = mockk<BitmapWidget>()
+    every { mockWidget.setRepaintTrigger(any()) } just runs
     val mockRenderThread = mockk<MapboxRenderThread>(relaxed = true)
     every { mockRenderer.renderThread } returns mockRenderThread
     every { mockRenderer.scheduleRepaint() } just runs
-    every { mockRenderThread.removeWidget(widget) } returns true
-    assertTrue(testMapController.removeWidget(widget))
-    verifyOnce { mockRenderThread.removeWidget(widget) }
+    every { mockRenderThread.removeWidget(mockWidget) } returns true
+    assertTrue(testMapController.removeWidget(mockWidget))
+    verifyOnce { mockWidget.setRepaintTrigger(null) }
+    verifyOnce { mockRenderThread.removeWidget(mockWidget) }
     verifyOnce { mockRenderer.scheduleRepaint() }
   }