Adding My Location parameter to the Google Maps plugin #898

timtraversy · 2018-11-14T03:26:10Z

This pull request introduces a My Location parameter to the Google Maps plugin. This is a feature that Google Maps offers that puts a blue location dot on the user's location, and provides a clickable compass. This parameter works the same way as the zoom, or scale options, and can be enabled or disabled by updating the map options. I've added:

The myLocationEnabled parameter to the Google Map options class, as well as functions that switch it on and off in Android and iOS.
A toggle location button in the example app which demonstrates the new parameter. This required adding location permissions to the app.

I also fixed a bug in the iOS code which was improperly loading the map options when the map was first initiated.

Things I am uncertain about:

On iOS - when the location is turned on and then off, it can't be turned on again. This seems to be a bug in Google Maps, or maybe an intended functionality.
Permission handling. Right now the location feature just quietly fails if they don't have permissions enabled, so it might be good to add some error reporting there.

amirh

Thanks for the contribution and the bug fix!

I left a few comments, we will also need to make the formatter presubmit happy before landing this.

Interesting that location can't be turned on again on iOS, what happens when you enabled it the second time? does it fail or just updates the property and nothing happens?

I'm also wondering about the "My location button", if I understand the documentation correctly it seems that for Google Maps on Android if you turn on "my location" you get the "my location" button as well unless you explicitly set it to off, and that on iOS the default is to not show the button.
At a minimum we should make sure the behavior is the same on both platforms (e.g explicitly set the button to true/false). Would be even better to add a "myLocationButton" option to the map options (though not a must as part of this PR).

Also note that I my availability is limited this week so I might be slow to follow up.

packages/google_maps_flutter/android/src/main/AndroidManifest.xml

packages/google_maps_flutter/example/ios/Runner.xcodeproj/project.pbxproj

packages/google_maps_flutter/example/ios/Runner/Info.plist

...le_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapController.java

packages/google_maps_flutter/example/lib/map_ui.dart

packages/google_maps_flutter/ios/Classes/GoogleMapController.m

packages/google_maps_flutter/lib/src/ui.dart

timtraversy · 2018-11-14T14:38:10Z

Thanks for the review!

I modified the code so that both platforms show the My Location button along with the indicator, but I agree that eventually it would be good to build that out into a separate option. I'm seeing a bug on iOS however where the button doesn't animate the camera to their location.

Other change: passing boolean from GoogleMapBuilder directly into GoogleMapController so it can be used for initialization. It might be good to eventually wrap this in a CustomGoogleMapOptions class since I assume more custom features will be added someday (like My Location button).

On the iOS on/off behavior, I found this open issue: https://issuetracker.google.com/issues/74362141. No notice on when it will be fixed.

Also: I'm running the flutter plugins formatter but my iOS files are still failing. Do I have to fix them by hand? Plus it looks like a bunch of files outside this plugin are being flagged by the test.

I'm going to do another commit to clean up formatting.

amirh · 2018-11-20T00:34:08Z

The formatting mismatch was probably because you are using a newer clang-format than the one the CI system uses.
I just updated the clang version we use on Cirrus and reformatted the repo.
Could you please rebase this PR?

Removed API keys Fixed typo Nitpicks, standard location button behavior, dart doc comments. Ran formatter, updated GoogleMapController initializer Remove keys

timtraversy · 2018-11-20T02:43:25Z

Ok I'm now using version 2018-10-04 of clang-format from Homebrew. Does that match with yours?

amirh

Looks like the CI formatter is green now.

Overall looks good, left a few comments and a question.

...le_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapController.java

packages/google_maps_flutter/example/ios/Runner.xcodeproj/project.pbxproj

...ges/google_maps_flutter/example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

...google_maps_flutter/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

packages/google_maps_flutter/lib/src/ui.dart

amirh · 2018-11-20T03:18:37Z

...oogle_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapBuilder.java


  GoogleMapController build(
      int id, Context context, AtomicInteger state, PluginRegistry.Registrar registrar) {
    final GoogleMapController controller =
-        new GoogleMapController(id, context, state, registrar, options);
+        new GoogleMapController(id, context, state, registrar, options, myLocationEnabled);


Can you explain again why can't we follow the same pattern as setTrackCameraPosition...
e.g after controller.init call controller.setMyLocationEnabled ?

From debugging, it appears that setMyLocationEnabled in GMController is called before onMapReady. So if it that function is called there in GMBuilder, it will in turn call googleMap.setMyLocationEnabled before googleMap is initiated by onMapReady.

If we keep the same pattern, setMyLocationEnabled has to do two different things. When it is being called from the Builder, googleMap is null, so it can't call googleMap's functions. But when the user updates map options it does have to access googleMap directly. The trackCamera option doesn't need to update googleMap directly.

In my new commit, I split the setLocationEnabled function into two pieces, one that is called by the builder and one that is called when the map options are updated, to illustrate this problem.

Thanks for the explanation, now I get it 😄

What do you think about calling an updateMyLocationEnabled() from onMapReady which will set the map's my location enabled field to whatever the value of the member myLocationEnabled is.
Then have setMyLocationEnabled to do nothing if the new value is the same as the current one, or if we're not yet initialized, otherwise update myLocationEnabled (the member) and call updateMyLocationEnabled()

Okay I did something like that. setMyLocationEnabled skips updateMyLocation if the map is null, and during map initiation updateMyLocation is called.

From the docs its unclear to me if you need to check permissions to setMyLocationEnabled to false, so I check them no matter if you are turning it on or off, that might not be right.

…, changed setLocationEnabled function

...le_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapController.java

packages/google_maps_flutter/example/android/app/src/main/AndroidManifest.xml

amirh · 2018-11-20T18:11:09Z

...oogle_maps_flutter/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapBuilder.java


  GoogleMapController build(
      int id, Context context, AtomicInteger state, PluginRegistry.Registrar registrar) {
    final GoogleMapController controller =
-        new GoogleMapController(id, context, state, registrar, options);
+        new GoogleMapController(id, context, state, registrar, options, myLocationEnabled);


Thanks for the explanation, now I get it 😄

What do you think about calling an updateMyLocationEnabled() from onMapReady which will set the map's my location enabled field to whatever the value of the member myLocationEnabled is.
Then have setMyLocationEnabled to do nothing if the new value is the same as the current one, or if we're not yet initialized, otherwise update myLocationEnabled (the member) and call updateMyLocationEnabled()

…initiation and later.

amirh

Looks good, just revert the Runner.xcscheme rename.

amirh · 2018-11-20T19:11:21Z

I reverted the deletion of Runner.xcscheme (looks like the last commit deleted the file with the new name but didn't put back the original file).

amirh

LGTM, thanks for the contribution!

Will land on green.

Introduces a My Location parameter to the Google Maps plugin. This is a feature that Google Maps offers that puts a blue location dot on the user's location, and provides a clickable compass. This parameter works the same way as the zoom, or scale options, and can be enabled or disabled by updating the map option.

…r#898)" This reverts commit ae8875d.

googlebot added the cla: yes label Nov 14, 2018

timtraversy changed the title ~~Added My Location parameter to GoogleMapOptions~~ Adding My Location parameter to GoogleMapOptions Nov 14, 2018

timtraversy changed the title ~~Adding My Location parameter to GoogleMapOptions~~ Adding My Location parameter to the Google Maps plugin Nov 14, 2018

amirh suggested changes Nov 14, 2018

View reviewed changes

timtraversy mentioned this pull request Nov 14, 2018

Any UI update on google_maps_flutter example project gives error "The getter 'bearing' was called on null" flutter/flutter#24308

Closed

timtraversy added 2 commits November 19, 2018 21:24

Added my location to ios and android, fixed ios bug

af9aeab

Removed API keys Fixed typo Nitpicks, standard location button behavior, dart doc comments. Ran formatter, updated GoogleMapController initializer Remove keys

Merge branch 'master' of github.com:flutter/plugins into my_location

d14f518

amirh suggested changes Nov 20, 2018

View reviewed changes

timtraversy added 2 commits November 20, 2018 01:25

Reverted mistaken edits, improved documentation for My Location layer…

35596d7

…, changed setLocationEnabled function

Put back deleted runner scheme

c04af81

amirh reviewed Nov 20, 2018

View reviewed changes

timtraversy added 2 commits November 20, 2018 13:40

Changed location functions to set and update, to handle calls during …

333e64b

…initiation and later.

Format

d57da92

amirh reviewed Nov 20, 2018

View reviewed changes

timtraversy and others added 2 commits November 20, 2018 14:01

Rename runner.xcscheme

7564f65

revert deletion of Runner.xcscheme

0704c61

Add missing period at end of sentence.

e311e1c

amirh approved these changes Nov 20, 2018

View reviewed changes

amirh merged commit 325f238 into flutter:master Nov 20, 2018

timtraversy deleted the my_location branch November 20, 2018 21:30

amirh mentioned this pull request Nov 27, 2018

[Google Maps Plugin] setMyLocation Feature flutter/flutter#23730

Closed

andreidiaconu added a commit to andreidiaconu/plugins that referenced this pull request Feb 17, 2019

Revert "Add a My Location parameter to the Google Maps plugin (flutte…

e1e50e5

…r#898)" This reverts commit ae8875d.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding My Location parameter to the Google Maps plugin #898

Adding My Location parameter to the Google Maps plugin #898

timtraversy commented Nov 14, 2018

amirh left a comment

timtraversy commented Nov 14, 2018 •

edited

Loading

amirh commented Nov 20, 2018

timtraversy commented Nov 20, 2018

amirh left a comment

amirh Nov 20, 2018

timtraversy Nov 20, 2018

amirh Nov 20, 2018

timtraversy Nov 20, 2018

amirh Nov 20, 2018

amirh left a comment

amirh commented Nov 20, 2018

amirh left a comment

Adding My Location parameter to the Google Maps plugin #898

Adding My Location parameter to the Google Maps plugin #898

Conversation

timtraversy commented Nov 14, 2018

amirh left a comment

Choose a reason for hiding this comment

timtraversy commented Nov 14, 2018 • edited Loading

amirh commented Nov 20, 2018

timtraversy commented Nov 20, 2018

amirh left a comment

Choose a reason for hiding this comment

amirh Nov 20, 2018

Choose a reason for hiding this comment

timtraversy Nov 20, 2018

Choose a reason for hiding this comment

amirh Nov 20, 2018

Choose a reason for hiding this comment

timtraversy Nov 20, 2018

Choose a reason for hiding this comment

amirh Nov 20, 2018

Choose a reason for hiding this comment

amirh left a comment

Choose a reason for hiding this comment

amirh commented Nov 20, 2018

amirh left a comment

Choose a reason for hiding this comment

timtraversy commented Nov 14, 2018 •

edited

Loading