Introduce Interactions API #748

pjleonard37 · 2024-10-24T02:18:00Z

What does this pull request do?

This PR introduces the experimental Interactions API introduced on iOS and Android in 11.8.0-beta.1. Specifically it:

Introduces the experimental MapboxMap.addInteractions method, which allows you to add interactions to the map.
- Introduces TapInteraction and LongTapInteraction, which allow you to add tap and longTap interactions to the map.
- Introduces FeaturesetDescriptor -- and convenience descriptors for StandardBuildings, StandardPOIs, and StandardPlaceLabels -- which allow you to describe the Featuresets you want Interactions to target.
Introduces new methods for queryRenderedFeatures, querySourceFeatures, setFeatureState, getFeatureState, removeFeatureState, resetFeatureState and adds interfaces for iOS and Android
Adds all necessary extensions for conversions on iOS and Android
Adds an example showing how to query features in featuresets and set feature states.
Adds necessary Turf adapters
Adds tests

Simulator.Screen.Recording.-.iPhone.16.-.2025-01-08.at.19.57.40.mp4

Work for another PR:

Tests which use a mocked interaction
Expand on current example to better show use cases for API

What is the motivation and context behind this change?

Platform alignment and enable Interactive Features

Pull request checklist:

Add a changelog entry.
Write tests for all new functionality. If tests were not written, please explain why.
Add documentation comments for any added or updated public APIs.

ios/Classes/Extensions.swift

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt

lib/src/style/mapbox_styles.dart

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt

lib/src/mapbox_map.dart

persidskiy

some small bits of review

example/lib/interactive_features_example.dart

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapInterfaceController.kt

lib/src/mapbox_map.dart

example/lib/interactive_features_example.dart

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt

example/lib/interactive_features_example.dart

ios/mapbox_maps_flutter/Sources/mapbox_maps_flutter/Classes/MapboxMapController.swift

pjleonard37 · 2025-01-10T01:34:17Z

lib/src/mapbox_map.dart

+
+  /// Add an interaction
+  @experimental
+  void addInteraction(Interaction interaction, OnInteraction action) {


@evil159 -- I'd appreciate a particularly thorough review of this section (setting up the listener and message channel. I model it broadly after our approach to gestures, but would welcome any suggested improvements. What do you think of this system of using both _InteractionListener and _InteractionsList?

Given the limitations - I think this is perfectly fine way to do it(it is also probably the only way to do it :)

I think the only thing that is missing here is the ability to remove interaction.

pjleonard37 · 2025-01-10T01:37:00Z

lib/src/mapbox_maps_platform.dart

+      Interaction interaction, int interactionID) async {
+    try {
+      return _channel
+          .invokeMethod('interactions#add_interaction', <String, dynamic>{


@evil159 - any better approach here you can think of?

Could it be a way to go to define an internal structure in pigeon templates to carry all of this data and define a method that accepts this structure. It will not change much conceptually, but at least basics(serialization, message sending) will be handled by Pigeon.

I think that's a good improvement -- I'll ticket it

I tried this out in the latest commit with the creation of _InteractionPigeon. I'm curious to hear your thoughts on this. I think it cleans up the platform code just a bit.

Hmmm... I don't see the reason to wrap interaction into _InteractionPigeon anymore(not sure why I didn't suggest it in the first place, sorry), we can just pass _Interaction itself, right?

We can't pass _Interaction because it has types which are not supported by MessageCodec. Specifically: FeaturesetDescriptor and _InteractionType.

I see, they've changed the way objects are encoded/decoded lately, you can make it work passing the _Interaction type to a pigeon-generated method, but yeah, it won't work out of box when using custom channels.

lib/src/style/mapbox_styles.dart

lib/src/style/interactive_features/standard_poi.dart

lib/src/pigeons/map_interfaces.dart

example/lib/interactive_features_example.dart

ios/mapbox_maps_flutter/Sources/mapbox_maps_flutter/Classes/MapInterfaceController.swift

evil159 · 2025-01-14T12:23:56Z

lib/src/mapbox_map.dart

+
+  /// Add an interaction
+  @experimental
+  void addInteraction(Interaction interaction, OnInteraction action) {


Given the limitations - I think this is perfectly fine way to do it(it is also probably the only way to do it :)

evil159 · 2025-01-14T12:25:35Z

lib/src/mapbox_map.dart

+
+  /// Add an interaction
+  @experimental
+  void addInteraction(Interaction interaction, OnInteraction action) {


I think the only thing that is missing here is the ability to remove interaction.

lib/src/style/interactive_features/standard_poi.dart

lib/src/style/interactive_features/interactive_features.dart

evil159

I have to admit I didn't go through the whole PR after recent changes, instead I've reviewed the parts that were changed since and they look good, thank you @pjleonard37 for the effort!

* Update README.md for viewport support (#841) * Update README.md (#837) (#842) it is not nullable and it is Point object Co-authored-by: shinriyo <shinriyo@gmail.com> * Align tap propagation behavior on Android and iOS. (#847) * Introduce Interactions API (#748) * Initial implementation of QRF and Featurestate * Add Standard experimental, build out Android * Finish up Android interfaces, general cleanup * Linting updates * Additional lint edits * Clean up type conversions, restore tests * Update for linting * Change toValue back * Update example, some docs cleanup * Revert * Build out geometries * Address review feedback * Add framework for typed interactions * Update generated code * Add map.addInteraction, add Standard featuresets * Update for sanity check * Remove viewport query, general cleanup * Update viewport QRF implementation * Remove FeaturesetQueryTarget, minor updates from review * Update Android interface, some formatting * Make Interactions internal, update implementation * Initial generics implementation * Update Podfile * Update to move _Interactions internal * Update error handling and interfaces * Update for lint * Move interaction to pigeon generation * Expand use of generics, rename --------- Co-authored-by: Release SDK bot for Maps SDK team <maps_sdk_ios@mapbox.com> * Bump platform SDKs version (#855) * Bump SDK version to 2.6.0-rc.1 (#856) --------- Co-authored-by: Patrick Leonard <pjleonard37@users.noreply.github.com> Co-authored-by: shinriyo <shinriyo@gmail.com> Co-authored-by: Release SDK bot for Maps SDK team <maps_sdk_ios@mapbox.com>

* Initial implementation of QRF and Featurestate * Add Standard experimental, build out Android * Finish up Android interfaces, general cleanup * Linting updates * Additional lint edits * Clean up type conversions, restore tests * Update for linting * Change toValue back * Update example, some docs cleanup * Revert * Build out geometries * Address review feedback * Add framework for typed interactions * Update generated code * Add map.addInteraction, add Standard featuresets * Update for sanity check * Remove viewport query, general cleanup * Update viewport QRF implementation * Remove FeaturesetQueryTarget, minor updates from review * Update Android interface, some formatting * Make Interactions internal, update implementation * Initial generics implementation * Update Podfile * Update to move _Interactions internal * Update error handling and interfaces * Update for lint * Move interaction to pigeon generation * Expand use of generics, rename --------- Co-authored-by: Release SDK bot for Maps SDK team <maps_sdk_ios@mapbox.com>

pjleonard37 changed the title ~~Introduce Featuresets and Interactions~~ Introduce Featuresets, QRF, QSF, FS methods Oct 25, 2024

pjleonard37 marked this pull request as ready for review October 25, 2024 02:37

pjleonard37 requested a review from a team as a code owner October 25, 2024 02:37

pjleonard37 requested a review from maios October 25, 2024 02:38

pjleonard37 commented Oct 25, 2024

View reviewed changes

ios/Classes/Extensions.swift Show resolved Hide resolved

pjleonard37 commented Oct 25, 2024

View reviewed changes

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt Outdated Show resolved Hide resolved

pjleonard37 requested review from evil159 and persidskiy October 25, 2024 21:03

evil159 reviewed Oct 28, 2024

View reviewed changes

lib/src/style/mapbox_styles.dart Show resolved Hide resolved

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt Outdated Show resolved Hide resolved

evil159 reviewed Oct 28, 2024

View reviewed changes

lib/src/mapbox_map.dart Outdated Show resolved Hide resolved

lib/src/mapbox_map.dart Outdated Show resolved Hide resolved

persidskiy reviewed Oct 29, 2024

View reviewed changes

example/lib/interactive_features_example.dart Outdated Show resolved Hide resolved

example/lib/interactive_features_example.dart Outdated Show resolved Hide resolved

example/lib/interactive_features_example.dart Outdated Show resolved Hide resolved

kiryldz reviewed Oct 30, 2024

View reviewed changes

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapInterfaceController.kt Outdated Show resolved Hide resolved

persidskiy reviewed Oct 30, 2024

View reviewed changes

lib/src/mapbox_map.dart Show resolved Hide resolved

kiryldz reviewed Oct 30, 2024

View reviewed changes

example/lib/interactive_features_example.dart Outdated Show resolved Hide resolved

kiryldz reviewed Oct 30, 2024

View reviewed changes

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt Outdated Show resolved Hide resolved

pjleonard37 force-pushed the MAPSFLT-232-interactive-features branch 2 times, most recently from 2db19c7 to 0ae5762 Compare January 8, 2025 23:41

pjleonard37 changed the title ~~Introduce Featuresets, QRF, QSF, FS methods~~ Introduce Interactions API Jan 9, 2025

pjleonard37 commented Jan 9, 2025

View reviewed changes

example/lib/interactive_features_example.dart Show resolved Hide resolved

pjleonard37 force-pushed the MAPSFLT-232-interactive-features branch from 62026a5 to ff14167 Compare January 10, 2025 00:06

pjleonard37 commented Jan 10, 2025

View reviewed changes

ios/mapbox_maps_flutter/Sources/mapbox_maps_flutter/Classes/MapboxMapController.swift Show resolved Hide resolved

pjleonard37 commented Jan 10, 2025

View reviewed changes

lib/src/style/mapbox_styles.dart Show resolved Hide resolved

pjleonard37 commented Jan 10, 2025

View reviewed changes

lib/src/style/interactive_features/standard_poi.dart Outdated Show resolved Hide resolved

pjleonard37 commented Jan 10, 2025

View reviewed changes

lib/src/pigeons/map_interfaces.dart Show resolved Hide resolved

pjleonard37 requested review from evil159 and persidskiy January 10, 2025 02:01

evil159 reviewed Jan 14, 2025

View reviewed changes

persidskiy reviewed Jan 15, 2025

View reviewed changes

lib/src/style/interactive_features/interactive_features.dart Outdated Show resolved Hide resolved

Release SDK bot for Maps SDK team added 24 commits January 28, 2025 15:57

Additional lint edits

b06416e

Clean up type conversions, restore tests

9400d40

Update for linting

6118ca2

Change toValue back

ad78eb7

Update example, some docs cleanup

15397b0

Revert

7d1cd5c

Build out geometries

3a1cc8a

Address review feedback

76a83e9

Add framework for typed interactions

f39abf8

Update generated code

f78a1eb

Add map.addInteraction, add Standard featuresets

8bfcbe9

Update for sanity check

c42b192

Remove viewport query, general cleanup

d291775

Update viewport QRF implementation

9d6a8d1

Remove FeaturesetQueryTarget, minor updates from review

fd1913b

Update Android interface, some formatting

51fff7f

Make Interactions internal, update implementation

c92d177

Initial generics implementation

f7b47ec

Update Podfile

67a475b

Update to move _Interactions internal

714411d

Update error handling and interfaces

47b3fa8

Update for lint

46aaea6

Move interaction to pigeon generation

0dc7252

Expand use of generics, rename

fecfbaf

pjleonard37 force-pushed the MAPSFLT-232-interactive-features branch from 1d137f1 to fecfbaf Compare January 28, 2025 20:58

evil159 approved these changes Jan 29, 2025

View reviewed changes

pjleonard37 merged commit 178297d into main Jan 29, 2025
6 checks passed

pjleonard37 deleted the MAPSFLT-232-interactive-features branch January 29, 2025 13:14

Introduce Interactions API #748

Introduce Interactions API #748

Uh oh!

Conversation

pjleonard37 commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this pull request do?

What is the motivation and context behind this change?

Pull request checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

persidskiy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

evil159 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pjleonard37 commented Oct 24, 2024 •

edited

Loading