Skip to content

Embedding Guide

Jump to bottom Edit New page
tillmzw edited this page Nov 20, 2012 · 9 revisions

this page seems outdated and I don't know enough about XCode, however this guide helped me embedding in a XCode project:

XCode Development

Project setup

Once you have created a new iOS application, we will setup the Route-Me MapView as a subproject. Below, the Header Search Paths and Link Binaries are the most important steps.

  1. Clone the Route-Me repo into a vendor directory inside your project. (This is the convention I used, and I’m not sure if it is the best) git clone https://github.com/route-me/route-me vendor/route-me
  2. Add the vendor/route-me/MapView/MapView.xcodeproj into your project.
  3. In your Project Settings, click the application target > Build Settings > Enter “Header” into the Search Box, and add vendor/route-me/MapView/Map to the *Header Search Paths key
  4. Build Settings > Under Other Linker Flags > Add -all_load -ObjC
  5. Go to Build Phases > Target Dependencies > Click +, Choose MapView > MapView
  6. Go to Build Phases > Link Binaries > For each of the following libraries, Click +, select the binary, and then click the Add button. 6.1. libMapView.a 6.2. libsqlite3.dylib 6.3. CoreLocation.framework 6.4. QuartzCore.framework

Source: jamie.ly

Comments and assistance

If you have comments or bug reports, please don't leave them here. Nobody checks this page on a regular basis. Please join us on the Route-Me mailing list, or enter a bug report on the bug tracker.

Introduction

This guide takes you step-by-step through making an iOS application with an embedded map.

Setting up your directories

First, we're going to make a directory to hold your project as well as the Route-Me MapView and Proj4.

Open terminal and clone the Route-Me trunk:

  $ mkdir Library
  $ cd Library/
  $ git clone git://github.com/route-me/route-me.git route-me

Adding the Route-Me project reference to your own project

Note: See this guide for Xcode 4.

Open up your own project, and click on the root element of the "Group & Files" sidebar (there should be a blue compass icon next to it). Then in the main Xcode menu, choose "Project"->"Add to Project..." and then select the Route-Me MapView.xcodeproj file from where the Route-Me project is installed on the file system.

Do not copy items. Make the reference type "Relative to Project".

As a result, the MapView.xcodeproj (with the same blue icon than the root element of your project) will appear just under the root element of your project.

If you expand the MapView.xcodeproj, you will see 2 files: MapView.app and libMapView.a.

You do not need a reference to Proj4. As long as the Proj4 project folder is sitting next to the MapView project folder, it will work fine.

Note that this method is described in the "Xcode Project Management Guide", p.37 Referencing Other Projects.

Configuring build dependencies

Now we need to configure your application to build with MapView. There are a lot of small steps here; and if you miss one your project won't build / run.

First, click the MapView.xcodeproj reference we just added to our project. There should be two elements inside it: libMapView.a and MapView.app. In the files list click the little checkbox next to libMapView.a. This will add libMapView.a to the project targets.

In the Groups & Files sidebar, open Targets and double-click on your application's target.

General tab

In the general tab, we will add MapView as a direct dependency.

If you correctly added libMapView.a to the target, it is listed in the lower pane as a linked library. Now you're going to work with the upper pane, though.

Click the Direct Dependencies '+' (below the upper pane, above the lower pane) and add MapView.xcodeproj->MapView. This causes MapView to be compiled when your project is compiled (if changes have been made in the MapView project).

We also need to add a couple other linked libraries. Click the Linked Libraries pane's '+' and add CoreGraphics, CoreLocation, QuartzCore and libsqlite3.dylib

Build Tab

Click on the "Build" tab in your target's info window.

Change the Configuration popup to read "All Configurations", so that your changes can be made just once.

Find "Header Search Paths" under "Search Paths" (shortcut: type "header" in the search box at upper right of the target info window). Double-click on the 'Header Search Paths' text and add the path to the MapView directory contained in the Route-Me project located on your file system. (Note that if there are any spaces in the path, enclose the entire entry with "". If the MapView project folder is placed next to your project's project folder on the file system, you would have the following in the path: "../MapView".

Check the 'Recursive' box and click Ok.

Properties Tab

Identifier will currently be: com.yourcompany.${PRODUCT_NAME:identifier} If you have a code signing identity, change yourcompany appropriately so you can deploy & test on the iphone.

Build the project

If you have done everything right, it will compile about 143 files in Proj4, then about 26 files in MapView, and then about 6 files (your application). Successive compilations will be much faster.

You will probably get a few warnings from Proj4 and something about code signing identities in MapView. These warnings are safe to ignore.

Project Resources

Copy the marker png files from MapView's Resources folder into the assets folder of your parent project otherwise markers won't have images to plot.

Adding a map for non Interface Builder based application

This is the most trivial way to integrate Route-Me in a project and does not require any extra special steps other than the traditional ones:

In your Controller header file (for example: MyViewController), import MapView.h:

      #import "RMMapView.h"

      @interface MyViewController : UIViewController { 
         RMMapView *mapView; 
   
         // Your own code.... 
      }

      @property (nonatomic, retain) RMMapView *mapView;

In your Controller implementation file (.m), write the following in the loadView method:

      - (void)loadView { 
         [self setMapView:[[[RMMapView alloc] initWithFrame:CGRectMake(0.0, 0.0, desiredwidth, desiredheight)] autorelease]];
         [mapView setBackgroundColor:[UIColor blackColor]]; 
         self.view = mapView; 
   
         // Your own code 
      }

Save and run.

Adding a map for Interface Builder-based application

Open the Resources group in XCode. Open MyAppViewController.xib (it will have a slightly different name depending on what your project is called).

Click on the view. In the attributes window, first tab check View->Interaction->"Multiple Touch". In the Identity tab, change the class identity to RMMapView.

Theoretically, it should work now but it won't. If you try to run it you will get this runtime error:

  2008-09-30 14:15:15.229 MyMappingApp[40631:20b] Unknown class RMMapView in Interface Builder file.

XCode has stripped the RMMapView symbol from the final executable (its not referenced anywhere

  • gcc considers it dead code. Of course, gcc doesn't notice interface builder's reference)

The work-around to this is to add a reference RMMapView somewhere (anywhere).

In XCode, open MyMappingAppViewController.m. (It will be in the Classes group).

Near the top of the file add:

      #import "RMMapView.h"

You will also find the commented out method "viewDidLoad". Uncomment this method and add this code:

      // Implement viewDidLoad to do additional setup after loading the view. 
      - (void)viewDidLoad {
         [super viewDidLoad]; 
         [RMMapView class]; 
      }

In this method we could also set where the view is facing, or set any other properties of the view. (The controller's 'view' property will be set to our RMMapView.)

Build and run and you are done.

Add a custom footer
Add a custom sidebar
Clone this wiki locally