- Package Installation
- Configuring the development environment
- Installation test
Package Installation
To install VisioDevKit, simply unzip the VisioDevKit zip package to your development directory.
Inside your new VisioDevKit directory, you should find the following directories:
Configuring the development environment
iOS
To use VisioDevKit in your project, you just need to add libVisioDevKit.a and the include directories to your Xcode project.
In your project settings, set dead code stripping to NO and Compress PNG to NO.
- Note:
- libVisioDevKit.a is a universal library, which means it contains code for both the iOS Simulator and the iOS Device in the same file.
Android
To use VisioDevKit in your project, you just need to copy the libVisioDevKit.jar in your_project_root/libs/ and libVisioDevKit.so in in your_project_root/libs/armeabi/
Please be aware of the following restriction on Android:
- The Android device MUST have an SD card for storing the sample data bundle that will be used by VisioDevKit. The required free space on the SD card is dependant on the size of the associated data bundle.
Using Eclipse
Adding Visioglobe samples
To run our Android samples using Eclipse, follow these steps :
- Add VisioSample (A common project shared by all the samples)
- Create a new Android Project
- Choose create project from existing source and enter the path to the sample directory (eg, samples/Common/Makefiles/Android).
- Click "Finish".
- Right click on libs/libVisioDevKit.jar and under "Build Path >", select Add to build path.
- The license id and secret key inside the code will need to be updated before this project will successfully compile.
- Add Sample Project
- Create a new Android Project
- Choose create project from existing source and enter the path to the sample directory (eg, samples/3dModule/Makefiles/Android).
- Click "Finish".
- Right click on the Sample Project and under "Build Path >", select "Configure Build Path..."
- Click the "Add JARS..." button on the right of the dialog.
- Select "libVisioDevKit.jar" from "VisioSample/libs/" and click "OK"
- Click "OK".
- Run or Debug as an Android Application.
Documentation
To associate the java documentation libVisioDevKit.jar, follow these steps : Once there is an association in place eclipse is able to automatically display information related to the libVisioDevKit.jar interfaces. To associate the java documentation with libVisioDevKit.jar, follow these steps:
- Right click on a Project which references libVisioDevKit.jar and under "Build Path >", select "Configure Build Path..."
- Expand the contents of the "libVisioDevKit.jar" library
- Select the "Javadoc location" attribute and then click the "Edit" button on the right.
- Choose the "Javadoc URL" radio button (selected by default) and browse to the "doc" directory at the root of the delivery package (the same level as this document). Click "OK"
- Click "OK"
Using the Android Emulator
Android Emulator Setup
The android samples can be run on the Android Emulator. Below is a list of minimum versions required to support for the Android Emulator to correctly display the Open GL:
- Android SDK Tools, Revision 17 or higher
- Android SDK Platform API 8, Revision 3 or higher.
The first step is to create your desired virtual device using Android's AVD Manager.
- see Android's Managing AVDs with AVD Manager for information on how to setup a virtual device.
- when setting up the virtual device you will need to do the following:
- Allocate SD Card storage. The Visioglobe samples extract the zipped data bundle contained in the apk package to the devices external storage, therefore it is necessary to allocate enough external storage space to hold the extracted bundle. For the data bundles contained in the sample, 10MB should be plenty.
- Enable the "SD Card Support" Hardware property.
Using Hardware Acceleration
Graphics acceleration for the emulator takes advantage of your development computer's graphics hardware, specifically its graphics processing unit (GPU), to make screen drawing faster. Below is a list of the minimum version required to support hardware acceleration:
- Android SDK Tools, Revision 17 or higher
- Android SDK Platform API 15, Revision 3 or higher.
- Attention:
- Caution: As of SDK Tools Revision 17, the graphics acceleration feature for the emulator is experimental; be alert for incompatibilities and errors when using this feature.
See Android's Configuring hardware acceleration for further information on how to set up your emulator to support graphics acceleration.
Installation test
To verify that VisioDevKit was installed successfully, open the Navigation Example sample applications from the install package and it should build and run successfully on your chosen platform.
Just one last word before you dive into the deep end of the pool, we seriously recommend you take a look at the Under the hood page to gain a deeper understanding of VisioDevKit and it's usage. If you're going to be doing any development with the VisioDevKit, then it will be an good investment of your time.
You are now ready to go on your own!!
Next