-
Notifications
You must be signed in to change notification settings - Fork 29
/
readme.en.txt
249 lines (188 loc) · 9.78 KB
/
readme.en.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
======================================================================
NyARToolkit
version 5.0.5
======================================================================
Copyright (C)2008-2016 Ryo Iizuka
http://nyatla.jp/nyartoolkit/
airmail(at)ebony.plala.or.jp
wm(at)nyatla.jp
Translated by Bao-Wen Chen
----------------------------------------------------------------------
About NyARToolkit
----------------------------------------------------------------------
* NyARToolkit is a class library for Augmented Reality (AR) application
based on the ARToolkit 5.2.3.
* Compatible with J2SE7.0 and above.
* Composed of basic features of ARToolkit, NyARToolkit's orginal features
and framework.
* Consisting of three modules: an independent "lib" module,
an environment-dependent "utils" module, and a "sample" module that
can package sample applications.
* The lib module only work under J2ME API environment.
* The util module provides controls for camera, 3D system, and helper class
for interfacing external modules.
* The sample module is a collection of AR applications, with a minimal
amout of features.
For more info on ARToolkit, please visit the following URL
http://www.hitl.washington.edu/artoolkit/
----------------------------------------------------------------------
NyARToolkit Features
----------------------------------------------------------------------
* Support multiple image inputs (BufferedImage, JMF output, binary input,
and so on)
* Enhanced reusability compared to ARToolkit
* High-speed capabilities are available for following calculation:
labeling, posture optimization, image processing, matrix operation, equation resolution
* Support NyID-style ID marker
* A MarkerSystem class that makes easy multiple uses of AR/NyID markers.
* A simple sketching system for OpenGL
* API for changing image format to and from BufferedImage.
* Possible to use PNG image as markers, and to cut out parts of captured image.
---------------------------------------------------------------------
NyARToolkit License
----------------------------------------------------------------------
NyARToolkit adaptes a LGPLv3 dual license.
* GNU Lesser General Public License (LGPL) Ver.3 is intended for
open source usage, where applications based on NyARToolkit should also
be distributed under the LGPL.
* Commercial licensing is intended for non-LGPL useage, which means
applications based on NyARTookit can be distributed without LGPL.
* If a LGPLv3 license is approved, it will be available to use free of
charge, regardless of commercial or non-commercial purposes.
* If a LGPLv3 license is not approved, please consider purchasing the
commercial license.
Commercial License (Other countries)
Please contact ARToolWorks Inc.
http://www.artoolworks.com/Home.html
----------------------------------------------------------------------
External Libraries
----------------------------------------------------------------------
NyARToolkit uses the following external libraries. If newer version
becomes available, please install the newer version.
1. Webcam Capture
General Webcam capture library. This is included.
http://webcam-capture.sarxos.pl/
2. Jogl2
Required for running utils.jogl, sample.jogl. This is partially included.
URL:http://jogamp.org/deployment/jogamp-current/archive/
file:jogamp-all-platforms.7z
Following libraries are optional.
1. JMF JavaTM Media Framework 2.1.1e
Required for running utils.jmf, sample.jogl
URL: http://www.oracle.com/technetwork/java/javase/download-142937.html
2. QuickTime 7.5
Required for running utils.qt
URL: http://www.apple.com/quicktime/qtjava/
3. java3d
Required for running utils.java3d, sample.java3d
URL: https://java3d.dev.java.net/binary-builds.html
file: java3d-1_5_1-xxxx-i586.exe
4. Jogl1
Required for running utils.jogl, sample.jogl
URL: http://download.java.net/media/jogl/builds/archive/
file : jogl-1.1.1-rc8-xxxx-xxx.zip
Depending on application and purpose, it's not necessary to install all
the libraries above. Install only those needed.
----------------------------------------------------------------------
Getting Started
----------------------------------------------------------------------
This section provides instruction for installing NyARToolkit development
tools under Eclipse environment.
1. Create a new workspace/project in Eclipse.
2. Import lib, utils, and sample modules (directories) into the workspace/project
3. Correct the errors found at the imported project. Common errors include
inconsistent character codes, or reference misses to external JAR files .
The error of inconsistent character codes can be resolved by changing
the project's encoding to UTF-8. For resolving reference misses to
external JAR libraries, please refer to the chapter of external library
(Where is the chapter?).
4. Connect webcam to PC.
5. Run SimpleLiteMStandard.java within NyARToolkit.sample.jogl, and point
the webcam to the marker. If a cube appears, the installation of NyARToolkit
is done!
For detailed intruction of step 1 ~ step 4, please refer to
http://sixwish.jp/Nyartoolkit/
----------------------------------------------------------------------
Project Outline
----------------------------------------------------------------------
The outline of the Eclipse project.
* NyARToolkit
The main body of NyARToolkit library. Basically it will work as normal
as long as J2ME API is provided. There are three source folders,
1)src contains image processing, and numerical calculation classes.
2)src.markersystem contains a MarkerSystem that is used to make the
manipulation of multiple markers easier.
3)src.rpf contains classes that together form RealityPlatform system.
There is no external libraries required by this module.
* NyARToolkit.sample.java3d
Sample application that outputs Java3D formats. There is one sample program.
It depends on two external libraries, Java3D and JMF.
* NyARToolkit.sample.jogl
A sample that is packaged with some typical methods from OpenGL.
1)src contains sample applications that utilize MarkerSystem. It can
further be grouped by those using OpenGL sketching and those not.
2)src.old includes sample applications of previous formats.
3)src.rpf includes sample applications that use RealtyPlatform.
Usually, the samples under src will be enough. There are various kinds
of samples under src/sketch folder.
* NyARToolkit.sandbox
It buries unverified or incomplete programs. There are many bugs so
the quality is not assured. The sample programs under the test folder
will probably be useful if you are to test RealityPlatform.
* NyARToolkit.utils.j2se
It contains helper classes and test programs that are dependent on JavaSE.
Classes in this module enable you to input BufferedImage directly into NyARToolkit.
* NyARToolkit.utils.java3d
It contains helper classes and test programs that are dependent on Java3D.
It provides NyARToolkit with the ability to output Java3D format.
* NyARToolkit.utils.jogl
It contains helper classes and test programs that are dependent on Jogl.
It provides NyARToolkit with the ability to output Jogl format.
* NyARToolkit.utils.qt
It contains helper classes and test programs that are dependent on QTJava.
It supports image capturing function via QuickTime.
----------------------------------------------------------------------
NyARToolkit Performance
----------------------------------------------------------------------
NyARToolkit replaced parts of the processing system of ARToolkit to enhance
processing speed. At algorithm level, the performance of detecting one marker
is four times faster, and it is two times faster when simply comparing speed
to ARToolkit.
When RPF(RealityPlatform, added in 3.0.0) module is used, it will likely
to further increase speed up to 1.5 times faster.
RPF is still unstable, if you don't hava a specific reason, I recommend you
to use MarkerSystem module.
----------------------------------------------------------------------
FAQ
----------------------------------------------------------------------
*Q1. I cannot save configuration changes in JMF under Windows 7.
=>Run JMFRegistry as an administrator, and you will be able to save
changes to JMF.
*Q2. I cannot simply replace NyARToolkit versions older than 2.5.3 with
the latest version?
=>Some method parameters are changed. Refer to sample programs and
make necessary change to function calls.
*Q3. What is MarkerSystem?
=>MarkerSystem is a framework designed to make the use of
multiple markers as easy as possible. Coordinates transformation,
image acquisition,..etc can also be done without a pain in the neck
via MarkerSystem. Moreover, the sketching system is improved with
reference to Processing's sketching system. So now coding a
NyARToolKit application is much more fun than before!
----------------------------------------------------------------------
Contact Me
----------------------------------------------------------------------
If you have any questions or comments, email me at wm(at)nyatla.jp.
I might not be able to answer soon, but I will reply as soon as possible.
----------------------------------------------------------------------
Special Thanks
----------------------------------------------------------------------
Hirokazu Kato, Ph. D.
http://www.hitl.washington.edu/artoolkit/
Prof. Mark Billinghurst
http://www.hitlabnz.org/
arc@dmz
http://digitalmuseum.jp/
DAQRI LCC
http://daqri.com/
DAQRI LCC is a sponsor of NyARToolKit Project.