Skip to content

Commit 5f78aff

Browse files
John WolfJohn Wolf
authored andcommitted
Added text for Android Eclipse deprecation to be replaced with Android Studio
1 parent 4b9285d commit 5f78aff

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

4_Android/android_examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ ARToolKit includes a number of fully-working examples on Android that demonstrat
33

44
The examples are divided into 3 sets.
55

6-
1. Java-based: examples where all user-developed code is in Java, and is based on the provided ARBaseLib classes.
7-
2. Mixed Java/C/C++: examples where user-developed code is split between the Java environment and native C/C++ (NDK) environment. Code can use the provided ARBaseLib java classes while also addressing ARToolKit in C/C++ via the libARWrapper C/C++ API.
8-
3. C/C++-based: examples where most of the user-developed code is native C/C++ (NDK). These examples offer the greatest power to the AR developer and direct access to the full native ARToolKit API.
6+
1. All Java-based: examples where all user-developed code is in Java, and is based on the provided ARBaseLib classes.
7+
2. Mixed Java and native C/C++ using Android NDK: examples where user-developed code is split between the Java environment and native C/C++ environment. Code can use the provided ARBaseLib java classes while also addressing ARToolKit in C/C++ via the libARWrapper C/C++ API.
8+
3. AR and rendering code in native C/C++ using Android NDK: examples where most of the user-developed code is native C/C++. These examples offer the greatest power to the AR developer and direct access to the full native ARToolKit API.
99

1010
The examples are as follows:
1111

12-
##Java-based
12+
##All Java-based
1313

1414
- **ARSimple**: An example that extends the ARActivity class in ARBaseLib to create a simple augmented reality application.
1515
- **ARSimpleInteraction**: An example that adds simple interaction to ARSimple.
1616

17-
##Mixed Java/C/C++
17+
##Mixed Java and Native C/C++ Using Android NDK
1818

1919
- **ARSimpleNative**: An example that uses an additional native library to perform rendering in C rather than Java.
2020
- **ARSimpleNativeCars**: An example that uses a native OBJ model loader.
2121

22-
##AR and rendering code in C/C++
22+
##AR and Rendering Code in Native C/C++ Using Android NDK
2323

2424
- **ARNative**: An example that uses the ARToolKit libraries directly and renders with OpenGL.
2525
- **ARNativeOSG**: An example that uses the ARToolKit libraries directly and loads and renders 3D model content using the advanced OpenSceneGraph framework.

4_Android/android_native.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,25 @@ Building native static and shared ARToolKit libraries requires a development env
99
The following SDKs and tools should be installed and configured correctly. These are required for standard Android JDK development:
1010

1111
- [Java Development Kit][1]
12-
- [Eclipse IDE][2]
13-
- [Android SDK][3]
14-
- [ADT Plugin for Eclipse][4]
12+
- [Android SDK][2] (Installed with Android Studio IDE to "/Users/\<user\>/Library/Android/sdk")
13+
- [Android Studio IDE][3]
14+
- [Eclipse IDE][4] - deprecated
15+
- [ADT Plugin for Eclipse][5] - deprecated
1516

1617
And these extras are required for building native code with the NDK in Eclipse:
1718

18-
- CDT Plugin for Eclipse (install from within Eclipse).
19-
- [Android NDK][5]
20-
- [Android NDK plugin for Eclipse][6]
19+
- [Android NDK Preview][6] (download the NDK that works with Android Studio IDE)
20+
- CDT Plugin for Eclipse (install from within Eclipse) - deprecated
21+
- [Android NDK plugin for Eclipse][7] - deprecated
2122

22-
On Windows, NDK development is possible using [Cygwin][7], which provides a Linux-type environment. When installing Cygwin, ensure that the "make" package under "Devel" is selected, as this is required by the NDK and may not be installed by default.
23+
On Windows, NDK development is possible using [Cygwin][8], which provides a Linux-type environment. When installing Cygwin, ensure that the "make" package under "Devel" is selected, as this is required by the NDK and may not be installed by default.
2324

2425
Please ensure you have a working SDK and NDK environment before continuing.
2526

27+
To help with the Eclipse to Android Studio transition, in the GitHub "artookit5" repository, see the [document][9]:<br/>"\<repo root\>/AndroidStudioProjects/Docs/AS_Migration.pdf."
28+
2629
##Building Native Libraries
27-
Each native library in the SDK, whether core library or example, includes a Windows batch file called build.bat that automatically configures and initiates the build. The build.bat file first calls the SetNDKBuildVars.bat file in the SDK root directory. This batch file sets some environment variables that are required for the build process, including the paths to the various tools and SDKs listed above. Naturally, these paths will differ from machine to machine, so it is important to edit this file to match the current development environment. Until this file has been configured, an error message will appear, as shown below.
30+
Each native library in the SDK, whether core library or example, includes a Windows batch file called build.bat that automatically configures and initiates the build. The build.bat file first calls the SetNDKBuildVars.bat file, both located in the "android" folder directly off the root folder of the "artoolkit5" SDK or repository. This batch file sets some environment variables that are required for the build process, including the paths to the various tools and SDKs listed above. Naturally, these paths will differ from machine to machine, so it is important to edit this file to match the current development environment. Until this file has been configured, an error message will appear, as shown below.
2831

2932
![set_ndk_build_vars][set_ndk_build_vars]
3033

@@ -41,14 +44,16 @@ When the build completes, there will be new shared libraries in `ARToolKitWrappe
4144
To use this native library in your own Android application, you will need to copy the libs directory to your Android application project directory. ![right][libs_directory]
4245

4346
[1]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
44-
[2]: http://www.eclipse.org/
47+
[2]: http://developer.android.com/sdk/index.html
4548
[3]: http://developer.android.com/sdk/index.html
46-
[4]: http://developer.android.com/sdk/eclipse-adt.html
47-
[5]: http://developer.android.com/sdk/ndk/index.html
48-
[6]: http://tools.android.com/recent/usingthendkplugin
49-
[7]: http://www.cygwin.com
50-
[android_developing]: 4_Android:android_developing
49+
[4]: http://www.eclipse.org/
50+
[5]: http://developer.android.com/sdk/eclipse-adt.html
51+
[6]: http://tools.android.com/tech-docs/android-ndk-preview
52+
[7]: http://tools.android.com/recent/usingthendkplugin
53+
[8]: http://www.cygwin.com
54+
[9]: https://github.com/artoolkit/artoolkit5/blob/master/AndroidStudioProjects/Docs/AS_Migration.pdf
5155

56+
[android_developing]: 4_Android:android_developing
5257
[set_ndk_build_vars]: :set_ndk_build_vars.png
5358
[set_ndk_build]: :set_ndk_build.png
5459
[libs_directory]: :libs_directory.png

0 commit comments

Comments
 (0)