OSDN Git Service

[更新]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.3.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.3\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  -座標変換の演算性能が1.5倍ほど高速です。(JIT有効時)複数マーカー取り扱い時は、\r
37   オリジナルよりも良い成績が得られます。\r
38 \r
39  -取り扱える画像サイズに制限がありません。\r
40 \r
41  -取り扱えるマーカー個数の最大値が可変です。\r
42 \r
43   -Idマーカシステム(NyId)が利用できます。(Version/2.3.0より)\r
44 \r
45 \r
46 \r
47 \r
48 \r
49 \r
50 ・構成\r
51 \r
52 +-----------------------------------------------+\r
53 |                   Application                 |\r
54 +-------+---------+--------+--------+-----------+\r
55 |NyARJMF|CaptureQT| NyARJoglNyARJ3d |           |\r
56 +-------+---------+--------+--------+           |\r
57 |  JMF  |QuickTime|  JOGL  | Java3D |NyARToolkit|\r
58 +-------+---------+--------+--------+           |\r
59 |      Camera     |       3D        |           |\r
60 ------------------------------------+-----------+\r
61 \r
62 \r
63 映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
64 \r
65 3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
66 \r
67 NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
68 や3Dライブラリを使いやすくするためのラッパークラス群です。\r
69 \r
70 各モジュールとNyARToolkitは容易に分離可能であり、個々を単独で\r
71 使用することも可能です。\r
72 \r
73 \r
74 \r
75 \r
76 ・サンプルなど\r
77 \r
78 1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
79   QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
80 \r
81 \r
82 動作確認したバージョンと入手先はこちらです。\r
83 \r
84 JMF JavaTM Media Framework 2.1.1e\r
85 http://java.sun.com/products/java-media/jmf/index.jsp\r
86 \r
87 jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
88 https://jogl.dev.java.net/\r
89 \r
90 java3d-1_5_1-xxxx-i586.exe\r
91 https://java3d.dev.java.net/binary-builds.html\r
92 \r
93 QuickTime 7.5\r
94 http://www.apple.com/quicktime/qtjava/\r
95 \r
96 \r
97 \r
98 2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
99   ディレクトリをインポートしてください。\r
100 \r
101 srcディレクトリには、NyARToolkit本体(計算クラス群)があります。\r
102 src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ用のラッパークラス群があります。\r
103 sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
104 \r
105 \r
106 ・プロジェクトの説明\r
107 \r
108 ライブラリ\r
109 \r
110 NyARToolkit\r
111  NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
112 \r
113 NyARToolkit.utils.jmf\r
114  JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
115  外部ライブラリは、JMFに依存します。\r
116 \r
117 NyARToolkit.utils.qt\r
118  QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
119  外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
120 \r
121 NyARToolkit.utils.jogl\r
122  OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
123  外部ライブラリは、JMF,JOGLに依存します。\r
124 \r
125 NyARToolkit.utils.java3d\r
126  Java3DとNyARToolkitのインタフェイスクラス群があります。\r
127  外部ライブラリは、JMF,Java3Dに依存します。\r
128 \r
129 \r
130 サンプル\r
131 \r
132 NyARToolkit.sample.jogl\r
133  JOGL/JMFを使ったサンプルプログラムがあります。\r
134 \r
135   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
136    単一のARToolKit用マーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
137   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
138    複数のARToolKit用マーカーを認識するサンプルです。1~100個程度のマーカーを\r
139    同時に認識します。\r
140   -jp.nyatla.nyartoolkit.jogl.sample.SingleNyIdMarker\r
141    単一のNyIdマーカを認識するためのサンプルです。アプリケーションフレームワーク\r
142    SingleNyIdMarkerProcesserのリファレンス実装です。\r
143 \r
144 \r
145 NyARToolkit.sample.java3d\r
146  JOGL/JMFを使ったサンプルプログラムです。\r
147  \r
148   -jp.nyatla.nyartoolkit.java3d.sample\r
149    simpleLiteをJava3Dで動かすサンプルがあります。\r
150 \r
151 NyARToolkit.sample.jmf\r
152   JMFを使ったサンプルプログラムです。\r
153 \r
154   -jp.nyatla..nyartoolkit.jmf.sample\r
155   JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
156  \r
157 \r
158 NyARToolkit.sample.qt\r
159  Quicktime for Javaを使ったサンプルプログラムです。\r
160 \r
161  -jp.nyatla.nyartoolkit.qt.sample\r
162   QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
163  \r
164 \r
165 \r
166 \r
167 \r
168 ・足りない機能等\r
169 \r
170 カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
171 今後実装していきます。\r
172 \r
173 \r
174 \r
175 \r
176 ・ライセンス\r
177 \r
178 NyARToolkitは、商用ライセンスとGPLv2以降のデュアルライセンスを採用しています。\r
179 \r
180 GPLについては、LICENCE.txtをお読みください。\r
181 \r
182 商用ライセンスについては、ARToolWorks社に管理を委託しておりますので、\r
183 下記URLを参考に、ARToolWorks社へお問い合わせください。\r
184 http://nyatla.jp/nyartoolkit/wiki/index.php?Licence\r
185 \r
186 \r
187 ライセンスに関する日本語でのお問い合わせについては、下記URLの連絡先にて受け付けています。\r
188 http://nyatla.jp/nyartoolkit/wiki/index.php?PressRelease%2F20090407%20forward%20order%20email%20service\r
189 \r
190 \r
191 ソースコード毎のライセンスについては、ソースコード先頭の署名をご確認ください。\r
192 \r
193 \r
194 \r
195 \r
196 ・謝辞\r
197 \r
198 arc@dmzさん\r
199 http://digitalmuseum.jp/\r
200 \r
201 QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。