Update gl-native #326

julianrex · 2020-07-02T20:41:55Z

This PR updates the Mapbox Maps SDK for iOS to use a pre-built GL Native binary rather than building from source as a submodule dependency. GL Native is changing some of its development workflows to build some Mapbox platform-specific features internally, similar to Chrome/Chromium development.

How to build
Going forward, updates to the build process are as follows:

Sign up or login to your Mapbox account.
Go to your Mapbox account's access tokens page (https://account.mapbox.com/access-tokens/) and create a secret token with the downloads:read scope.

Create a ~/.netrc file which looks like this

 machine api.mapbox.com
 login mapbox
 password <INSERT API TOKEN>

If using Cocoapods, build the project as you would have before.
If using Carthage, you will need to make a few quick updates
- Update cartfile:
```
binary "https://api.mapbox.com/downloads/v2/carthage/mobile-maps/mapbox-ios-sdk-dynamic.json" ~> 5.10.0-alpha.1
github "mapbox/mapbox-events-ios" ~> 0.10
```
- Install dependencies via carthage update appending --use-netrc :
  carthage update --platform iOS --use-netrc
Direct Downloads are not supported in this alpha release

License update for Mapbox builds of GL Native
New binary releases of GL Native are now licensed under the Mapbox Terms of Service. The Mapbox Maps SDKs repos will continue to be public and licensed under BSD-2.

If you have any questions about how this change does or doesn’t impact your use of the Maps SDK please don’t hesitate to reach out to Mapbox Support to connect with the Mapbox team.

…arwin/developer.xcconfig

1ec5 · 2020-07-06T18:37:35Z

platform/ios/CHANGELOG.md

+- Source Modularization.
+  Introduces a SourceManager + *SourceFactory classes similar to the work done on layer modularization.
+
+- [core] Enable source "volatile" flag initialization in style.
+
+  The source `volatile` flag value can be defined in the style as following:
+
+  ```
+  "example_source": {
+    "volatile": true
+  }
+  ```
+
+  For the sources with the `volatile` flag set, the tiles are not stored in the local storage. The `volatile` flag is applicable for all source types, which allow loading tiles from a remote server i.e. `vector`, `raster`, `raster-dem` source types. For other source types this setting is ignored.
+
+- [core] Enable `Renderer::collectPlacedSymbolData()` API for all map modes.
+
+  Before, it was functional only for the `Tile` map mode.
+
+- [core] Add `emphasis-circle-color` and `emphasis-circle-radius` properties to LocationIndicator layer.
+
+  LocationIndicator layer gets the ability to draw an additional circle, controlled via these two properties, to create effects that emphasize the indicator.


I don’t think any of these changes are applicable to the iOS or macOS map SDK yet.

@1ec5 what do you think is missing / blocking the availability of the source volatile flag? GL Native enabled customers setting the flag in the style, and I thought that should flow through to the iOS SDK, particularly since caching is controlled in native

Sorry, I overlooked that one. It should work fine, but we should mention it as an option in style JSON. To my knowledge, we haven’t hooked it up to MGLTileSourceOption in the runtime styling API. It would be an easy change but it just hasn’t happened yet.

platform/ios/CHANGELOG.md

1ec5 · 2020-07-06T18:42:09Z

platform/ios/CHANGELOG.md

+  The `GeoJSON` geometry will be clipped based on the tile of the evaluated feature if its contained points are over the `GeometryPointsThreshold`.
+
+- [core] Introduce `DatabaseFileSource::prefetchAmbientCache()`.
+  This method pre-fetches resources from network and populates the ambient cache.
+
+- Introduce LRU queue and setting to control queue size.
+
+  Last recently used (LRU) access events are recorded for single resource or tile request, therefore, reduce performance and deteriorate storage. LRU queue size setting allows to control how often queue is flushed to the database. Default queue size is 50.
+
+- [core] Batch API to pre-fetch ambient cache.
+  Now OfflineDownloadParameters can be initialized with a list of locations. Each location is represented with a `LatLngBoundsZoom` instance.
+
+  Thus, we can fetch multiple areas with a single `DatabaseFileSource::prefetchAmbientCache()` API call (and parsing the style only once).
+
+- [core] Introduce `hashLayout()` function for Layer::Impl.
+  `hashLayout()` is used to generate aggregated hash value for layout properties. It will replace `stringifyLayout()` when grouping layout.


I don’t think any of these changes apply to the iOS or macOS map SDK yet.

platform/ios/CHANGELOG.md

chloekraw · 2020-07-06T19:08:56Z

platform/ios/CHANGELOG.md

+
+  Before, it was functional only for the `Tile` map mode.
+
+- [core] Add `emphasis-circle-color` and `emphasis-circle-radius` properties to LocationIndicator layer.


The LocationIndicatorLayer is not used on iOS Hydrogen.

chloekraw · 2020-07-06T19:09:22Z

platform/ios/CHANGELOG.md

+
+### ✨ New features
+
+- Source Modularization.


Cannot be accessed on iOS SDK yet.

chloekraw · 2020-07-06T19:10:00Z

platform/ios/CHANGELOG.md

+
+  For the sources with the `volatile` flag set, the tiles are not stored in the local storage. The `volatile` flag is applicable for all source types, which allow loading tiles from a remote server i.e. `vector`, `raster`, `raster-dem` source types. For other source types this setting is ignored.
+
+- [core] Enable `Renderer::collectPlacedSymbolData()` API for all map modes.


What's the impact of this change?

If this applies to iOS developers, we should rephrase and reformat to match the rest of our changelog entries.

chloekraw · 2020-07-06T19:11:05Z

platform/ios/CHANGELOG.md

+- Source Modularization.
+  Introduces a SourceManager + *SourceFactory classes similar to the work done on layer modularization.
+
+- [core] Enable source "volatile" flag initialization in style.
+
+  The source `volatile` flag value can be defined in the style as following:
+
+  ```
+  "example_source": {
+    "volatile": true
+  }
+  ```
+
+  For the sources with the `volatile` flag set, the tiles are not stored in the local storage. The `volatile` flag is applicable for all source types, which allow loading tiles from a remote server i.e. `vector`, `raster`, `raster-dem` source types. For other source types this setting is ignored.
+
+- [core] Enable `Renderer::collectPlacedSymbolData()` API for all map modes.
+
+  Before, it was functional only for the `Tile` map mode.
+
+- [core] Add `emphasis-circle-color` and `emphasis-circle-radius` properties to LocationIndicator layer.
+
+  LocationIndicator layer gets the ability to draw an additional circle, controlled via these two properties, to create effects that emphasize the indicator.


@1ec5 what do you think is missing / blocking the availability of the source volatile flag? GL Native enabled customers setting the flag in the style, and I thought that should flow through to the iOS SDK, particularly since caching is controlled in native

chloekraw · 2020-07-06T19:12:07Z

platform/ios/CHANGELOG.md

+  The `GeoJSON` geometry will be clipped based on the tile of the evaluated feature if its contained points are over the `GeometryPointsThreshold`.
+
+- [core] Introduce `DatabaseFileSource::prefetchAmbientCache()`.
+  This method pre-fetches resources from network and populates the ambient cache.
+
+- Introduce LRU queue and setting to control queue size.
+
+  Last recently used (LRU) access events are recorded for single resource or tile request, therefore, reduce performance and deteriorate storage. LRU queue size setting allows to control how often queue is flushed to the database. Default queue size is 50.
+
+- [core] Batch API to pre-fetch ambient cache.
+  Now OfflineDownloadParameters can be initialized with a list of locations. Each location is represented with a `LatLngBoundsZoom` instance.
+
+  Thus, we can fetch multiple areas with a single `DatabaseFileSource::prefetchAmbientCache()` API call (and parsing the style only once).
+
+- [core] Introduce `hashLayout()` function for Layer::Impl.
+  `hashLayout()` is used to generate aggregated hash value for layout properties. It will replace `stringifyLayout()` when grouping layout.


Co-authored-by: Minh Nguyễn <mxn@1ec5.org>

platform/ios/CHANGELOG.md

julianrex added 7 commits June 30, 2020 12:46

Update with 1.7.0 release of gl-native

6eb0af4

Remove gl-native

b3c8ef3

Remove mobile-events-ios

f7762b9

Add gl-native

816441c

Remove the DevelopmentTeam id - this can be pulled in from platform/d…

36f388b

…arwin/developer.xcconfig

Initial update to Makefile, CI and deployment scripts

b9e4d84

Update for new source location.

662b1cb

julianrex requested a review from 1ec5 as a code owner July 2, 2020 20:41

julianrex requested a review from a team July 2, 2020 20:41

julianrex added 5 commits July 2, 2020 17:03

Upgrade carthage instead of install

902e4dc

Update

53fff08

Temporarily comment out podspec linting

b34ae2d

Update netrc file generation

e54882d

Update netrc generation

2dc109f

julianrex removed request for a team and 1ec5 July 2, 2020 22:42

julianrex and others added 8 commits July 2, 2020 21:17

Add Carthage framework path to test target run path

226c07a

Ensure build directory exists

4749e56

Update docs

2bd13f0

Update pod readme

4243537

Add build directory

89d8d95

Update Products directory

4793ed4

Bumped version

712d1d4

Update build settings

c339a2f

nishant-karajgikar approved these changes Jul 6, 2020

View reviewed changes

nishant-karajgikar self-assigned this Jul 6, 2020

Update changelog [skip_ci]

20251be

nishant-karajgikar force-pushed the jrex/registry branch from a1d5397 to 20251be Compare July 6, 2020 18:04

1ec5 added the build label Jul 6, 2020

1ec5 reviewed Jul 6, 2020

View reviewed changes

chloekraw reviewed Jul 6, 2020

View reviewed changes

nishant-karajgikar and others added 4 commits July 6, 2020 15:16

Update platform/ios/CHANGELOG.md

5052865

Co-authored-by: Minh Nguyễn <mxn@1ec5.org>

Update platform/ios/CHANGELOG.md

31abf7e

Co-authored-by: Minh Nguyễn <mxn@1ec5.org>

Update platform/ios/CHANGELOG.md

9ae281c

Co-authored-by: Minh Nguyễn <mxn@1ec5.org>

Update platform/ios/CHANGELOG.md

7c6d149

Co-authored-by: Minh Nguyễn <mxn@1ec5.org>

chloekraw approved these changes Jul 6, 2020

View reviewed changes

Review commits

a2c017e

nishant-karajgikar force-pushed the jrex/registry branch from 881c3ca to a2c017e Compare July 6, 2020 19:32

nishant-karajgikar merged commit 28e4c59 into master Jul 6, 2020

nishant-karajgikar deleted the jrex/registry branch July 6, 2020 20:26

1ec5 mentioned this pull request Jul 9, 2020

Require map SDK v5.9.0 in v0.40.x mapbox/mapbox-navigation-ios#2447

Closed

1ec5 mentioned this pull request Sep 15, 2020

build from source for macOS #444

Closed

1ec5 mentioned this pull request Nov 12, 2020

Distinguish between internal and external Carthage usage #548

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update gl-native #326

Update gl-native #326

julianrex commented Jul 2, 2020 •

edited by nishant-karajgikar

Loading

1ec5 Jul 6, 2020

chloekraw Jul 6, 2020

1ec5 Jul 6, 2020

1ec5 Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020

chloekraw Jul 6, 2020


		Before, it was functional only for the `Tile` map mode.

		- [core] Add `emphasis-circle-color` and `emphasis-circle-radius` properties to LocationIndicator layer.


		For the sources with the `volatile` flag set, the tiles are not stored in the local storage. The `volatile` flag is applicable for all source types, which allow loading tiles from a remote server i.e. `vector`, `raster`, `raster-dem` source types. For other source types this setting is ignored.

		- [core] Enable `Renderer::collectPlacedSymbolData()` API for all map modes.

Update gl-native #326

Update gl-native #326

Conversation

julianrex commented Jul 2, 2020 • edited by nishant-karajgikar Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

julianrex commented Jul 2, 2020 •

edited by nishant-karajgikar

Loading