Expose viewAnnotationAvoidLayers (#2435)

Author: evil159

CHANGELOG.md

@@ -6,6 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 * Promote `ClipLayer.clipLayerTypes` and `ClipLayer.clipLayerScope` to stable.
 * Remove experimental `DirectionalLight.shadowQuality`.
+* Add experimental `ViewAnnotationManager.viewAnnotationAvoidLayers` for specifying layers that view annotations should avoid. The API currently only supports line layers.
 * Add support for the `maxOverscaleFactorForParentTiles` property in `CustomRasterSource` and `CustomGeometrySource`, allowing greater control over tile overscaling behavior when rendering custom raster tiles.
 * Add support for experimental *-use-theme propert that allow to override the color theme set on the Map. This is experimental and have several limitations - currently expressions are not supported. Color properties in Lights, Rain, Snow are not supported. *-use-theme for layer applied only after zoom level change.
 * Update CoreMaps to 11.10.0-rc.1 and Common to 24.10.0-rc.1.

Sources/Examples/All Examples/Annotations/DynamicViewAnnotationExample.swift

@@ -12,6 +12,8 @@ final class DynamicViewAnnotationExample: UIViewController, ExampleProtocol {
     private var routes = [Route]() {
         didSet {
             oldValue.forEach { $0.remove() }
+            // prevent eta labels from showing up on overlapped parts of the route
+            mapView.viewAnnotations.viewAnnotationAvoidLayers = Set(routes.map(\.layerId))
             routes.forEach { route in
                 route.mapView = mapView
                 route.display()

Sources/MapboxMaps/Annotations/ViewAnnotationManager.swift

@@ -82,6 +82,15 @@ public final class ViewAnnotationManager {
         Array(objectAnnotations.values)
     }
 
+    /// Specify layers that view annotations should avoid. This applies to ALL view annotations associated to any layer.
+    /// The API currently only supports line layers.
+    @_spi(Experimental)
+    @_documentation(visibility: public)
+    public var viewAnnotationAvoidLayers: Set<String> {
+        get { mapboxMap.viewAnnotationAvoidLayers }
+        set { mapboxMap.viewAnnotationAvoidLayers = newValue }
+    }
+
     /// The complete list of annotations associated with the receiver.
     @available(*, deprecated, renamed: "allAnnotations", message: "Please use allAnnotations instead, or directly access ViewAnnotation itself")
     public var annotations: [UIView: ViewAnnotationOptions] {

Sources/MapboxMaps/Foundation/MapboxMap.swift

@@ -5,6 +5,7 @@ import MapboxCoreMaps
 import Turf
 
 protocol MapboxMapProtocol: AnyObject {
+    var viewAnnotationAvoidLayers: Set<String> { get set }
     var cameraBounds: CameraBounds { get }
     var cameraState: CameraState { get }
     var size: CGSize { get }
@@ -1666,6 +1667,11 @@ extension MapboxMap {
 // MARK: - View Annotations
 
 extension MapboxMap {
+    var viewAnnotationAvoidLayers: Set<String> {
+        get { __map.getViewAnnotationAvoidLayers() }
+        set { __map.setViewAnnotationAvoidLayersForLayerIds(newValue) }
+    }
+
     func setViewAnnotationPositionsUpdateCallback(_ callback: ViewAnnotationPositionsUpdateCallback?) {
         __map.setViewAnnotationPositionsUpdateListenerFor(callback.map {
             ViewAnnotationPositionsUpdateListenerImpl(callback: $0)

Tests/MapboxMapsTests/Annotations/ViewAnnotationManagerTests.swift

@@ -1,5 +1,5 @@
 import XCTest
-@testable import MapboxMaps
+@testable @_spi(Experimental) import MapboxMaps
 
 final class ViewAnnotationManagerTests: XCTestCase {
 
@@ -437,6 +437,13 @@ final class ViewAnnotationManagerTests: XCTestCase {
         XCTAssertTrue(bounds.contains(forArea: innerBounds, wrappedCoordinates: true))
     }
 
+    func testAvoidLayers() throws {
+        let layers: Set<String> = ["my-symbol-layer", "my-fill-layer"]
+        manager.viewAnnotationAvoidLayers = layers
+
+        XCTAssertEqual(manager.viewAnnotationAvoidLayers, layers)
+    }
+
     // MARK: - Helper functions
 
     @available(*, deprecated)

Tests/MapboxMapsTests/Foundation/MapboxMapTests.swift

@@ -508,4 +508,13 @@ final class MapboxMapTests: XCTestCase {
         XCTAssertEqual(CGPoint(x: 102, y: 1).fit(to: size), CGPoint(x: -1, y: -1))
         XCTAssertEqual(CGPoint(x: 1, y: 101).fit(to: size), CGPoint(x: -1, y: -1))
     }
+
+    func testViewAnnotationAvoidLayers() {
+        let layers: Set<String> = ["my-symbol-layer", "my-fill-layer"]
+
+        mapboxMap.viewAnnotationAvoidLayers = layers
+
+        XCTAssertEqual(mapboxMap.viewAnnotationAvoidLayers, layers)
+        XCTAssertEqual(mapboxMap.__testingMap.getViewAnnotationAvoidLayers(), layers)
+    }
 }

Tests/MapboxMapsTests/Foundation/Mocks/MockMapboxMap.swift

@@ -3,6 +3,7 @@ import CoreLocation
 import UIKit
 
 final class MockMapboxMap: MapboxMapProtocol {
+    var viewAnnotationAvoidLayers = Set<String>()
     var options: MapOptions = MapOptions()
 
     let events = MapEvents(makeGenericSubject: { _ in