[WIP] Traffic plugin #9
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,6 @@ xcuserdata | |
| *.moved-aside | ||
| *.xcuserstate | ||
| *.xcscmblueprint | ||
|
|
||
|
|
||
| Carthage/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Copyright © 2014–2017, Mapbox | ||
|
There was a problem hiding this comment. We didn’t start working on these plugins until this year. |
||
|
|
||
| Permission to use, copy, modify, and/or distribute this software for any | ||
| purpose with or without fee is hereby granted, provided that the above | ||
| copyright notice and this permission notice appear in all copies. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # | ||
| # Be sure to run `pod spec lint MapboxPlugins.podspec' to ensure this is a | ||
| # valid spec and to remove all comments including this before submitting the spec. | ||
| # | ||
| # To learn more about Podspec attributes see http://docs.cocoapods.org/specification.html | ||
| # To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/ | ||
| # | ||
|
|
||
| Pod::Spec.new do |s| | ||
|
|
||
| # ――― Spec Metadata ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― # | ||
| # | ||
| # These will help people to find your library, and whilst it | ||
| # can feel like a chore to fill in it's definitely to your advantage. The | ||
| # summary should be tweet-length, and the description more in depth. | ||
| # | ||
|
|
||
| s.name = "MapboxMapsPlugins" | ||
| s.version = "0.0.1" | ||
| s.summary = "Experimental plugins to supercharge your maps." | ||
|
|
||
| # This description is used to generate tags and improve search results. | ||
| # * Think: What does it do? Why did you write it? What is the focus? | ||
| # * Try to keep it short, snappy and to the point. | ||
| # * Write the description between the DESC delimiters below. | ||
| # * Finally, don't worry about the indent, CocoaPods strips it! | ||
| s.description = "Add traffic to your Mapbox basemaps." | ||
|
There was a problem hiding this comment. Traffic won’t be the only plugin. |
||
|
|
||
| s.homepage = "https://github.com/mapbox/mapbox-plugins-ios/" | ||
| # s.screenshots = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif" | ||
|
|
||
|
|
||
| # ――― Spec License ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― # | ||
|
|
||
| s.license = { :type => "ISC", :file => "LICENSE.md" } | ||
|
|
||
| # ――― Author Metadata ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― # | ||
|
|
||
| s.author = { "Mapbox" => "[email protected]" } | ||
| s.social_media_url = "https://twitter.com/mapbox" | ||
|
|
||
| # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― # | ||
| # | ||
| # If this Pod runs only on iOS or OS X, then specify the platform and | ||
| # the deployment target. You can optionally include the target after the platform. | ||
| # | ||
|
|
||
| # s.platform = :ios | ||
| # s.platform = :ios, "5.0" | ||
|
|
||
| # When using multiple platforms | ||
| # s.ios.deployment_target = "5.0" | ||
| # s.osx.deployment_target = "10.7" | ||
| # s.watchos.deployment_target = "2.0" | ||
| # s.tvos.deployment_target = "9.0" | ||
|
|
||
|
|
||
| # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― # | ||
| # | ||
| # Specify the location from where the source should be retrieved. | ||
| # Supports git, hg, bzr, svn and HTTP. | ||
| # | ||
|
|
||
| s.source = { :git => "http://github.com/mapbox/mapbox-plugins-ios.git", :branch => "traffic-plugin" } | ||
|
|
||
| s.subspec 'PluginKit' do |core| | ||
| core.source_files = 'PluginKit/*.h' | ||
| core.dependency 'Mapbox-iOS-SDK', "~> 3.6" | ||
| end | ||
|
|
||
| s.subspec 'Traffic' do |traffic| | ||
| traffic.source_files = 'TrafficPlugin/*.{h,m}' | ||
| traffic.dependency 'MapboxMapsPlugins/PluginKit' | ||
|
There was a problem hiding this comment. Is it possible to provide a description per subspec? There was a problem hiding this comment. It doesn't seem to be. I didn't see anything in the CocoaPods docs. 😞 There was a problem hiding this comment. Looks like the usual practice is to list and describe all the plugins in the main spec’s description, which can have an arbitrary amount of Markdown. |
||
| end | ||
|
|
||
| end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // | ||
| // MBXPlugin-Bridging-Header.h | ||
| // MapboxPlugins | ||
| // | ||
| // Created by Jordan Kiley on 8/30/17. | ||
| // Copyright © 2017 Mapbox. All rights reserved. | ||
| // | ||
|
|
||
| #ifndef MBXPlugin_Bridging_Header_h | ||
| #define MBXPlugin_Bridging_Header_h | ||
|
|
||
|
|
||
| #endif /* MBXPlugin_Bridging_Header_h */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,70 @@ | ||
| # mapbox-plugins-ios | ||
| Experimental plugins to supercharge your maps ⚡️ | ||
|
|
||
| ## Installing Plugins | ||
|
|
||
| There are main three ways to install Mapbox Maps Plugins: | ||
|
|
||
| 1. CocoaPods | ||
| To install all Mapbox Maps Plugins, add the following to your Podfile: | ||
| `pod MapboxMapsPlugins` | ||
| To install the Mapbox Traffic Plugin, add | ||
| `pod MapboxMapsPlugins/Traffic` | ||
| Note that the CocoaPod does include Mapbox iOS SDK v3.6.x as a dependency, and should update to the latest patch release of v3.6 when you run `pod update`. | ||
| 2. Carthage 🤷 | ||
| 3. If you prefer not to use either Carthage or CocoaPods, copy the files for the plugin that you would like to use into your project. You will need to use a bridging header if your project is written in Swift. | ||
|
|
||
| ## Using Test App | ||
|
|
||
| Test out Mapbox Maps Plugins in the TestApp. Add your [Mapbox Access token](https://www.mapbox.com/help/how-access-tokens-work/) to the `mapbox_access_token` file to get started. | ||
|
|
||
| ## Getting Started with the Traffic Plugin | ||
|
|
||
| Once you have added the plugins library to your project, import it to your project. The traffic layers will start to become visible at zoom level 10. | ||
|
|
||
| Because these methods use the Runtime Styling API, the earliest that they can be called is in `[-mapView:didFinishLoadingStyle:](https://www.mapbox.com/ios-sdk/api/3.6.2/Protocols/MGLMapViewDelegate.html#/c:objc(pl)MGLMapViewDelegate(im)mapView:didFinishLoadingStyle:)`. | ||
|
|
||
| - (void)addToMapView:(MGLMapView *)mapView; | ||
|
|
||
| Add traffic to a MGLMapView. This method inserts the traffic layer below places of interest with a scale rank of 3 (POIs that either have a small area or are generally acknowledged to cover large areas, i.e. hospitals and universities). See the [Mapbox Vector Tile Source layer reference](https://www.mapbox.com/vector-tiles/mapbox-streets-v7/#layer-reference) for more information about vector tile layers. | ||
|
|
||
| - (void)addToMapView:(MGLMapView *)mapView below:(MGLStyleLayer *)symbolLayer; | ||
|
|
||
| Insert the traffic layers below a specific layer that has already been added to your map’s style. | ||
|
|
||
| - (void)removeFromMapView:(MGLMapView *)mapView; | ||
|
|
||
| Removes all traffic layers from the map. | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| ### Swift | ||
| ```swift | ||
| import Mapbox | ||
| import MapboxMapsPlugins | ||
|
|
||
| class ViewController: UIViewController, MGLMapViewDelegate { | ||
|
|
||
| override func viewDidLoad() { | ||
| super.viewDidLoad() | ||
|
|
||
| // This example is pinned to a style version because it accesses underlying style data. | ||
| let mapView = MGLMapView(frame: view.bounds, styleURL: MGLStyle.lightStyleURL(withVersion: 9)) | ||
| mapView.setCenter(CLLocationCoordinate2D(latitude: 39.9612, longitude: -82.9988), zoomLevel: 11, animated: false) | ||
| mapView.autoresizingMask = [.flexibleHeight, .flexibleWidth] | ||
| view.addSubview(mapView) | ||
| mapView.delegate = self | ||
| } | ||
|
|
||
| func mapView(_ mapView: MGLMapView, didFinishLoading style: MGLStyle) { | ||
| let traffic = MBXTrafficPlugin() | ||
| traffic.add(to: mapView) | ||
|
|
||
| // Removes the traffic layers after 10 seconds. | ||
| DispatchQueue.main.asyncAfter(deadline: .now() + 10, execute: { | ||
| traffic.remove(from: mapView) | ||
| }) | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrm, I think
mapbox_access_tokenstill needs to be ignored, it’s just that creating the file is a necessary step towards getting the demo app working.