OSDN Git Service

Merge branch 'git-svn'
[nyartoolkit-and/nyartoolkit-and.git] / tags / 2.1.0 / readme.ja.txt
1 ARToolKit Java class library NyARToolkit.\r
2 Copyright (C)2008 R.Iizuka\r
3 \r
4 version 2.1.0\r
5 \r
6 http://nyatla.jp/nyartoolkit/\r
7 airmail(at)ebony.plala.or.jp\r
8 --------------------------------------------------\r
9 \r
10 \r
11 \r
12 \r
13 ・NyARToolkit/2.1\r
14 \r
15 NyARToolkitは、Pure Javaで実装したARToolKitクラスライブラリです。\r
16 \r
17 ARToolKit 2.72.1をベースに構築されています。\r
18 \r
19 NyARToolkit/2.0系は、NyARToolkit/1.xと比較して構造的な最適化がされており、\r
20 可読性と分離性が向上しています。\r
21 \r
22 \r
23 \r
24 J2SEでのみ動作を確認しました。\r
25 J2MEやMIDP2.0にはそのうち対応します。\r
26 \r
27 \r
28 ARToolkitは加藤博一先生とHuman Interface Technology Labにより\r
29 開発されたAugmented Reality (AR) ライブラリです。\r
30 詳しくはこちらをご覧下さい。\r
31 http://www.hitl.washington.edu/artoolkit/\r
32 \r
33 \r
34 ・NyARToolkitの特徴\r
35 \r
36  -ARToolKitと同等な処理シーケンスを、クラスベースで再構築してあります。\r
37 \r
38   -構造的な最適化がされており、ARToolKitと比較して可読性に優れています。\r
39 \r
40  -座標変換の演算性能が1.5倍ほど高速です。(JIT有効時)複数マーカー取り扱い時は、\r
41   オリジナルよりも良い成績が得られます。\r
42 \r
43  -取り扱える画像サイズに制限がありません。\r
44 \r
45  -取り扱えるマーカー個数の最大値が可変です。\r
46 \r
47 \r
48 \r
49 \r
50 \r
51 \r
52 ・構成\r
53 \r
54 +-----------------------------------------------+\r
55 |                   Application                 |\r
56 +-------+---------+--------+--------+-----------+\r
57 |NyARJMF|CaptureQT| NyARJoglNyARJ3d |           |\r
58 +-------+---------+--------+--------+           |\r
59 |  JMF  |QuickTime|  JOGL  | Java3D |NyARToolkit|\r
60 +-------+---------+--------+--------+           |\r
61 |      Camera     |       3D        |           |\r
62 ------------------------------------+-----------+\r
63 \r
64 \r
65 映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
66 \r
67 3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
68 \r
69 NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
70 や3Dライブラリを使いやすくするためのラッパークラス群です。\r
71 \r
72 これらとNyARToolkitは疎結合になっており、インタフェイスをあわせる\r
73 ことで、自作モジュール等との差し替えが出来ます。\r
74 \r
75 \r
76 \r
77 \r
78 ・サンプルなど\r
79 \r
80 1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
81   QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
82 \r
83 \r
84 動作確認したバージョンと入手先はこちらです。\r
85 \r
86 JMF JavaTM Media Framework 2.1.1e\r
87 http://java.sun.com/products/java-media/jmf/index.jsp\r
88 \r
89 jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
90 https://jogl.dev.java.net/\r
91 \r
92 java3d-1_5_1-xxxx-i586.exe\r
93 https://java3d.dev.java.net/binary-builds.html\r
94 \r
95 QuickTime 7.5\r
96 http://www.apple.com/quicktime/qtjava/\r
97 \r
98 \r
99 \r
100 2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
101   ディレクトリをインポートしてください。\r
102 \r
103 srcにはNyARToolkit本体、src.utilsにはキャプチャや3Dライブラリとの\r
104 インタフェイスクラス群、sampleにはこれらを組み合わせた動作する\r
105 サンプルプログラムがあります。\r
106 \r
107 \r
108 \r
109 \r
110 ・プロジェクトの説明\r
111 \r
112 ライブラリ\r
113 \r
114 NyARToolkit\r
115  NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
116 \r
117 NyARToolkit.utils.jmf\r
118  JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
119  外部ライブラリは、JMFに依存します。\r
120 \r
121 NyARToolkit.utils.qt\r
122  QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
123  外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
124 \r
125 NyARToolkit.utils.jogl\r
126  OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
127  外部ライブラリは、JMF,JOGLに依存します。\r
128 \r
129 NyARToolkit.utils.java3d\r
130  Java3DとNyARToolkitのインタフェイスクラス群があります。\r
131  外部ライブラリは、JMF,Java3Dに依存します。\r
132 \r
133 \r
134 サンプル\r
135 \r
136 NyARToolkit.sample.jogl\r
137  JOGL/JMFを使ったサンプルプログラムがあります。\r
138 \r
139   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
140    単一のマーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
141   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
142    複数のマーカーを認識するサンプルです。~100個程度のマーカーを同時に\r
143    認識します。\r
144 \r
145 \r
146 NyARToolkit.sample.java3d\r
147  JOGL/JMFを使ったサンプルプログラムです。\r
148  \r
149   -jp.nyatla.nyartoolkit.java3d.sample\r
150   simpleLiteをJava3Dで動かすサンプルがあります。\r
151 \r
152 NyARToolkit.sample.jmf\r
153   JMFを使ったサンプルプログラムです。\r
154 \r
155   -jp.nyatla..nyartoolkit.jmf.sample\r
156  JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
157  \r
158 \r
159 NyARToolkit.sample.qt\r
160  Quicktime for Javaを使ったサンプルプログラムです。\r
161 \r
162  -jp.nyatla.nyartoolkit.qt.sample\r
163  QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\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 GPLv2以降です。詳しくはLICENCE.txtをみてください。\r
179 ソースコード毎のライセンスは、各ソースファイルを参照してください。\r
180 \r
181 \r
182 \r
183 \r
184 ・謝辞\r
185 \r
186 arc@dmzさん\r
187 http://digitalmuseum.jp/\r
188 \r
189 QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。