Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Open Spatial SDK for Android
Open Spatial SDK for Android contains:
|SDK Sources||Sources for Open Spatial SDK APIs|
|OpenSpatialSDK.jar||Used to build applications against the APIs, added for convenience|
|An emulator APK||Generates events, e.g., button, rotation events etc., to aid in application development|
|An example app||Demostrates how to use the APIs to register and log events|
Sources needed to build OpenSpatialSDK.jar are in the net.openspatial package and sources for example app is in the com.example.openspatial package.
The SDK is distributed under Apache2.0 license (see LICENSE.md).
Open Spatial SDK sources are currently set up to be built with buck. Support for buidling with Eclipse IDE will be added in the future.
- Install Android SDK - instructions
- Install buck - instructions
- Set up buck with the location of Android SDK. You can either
ANDROID_SDKenvironment variables, or
- define a local.properties file with a property named 'sdk.dir' that points to the absolute path of your Android SDK directory
# export ANDROID_SDK=/path/to/android/sdk or # echo "sdk.dir=/path/to/android/sdk" > local.properties
How to build
After the one time setup, to build simply use buck to build the example app.
# buck build example
How to install
To install the example app on an Android device, use buck install commands or adb.
# buck install example or # adb install buck-out/gen/apps/OpenSpatialExample/OpenSpatialExample.apk
To install the emulator,
# adb install release/OpenSpatialEmulator.apk
How to run
Install both emulator and the example app and start them from launcher. Play with buttons, tactiles, slider etc. on the emulator app and watch logs for events.
# adb logcat
NOTE: Currently both emulator and example app run on the same Android device. Support for them being on more than one device will be added later.
How to generate JavaDoc
To generate the API documentation replace
/path/to/sdk to appropriate location and modify Android API version as needed.
javadoc -d release/javadoc -sourcepath src/ -classpath /path/to/sdk/platforms/android-18/android.jar net.openspatial
Open Spatial SDK for iOS
For information on Open Spatial SDK for iOS see (https://github.com/openspatial/iOS-SDK)