OSDN Git Service

[TAG]NyARToolkit/2.5.0
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
1 ARToolKit Java class library NyARToolkit.\r
2 Copyright (C)2008-2010 Ryo Iizuka\r
3 \r
4 version 2.5.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.5\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 |                   Application                 |\r
60 +-------+---------+--------+--------+-----------+\r
61 |NyARJMF|CaptureQT| NyARJoglNyARJ3d |           |\r
62 +-------+---------+--------+--------+           |\r
63 |  JMF  |QuickTime|  JOGL  | Java3D |NyARToolkit|\r
64 +-------+---------+--------+--------+           |\r
65 |      Camera     |       3D        |           |\r
66 ------------------------------------+-----------+\r
67 \r
68 \r
69 カメラインタフェイス\r
70   映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
71   NyARJMF/CaptureQTは、各カメラライブラリのラッパークラス群です。\r
72   \r
73 3Dレンダラインタフェイス\r
74  3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
75  NyARJolg/NyARJ3dは、各3dライブラリへのラッパークラス群です。\r
76 \r
77 NyARToolkitコア\r
78  NyARToolkitの中核部は、機能毎に細分化された部品クラスと、それらを\r
79  ユースケースに合せて動作させる管理クラスに分かれています。\r
80  jp.nyatla.nyartoolkit.core下にあるクラスは部品クラス、その上位に\r
81  あるものは、ユースケースごとの管理クラスです。\r
82 \r
83 \r
84 \r
85 ・サンプルなど\r
86 \r
87 1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
88   QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
89 \r
90 \r
91 動作確認したバージョンと入手先はこちらです。\r
92 \r
93 JMF JavaTM Media Framework 2.1.1e\r
94 http://java.sun.com/products/java-media/jmf/index.jsp\r
95 \r
96 jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
97 https://jogl.dev.java.net/\r
98 \r
99 java3d-1_5_1-xxxx-i586.exe\r
100 https://java3d.dev.java.net/binary-builds.html\r
101 \r
102 QuickTime 7.5\r
103 http://www.apple.com/quicktime/qtjava/\r
104 \r
105 \r
106 \r
107 2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
108   ディレクトリをインポートしてください。\r
109 \r
110 srcディレクトリには、NyARToolkit本体(計算クラス群)があります。\r
111 src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ\r
112 用のラッパークラス群があります。\r
113 sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
114 \r
115 \r
116 ・プロジェクトの説明\r
117 \r
118 ライブラリ\r
119 \r
120 NyARToolkit\r
121  NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
122 \r
123 NyARToolkit.utils.jmf\r
124  JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
125  外部ライブラリは、JMFに依存します。\r
126 \r
127 NyARToolkit.utils.qt\r
128  QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
129   外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
130 \r
131 NyARToolkit.utils.jogl\r
132  OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
133  外部ライブラリは、JMF,JOGLに依存します。\r
134 \r
135 NyARToolkit.utils.java3d\r
136  Java3DとNyARToolkitのインタフェイスクラス群があります。\r
137  外部ライブラリは、JMF,Java3Dに依存します。\r
138 \r
139 \r
140 サンプル\r
141 \r
142 NyARToolkit.sample.jogl\r
143  JOGL/JMFを使ったサンプルプログラムがあります。\r
144 \r
145   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
146    単一のARToolKit用マーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
147   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
148    複数のARToolKit用マーカーを認識するサンプルです。1~100個程度のマーカーを\r
149    同時に認識します。\r
150   -jp.nyatla.nyartoolkit.jogl.sample.SingleNyIdMarker\r
151    単一のNyIdマーカを認識するためのサンプルです。アプリケーションフレームワーク\r
152    SingleNyIdMarkerProcesserのリファレンス実装です。\r
153 \r
154 \r
155 NyARToolkit.sample.java3d\r
156  JOGL/JMFを使ったサンプルプログラムです。\r
157 \r
158   -jp.nyatla.nyartoolkit.java3d.sample\r
159    simpleLiteをJava3Dで動かすサンプルがあります。\r
160 \r
161 NyARToolkit.sample.jmf\r
162   JMFを使ったサンプルプログラムです。\r
163 \r
164   -jp.nyatla..nyartoolkit.jmf.sample\r
165   JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
166 \r
167 NyARToolkit.sample.qt\r
168  Quicktime for Javaを使ったサンプルプログラムです。\r
169 \r
170   -jp.nyatla.nyartoolkit.qt.sample\r
171   QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
172 \r
173 \r
174 NyARToolkit.sandbox\r
175  正式サポートされていない開発中の実験クラス群です。動作しないものもあります。\r
176 \r
177 \r
178 \r
179 \r
180 ・足りない機能等\r
181 \r
182 カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
183 今後実装していきます。\r
184 \r
185 \r
186 \r
187 \r
188 ・ライセンス\r
189 \r
190 NyARToolkitは、商用ライセンスとGPLv3以降のデュアルライセンスを採用しています。\r
191 (Version/2.4.0より、GPLv3ライセンスになりました。)\r
192 \r
193  -GPL\r
194  GPLについては、LICENCE.txtをお読みください。\r
195 \r
196  -商用ライセンス\r
197  商用ライセンスについては、ARToolWorks社に管理を委託しております。\r
198  http://www.artoolworks.com/Home.html\r
199 \r
200  日本国内での販売については、下記にお問い合わせ下さい。\r
201  http://www.msoft.co.jp/pressrelease/press090928-1.html\r
202 \r
203 \r
204 \r
205 ・謝辞\r
206 \r
207 arc@dmzさん\r
208 http://digitalmuseum.jp/\r
209 \r
210 QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。