OSDN Git Service

[Backup]NyARToolkit for Java
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
1 ARToolKit Java class library NyARToolkit.\r
2 Copyright (C)2008 R.Iizuka\r
3 \r
4 version 2.4.0\r
5 \r
6 http://nyatla.jp/nyartoolkit/\r
7 airmail(at)ebony.plala.or.jp\r
8 wm(at)nyatla.jp\r
9 --------------------------------------------------\r
10 \r
11 \r
12 \r
13 \r
14 ・NyARToolkit/2.4\r
15 \r
16 NyARToolkitは、Pure Javaで実装したARToolKitクラスライブラリです。\r
17 \r
18 ARToolKit 2.72.1をベースに構築されています。\r
19 \r
20 J2SEでのみ動作を確認しました。\r
21 J2MEやMIDP2.0にはそのうち対応します。\r
22 \r
23 \r
24 ARToolkitは加藤博一先生とHuman Interface Technology Labにより\r
25 開発されたAugmented Reality (AR) ライブラリです。\r
26 詳しくはこちらをご覧下さい。\r
27 http://www.hitl.washington.edu/artoolkit/\r
28 \r
29 \r
30 ・NyARToolkitの特徴\r
31 \r
32  -ARToolKitと同等な処理シーケンスを、クラスベースで再構築しています。\r
33 \r
34  -ARToolKitと比較して、処理構造が最適化されています。\r
35 \r
36  -ARToolKit互換モードと、NyARToolkit最適化モードを搭載しています。(Version/2.4.0より)\r
37   \r
38   --NyARToolkit最適化モード\r
39     いくつかのアルゴリズムをARToolKitのものと差換え、高速化・精度の向上を図ります。\r
40     ARToolKit比で、約2倍高速です。(JIT有効時)複数マーカー取り扱い時は、\r
41     更に高速になります。ただし、計算結果はARToolKitのそれと若干ズレがでます。\r
42 \r
43   --ARToolKit互換モード\r
44     ARToolKitのアルゴリズムを最適化し、高速化を図ります。\r
45     ARToolKit比で、約1倍高速です。(JIT有効時)\r
46 \r
47  -取り扱える画像サイズに制限がありません。\r
48  -取り扱えるマーカー個数の最大値が可変です。\r
49  -Idマーカシステム(NyId)が利用できます。(Version/2.3.0より)\r
50 \r
51 \r
52 \r
53 \r
54 \r
55 \r
56 \r
57 ・構成\r
58 \r
59 +-----------------------------------------------+\r
60 |                   Application                 |\r
61 +-------+---------+--------+--------+-----------+\r
62 |NyARJMF|CaptureQT| NyARJoglNyARJ3d |           |\r
63 +-------+---------+--------+--------+           |\r
64 |  JMF  |QuickTime|  JOGL  | Java3D |NyARToolkit|\r
65 +-------+---------+--------+--------+           |\r
66 |      Camera     |       3D        |           |\r
67 ------------------------------------+-----------+\r
68 \r
69 \r
70 映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
71 \r
72 3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
73 \r
74 NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
75 や3Dライブラリを使いやすくするためのラッパークラス群です。\r
76 \r
77 各モジュールとNyARToolkitは分離可能であり、個々を単独で使用する\r
78 ことも可能です。\r
79 \r
80 \r
81 \r
82 \r
83 ・サンプルなど\r
84 \r
85 1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
86   QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
87 \r
88 \r
89 動作確認したバージョンと入手先はこちらです。\r
90 \r
91 JMF JavaTM Media Framework 2.1.1e\r
92 http://java.sun.com/products/java-media/jmf/index.jsp\r
93 \r
94 jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
95 https://jogl.dev.java.net/\r
96 \r
97 java3d-1_5_1-xxxx-i586.exe\r
98 https://java3d.dev.java.net/binary-builds.html\r
99 \r
100 QuickTime 7.5\r
101 http://www.apple.com/quicktime/qtjava/\r
102 \r
103 \r
104 \r
105 2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
106   ディレクトリをインポートしてください。\r
107 \r
108 srcディレクトリには、NyARToolkit本体(計算クラス群)があります。\r
109 src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ用のラッパークラス群があります。\r
110 sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
111 \r
112 \r
113 ・プロジェクトの説明\r
114 \r
115 ライブラリ\r
116 \r
117 NyARToolkit\r
118  NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
119 \r
120 NyARToolkit.utils.jmf\r
121  JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
122  外部ライブラリは、JMFに依存します。\r
123 \r
124 NyARToolkit.utils.qt\r
125  QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
126  外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
127 \r
128 NyARToolkit.utils.jogl\r
129  OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
130  外部ライブラリは、JMF,JOGLに依存します。\r
131 \r
132 NyARToolkit.utils.java3d\r
133  Java3DとNyARToolkitのインタフェイスクラス群があります。\r
134  外部ライブラリは、JMF,Java3Dに依存します。\r
135 \r
136 \r
137 サンプル\r
138 \r
139 NyARToolkit.sample.jogl\r
140  JOGL/JMFを使ったサンプルプログラムがあります。\r
141 \r
142   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
143    単一のARToolKit用マーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
144   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
145    複数のARToolKit用マーカーを認識するサンプルです。1~100個程度のマーカーを\r
146    同時に認識します。\r
147   -jp.nyatla.nyartoolkit.jogl.sample.SingleNyIdMarker\r
148    単一のNyIdマーカを認識するためのサンプルです。アプリケーションフレームワーク\r
149    SingleNyIdMarkerProcesserのリファレンス実装です。\r
150 \r
151 \r
152 NyARToolkit.sample.java3d\r
153  JOGL/JMFを使ったサンプルプログラムです。\r
154  \r
155   -jp.nyatla.nyartoolkit.java3d.sample\r
156    simpleLiteをJava3Dで動かすサンプルがあります。\r
157 \r
158 NyARToolkit.sample.jmf\r
159   JMFを使ったサンプルプログラムです。\r
160 \r
161   -jp.nyatla..nyartoolkit.jmf.sample\r
162   JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
163  \r
164 \r
165 NyARToolkit.sample.qt\r
166  Quicktime for Javaを使ったサンプルプログラムです。\r
167 \r
168  -jp.nyatla.nyartoolkit.qt.sample\r
169   QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
170  \r
171 \r
172 \r
173 \r
174 \r
175 ・足りない機能等\r
176 \r
177 カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
178 今後実装していきます。\r
179 \r
180 \r
181 \r
182 \r
183 ・ライセンス\r
184 \r
185 NyARToolkitは、商用ライセンスとGPLv3以降のデュアルライセンスを採用しています。\r
186 (Version/2.4.0より、GPLv3ライセンスになりました。)\r
187 \r
188  -GPL\r
189  GPLについては、LICENCE.txtをお読みください。\r
190 \r
191  -商用ライセンス\r
192  商用ライセンスについては、ARToolWorks社に管理を委託しております。\r
193  http://www.artoolworks.com/Home.html\r
194 \r
195  日本国内での販売については、下記にお問い合わせ下さい。\r
196  http://www.msoft.co.jp/pressrelease/press090928-1.html\r
197 \r
198 \r
199 \r
200 ・謝辞\r
201 \r
202 arc@dmzさん\r
203 http://digitalmuseum.jp/\r
204 \r
205 QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。