OSDN Git Service

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