The eeGeo SDK is a cross-platform, OpenGL-based library for beautiful and customisable 3D maps.

This document provides the information you need to quickly get up and running in a pre-made app, which demonstrates how an application can use the eeGeo 3D maps SDK to display beautiful 3D maps. The example can be used as the basis for your own cross-platform app, or can be used as a reference when integrating the eeGeo 3D map into an existing app. We'll also cover how to get an API key, and link out to more detailed documentation for main SDK features and types.

This section will walk you through the process of getting up and running quickly.

The SDK is distributed as a C++ static library with headers, with an example app to demonstrate project configuration and show the use of the SDK in practice. A shell script is provided in the example app repo root which fetches the SDK. The SDK is deployed continuously; the most up to date version can be obtained by running this shell script. We recommend doing so often, in order to reduce the impact of updating.

Both C++ 03 and C++ 11 versions of the SDK binaries are provided in order to maximise compatibility.

The Mobile Example App is an open source version of eeGeo's Recce app, available for iOS and Android. This repo is intended to demonstrate a practical application of the eeGeo SDKs cross-platform capabilities by presenting an architecture that shares all of the domain model code between iOS and Android, with platform-specific implementations only for views and OS dependent services (such as IO).

Much of the application code is shared between platforms, reducing duplication and maintenance overhead for developers.

To get started with the example app (iOS):

The following steps assume XCode is present.

1. Clone the repo: git clone git@github.com:eegeo/mobile-example-app.git.
2. Get the latest iOS SDK by running sh ./update.platform -p ios from the repo root.
3. Obtain an eeGeo API key and add it to the ApiKey file.
4. Open and build the ./ios/ExampleApp.xcodeproj.

To build at the command line, run ./build.sh -p ios from the repository root.

Note: In step 2, we download a C++ 03 binary. If you require a C++ 11 binary, run sh ./update.platform -p ios -c.

• ./update.platform.sh -p ios -c will fetch c++ 11/libc++ ABI compatible versions of the SDK for libc++
• ./build.sh -p ios -c from the command line will build targeting c++ 11 / libc++
• An additional target in the XCode project file is provided for c++ 11 support: ExampleAppCpp11

To get started with the example app (Android):

The following steps assume Eclipse and the NDK are present. In order to run, your version of Android Developer Tools must be >= 22.6. In order to support 64-bit ABIs, you must be using Android NDK revision 10d or later.

1. Clone the repo: git clone git@github.com:eegeo/mobile-example-app.git.
2. Get the latest Android SDK by running sh ./update.platform -p android from the repo root.
3. Obtain an eeGeo API key and add it to the ApiKey file.
4. Create an Eclipse Android workspace for the ./android directory, with NDK native support. For more detailed instructions on how to easily set up a native Android development environment, see this blog post.

The project is configured to build for multiple target CPU architectures, creating a universal .apk containing exectutables for each of these architectures.

• The supported architectures are defined in ./Android/jni/Application.mk, by the line: APP_ABI := armeabi,armeabi-v7a,arm64-v8a
• Removing the APP_ABI line will build and package for the default armeabi architecture. The armeabi architecture is backwards-compatible with armeabi-v7a, but will not run on devices 64-bit ARM instruction sets.
• For further information about supporting multiple architectures see: http://developer.android.com/google/play/publishing/multiple-apks.html

build.sh can be used to generate the native library if you want to manually package the .apk. To build at the command line, run ./build.sh -p android from the repository root.

Note: In step 2, we download a C++ 03 binary. If you require a C++ 11 binary, run sh ./update.platform -p android -c.

• Android c++ 11 support is EXPERIMENTAL due to the experimental nature of c++ 11 support in the NDK (more information here & here)
• Only tested against Android NDK version r10d
• Only tested against gcc 4.9 & gnu libstd++ (see android/jni/Application.mk for how to target these)
• ./update.platform.sh -p android -c will fetch c++ 11/gnu libstdc++ ABI compatible versions of the SDK
• ./build -p android -c from the command line will build targeting c++ 11
• Pass COMPILE_CPP_11=1 to ndk-build to build cpp11

In order to use the eeGeo 3D Maps API, you must sign up for a free developer account at https://www.eegeo.com/developers. After signing up, you'll be able to create an API key for your apps.

After signing up for a developer account and creating an API key, add it to the example app ApiKey file as described in the previous section.

The example app demonstrates a variety of SDK features, and is a good starting point to get to know how the SDK works.

Among the use cases demonstrated by the example app are:

• A tactile menu based user experience for manipulating the application
• Category and free-text point of interest search and display using an off the shelf third party search service
• In world display for points of interest using both 2D native UI widgets and 3D pins
• Dynamic weather and season control
• Environment flattening to enter "map-mode"
• Animated camera transitioning between in-world locations
• GPS usage to control a compass widget
• Background preloading of environment resources
• A model for implementing an initial user experience

For a detailed walkthrough on the example app, and the SDK features exercised by the app, see the documentation page.

The SDK documentation covers various SDK features in greater detail, and an API reference is available documenting the individual SDK types.

If you need help, contact support@eegeo.com. Bug reports or feature requests are also accepted.

The eeGeo 3D Maps SDK is released under the Eegeo Platform SDK Evaluation license. See the LICENSE.md file for details.