OSDN Git Service

[backup]NyARToolkit for Java
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
index d626b5e..a4b6d29 100644 (file)
@@ -1,21 +1,21 @@
-ARToolkit Java class library NyARToolkit.\r
+ARToolKit Java class library NyARToolkit.\r
 Copyright (C)2008 R.Iizuka\r
 \r
-version 1.2.0.20080511\r
+version 2.4.0\r
 \r
-http://nyatla.jp/\r
+http://nyatla.jp/nyartoolkit/\r
 airmail(at)ebony.plala.or.jp\r
+wm(at)nyatla.jp\r
 --------------------------------------------------\r
 \r
 \r
 \r
 \r
-・NyARToolkit\r
+・NyARToolkit/2.4\r
 \r
-NyARToolkitは、nativeなコードを一切使用しない、Pure Javaのみで\r
-構成されたARToolkitクラスライブラリです。\r
+NyARToolkitは、Pure Javaで実装したARToolKitクラスライブラリです。\r
 \r
-ARToolkit 2.72.1をベースに構築されています。\r
+ARToolKit 2.72.1をベースに構築されています。\r
 \r
 J2SEでのみ動作を確認しました。\r
 J2MEやMIDP2.0にはそのうち対応します。\r
@@ -27,32 +27,65 @@ ARToolkitは加藤博一先生とHuman Interface Technology Labにより
 http://www.hitl.washington.edu/artoolkit/\r
 \r
 \r
+・NyARToolkitの特徴\r
+\r
+ -ARToolKitと同等な処理シーケンスを、クラスベースで再構築しています。\r
+\r
+ -ARToolKitと比較して、処理構造が最適化されています。\r
+\r
+ -ARToolKit互換モードと、NyARToolkit最適化モードを搭載しています。(Version/2.4.0より)\r
+  \r
+  --NyARToolkit最適化モード\r
+    いくつかのアルゴリズムをARToolKitのものと差換え、高速化・精度の向上を図ります。\r
+    ARToolKit比で、約2倍高速です。(JIT有効時)複数マーカー取り扱い時は、\r
+    更に高速になります。ただし、計算結果はARToolKitのそれと若干ズレがでます。\r
+\r
+  --ARToolKit互換モード\r
+    ARToolKitのアルゴリズムを最適化し、高速化を図ります。\r
+    ARToolKit比で、約1倍高速です。(JIT有効時)\r
+\r
+ -取り扱える画像サイズに制限がありません。\r
+ -取り扱えるマーカー個数の最大値が可変です。\r
+ -Idマーカシステム(NyId)が利用できます。(Version/2.3.0より)\r
+\r
+\r
+\r
+\r
+\r
+\r
 \r
 ・構成\r
 \r
-+-------------------------------------------+\r
-|               Application                 |\r
-+-------+---------+-------+-----------------+\r
-|NyARJMF| NyARJogl|NyARJ3d|                 |\r
-+-------+---------+-------+                 |\r
-|  JMF  |  JOGL   |Java3D |Java3DNyARToolkit|\r
-+-------+---------+-------+                 |\r
-|Camera |       3D        |                 |\r
---------------------------------------------+\r
++-----------------------------------------------+\r
+|                   Application                 |\r
++-------+---------+--------+--------+-----------+\r
+|NyARJMF|CaptureQT| NyARJoglNyARJ3d |           |\r
++-------+---------+--------+--------+           |\r
+|  JMF  |QuickTime|  JOGL  | Java3D |NyARToolkit|\r
++-------+---------+--------+--------+           |\r
+|      Camera     |       3D        |           |\r
+------------------------------------+-----------+\r
+\r
+\r
+映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
 \r
-映像キャプチャにはJMFを使用し、3D描画にはJOGL又はJava3Dを使用しています。\r
-NyARJMFとNyJogl,NyJ3dは、これらのエクステンションをApplicationや\r
-NyARToolKitから使いやすくするためのラッパーです。\r
+3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
 \r
-これらとNyARToolkitは完全に分離していますので、入力・出力ともに容易に\r
-差し替えが出来ると思います。\r
+NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
+や3Dライブラリを使いやすくするためのラッパークラス群です。\r
+\r
+各モジュールとNyARToolkitは分離可能であり、個々を単独で使用する\r
+ことも可能です。\r
 \r
 \r
 \r
 \r
 ・サンプルなど\r
 \r
-動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
+1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
+  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
+\r
+\r
 動作確認したバージョンと入手先はこちらです。\r
 \r
 JMF JavaTM Media Framework 2.1.1e\r
@@ -64,82 +97,109 @@ https://jogl.dev.java.net/
 java3d-1_5_1-xxxx-i586.exe\r
 https://java3d.dev.java.net/binary-builds.html\r
 \r
+QuickTime 7.5\r
+http://www.apple.com/quicktime/qtjava/\r
 \r
 \r
-サンプルは以下のディレクトリにあります。\r
 \r
-./src\r
- NyARToolkitのEclipseプロジェクトがあります。\r
- jp.nyatla.nyartoolkit.sampleパッケージに、Rawイメージから\r
- 変換行列を求めるサンプルがあります。\r
+2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
+  ディレクトリをインポートしてください。\r
 \r
-./sample\r
-NyARToolkitのアプリケーションサンプルEclipseプロジェクトがあります。\r
+srcディレクトリには、NyARToolkit本体(計算クラス群)があります。\r
+src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ用のラッパークラス群があります。\r
+sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
 \r
- jmf\r
-  jp.nyatla.nyartoolkit.jmf.sample\r
-  ビデオキャプチャの試験プログラム と、マーカー検出プログラムがあります。\r
 \r
- jogl\r
-  jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
-  単一のマーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
-  jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
-  複数のマーカーを認識するサンプルです。~100個程度のマーカーを同時に\r
-  認識します。\r
+・プロジェクトの説明\r
 \r
- java3d\r
-  jp.nyatla.nyartoolkit.java3d.sample\r
-  simpleLiteのようなものをJava3Dで動かすサンプルがあります。\r
+ライブラリ\r
 \r
+NyARToolkit\r
+ NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
 \r
-NyARJMFのプロジェクトはNyARToolKitに依存し、NyARJOGLとJava3Dのプロジェクトは\r
-NyARToolKitとNyARJMFに依存しています。\r
-zipを展開すると多分参照関係が壊れてますので、再設定してください\r
+NyARToolkit.utils.jmf\r
+ JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMFに依存します\r
 \r
+NyARToolkit.utils.qt\r
+ QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
 \r
+NyARToolkit.utils.jogl\r
+ OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,JOGLに依存します。\r
 \r
-・サンプル内のパッケージ注意点\r
-sampleディレクトリ以下にあるソースはAPIは仕様が固まっていないので、\r
-時々APIそのものを変更しています。\r
+NyARToolkit.utils.java3d\r
+ Java3DとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,Java3Dに依存します。\r
 \r
-自前のプロジェクトの部品として使われる場合は、パッケージをコピーして\r
-使用することをお勧めします。\r
 \r
+サンプル\r
 \r
+NyARToolkit.sample.jogl\r
+ JOGL/JMFを使ったサンプルプログラムがあります。\r
 \r
-・NyARToolkitとオリジナルの差分\r
+  -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
+   単一のARToolKit用マーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
+  -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
+   複数のARToolKit用マーカーを認識するサンプルです。1~100個程度のマーカーを\r
+   同時に認識します。\r
+  -jp.nyatla.nyartoolkit.jogl.sample.SingleNyIdMarker\r
+   単一のNyIdマーカを認識するためのサンプルです。アプリケーションフレームワーク\r
+   SingleNyIdMarkerProcesserのリファレンス実装です。\r
 \r
-オリジナルと演算結果に互換性がありますが、関数構成を再設計した\r
-ため、関数名や関数コールの手順の互換性がほとんどありません。\r
 \r
-クラスは関数機能毎にまとめた作りになっていますので、オリジナルの\r
-コード読んだことがあれば、なんとなく判ると思います。\r
+NyARToolkit.sample.java3d\r
+ JOGL/JMFを使ったサンプルプログラムです。\r
+ \r
+  -jp.nyatla.nyartoolkit.java3d.sample\r
+   simpleLiteをJava3Dで動かすサンプルがあります。\r
 \r
-演算性能は、Windows環境下でVCリリース版とほぼ同じです。\r
-マーカー認識部分はネイティブ版よりも低速ですが、変換行列計算部分\r
-はネイティブ版よりも高速に動作します。\r
-このため、複数マーカー取り扱い時は、ネイティブ版よりも良い成績が得られます。\r
+NyARToolkit.sample.jmf\r
+  JMFを使ったサンプルプログラムです。\r
+\r
+  -jp.nyatla..nyartoolkit.jmf.sample\r
+  JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
+ \r
+\r
+NyARToolkit.sample.qt\r
+ Quicktime for Javaを使ったサンプルプログラムです。\r
+\r
+ -jp.nyatla.nyartoolkit.qt.sample\r
+  QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
+ \r
 \r
 \r
-・足りない機能等\r
 \r
-カメラキャリブレーション、マーカーのセーブ機能等がありません。\r
 \r
+・足りない機能等\r
+\r
+カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
 今後実装していきます。\r
 \r
 \r
+\r
+\r
 ・ライセンス\r
-GPLです。詳しくはLICENCE.txtをみてください。\r
 \r
+NyARToolkitは、商用ライセンスとGPLv3以降のデュアルライセンスを採用しています。\r
+(Version/2.4.0より、GPLv3ライセンスになりました。)\r
+\r
+ -GPL\r
+ GPLについては、LICENCE.txtをお読みください。\r
+\r
+ -商用ライセンス\r
+ 商用ライセンスについては、ARToolWorks社に管理を委託しております。\r
+ http://www.artoolworks.com/Home.html\r
 \r
-・お願い\r
-NyARToolkitを使って面白いものが出来たら、是非教えてください。\r
+ 日本国内での販売については、下記にお問い合わせ下さい。\r
+ http://www.msoft.co.jp/pressrelease/press090928-1.html\r
 \r
-それと強制では有りませんが、NyARToolkitを使った感想などを\r
-送ってくれると、今後の励みになります。\r
 \r
 \r
+・謝辞\r
 \r
-ではでは、楽しく遊んでくださいネ。\r
+arc@dmzさん\r
+http://digitalmuseum.jp/\r
 \r
-2008.05.11 R.Iizuka A虎@nyatla.jp\r
+QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。
\ No newline at end of file