OSDN Git Service

[更新]NyARToolkit/2.1
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
index d2ed0f1..c08e897 100644 (file)
@@ -1,21 +1,25 @@
-ARToolkit Java class library NyARToolkit.\r
+ARToolKit Java class library NyARToolkit.\r
 Copyright (C)2008 R.Iizuka\r
 \r
-version Alpha 0.7.20080406.0\r
+version 2.1.0\r
 \r
-http://nyatla.jp/\r
+http://nyatla.jp/nyartoolkit/\r
 airmail(at)ebony.plala.or.jp\r
 --------------------------------------------------\r
 \r
 \r
 \r
 \r
-・NyARToolkit\r
+・NyARToolkit/2.1\r
+\r
+NyARToolkitは、Pure Javaで実装したARToolKitクラスライブラリです。\r
+\r
+ARToolKit 2.72.1をベースに構築されています。\r
+\r
+NyARToolkit/2.0系は、NyARToolkit/1.xと比較して構造的な最適化がされており、\r
+可読性と分離性が向上しています。\r
 \r
-NyARToolkitは、nativeなコードを一切使用しない、Pure Javaのみで\r
-構成されたARToolkitクラスライブラリです。\r
 \r
-ARToolkit 2.72.1をベースに構築されています。\r
 \r
 J2SEでのみ動作を確認しました。\r
 J2MEやMIDP2.0にはそのうち対応します。\r
@@ -27,94 +31,159 @@ ARToolkitは加藤博一先生とHuman Interface Technology Labにより
 http://www.hitl.washington.edu/artoolkit/\r
 \r
 \r
+・NyARToolkitの特徴\r
+\r
+ -ARToolKitと同等な処理シーケンスを、クラスベースで再構築してあります。\r
+\r
+  -構造的な最適化がされており、ARToolKitと比較して可読性に優れています。\r
+\r
+ -座標変換の演算性能が1.5倍ほど高速です。(JIT有効時)複数マーカー取り扱い時は、\r
+  オリジナルよりも良い成績が得られます。\r
+\r
+ -取り扱える画像サイズに制限がありません。\r
+\r
+ -取り扱えるマーカー個数の最大値が可変です。\r
+\r
 \r
-・基本構成\r
 \r
-+-----------------------------+\r
-|         Application         |\r
-+-------+-------+-------------+\r
-|NyARJMF| NyARJogl|           |\r
-+-------+---------+           |\r
-|  JMF  |  JOGL   |NyARToolkit|\r
-+-------+---------+           |\r
-|Camera |  3D     |           |\r
-------------------------------+\r
 \r
-映像キャプチャにはJMFを使用し、3D描画にはJoglを使用しています。\r
-NyARJMFとNyJoglは、これらのエクステンションをApplicationやNyARToolKit\r
-から使いやすくするためのラッパーです。\r
 \r
-これらとNyARToolkitは完全に分離していますので、入力・出力ともに容易に\r
-差し替えが出来ると思います。\r
+\r
+・構成\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
+3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
+\r
+NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
+や3Dライブラリを使いやすくするためのラッパークラス群です。\r
+\r
+これらとNyARToolkitは疎結合になっており、インタフェイスをあわせる\r
+ことで、自作モジュール等との差し替えが出来ます。\r
 \r
 \r
 \r
 \r
 ・サンプルなど\r
 \r
-動作させる前に、JMFとJOGLをインストールしてください。\r
+1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
+  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
+\r
+\r
 動作確認したバージョンと入手先はこちらです。\r
 \r
 JMF JavaTM Media Framework 2.1.1e\r
 http://java.sun.com/products/java-media/jmf/index.jsp\r
 \r
-jogl-1.1.1-pre-20080328-windows-i586.zip\r
+jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
 https://jogl.dev.java.net/\r
 \r
+java3d-1_5_1-xxxx-i586.exe\r
+https://java3d.dev.java.net/binary-builds.html\r
 \r
-サンプルは以下のディレクトリにあります。\r
+QuickTime 7.5\r
+http://www.apple.com/quicktime/qtjava/\r
 \r
-./src\r
-NyARToolkitのEclipseプロジェクトがあります。\r
-jp.nyatla.nyartoolkit.sampleパッケージに、Rawイメージから\r
-変換行列を求めるサンプルがあります。\r
 \r
-./sample\r
-NyARToolkitのアプリケーションサンプルEclipseプロジェクトがあります。\r
-NyARJMFにはビデオキャプチャの試験プログラムと、マーカー検出プログラムがあります。\r
-NyARJOGLにはARToolkitのsimpleLite相当のサンプルがあります。\r
 \r
-NyARJMFのプロジェクトはNyARToolKitに依存し、NyARJOGLのプロジェクトはNyARToolKit\r
-とNyARJMFに依存しています。\r
-zipを展開すると多分参照関係が壊れてますので、再設定してください。\r
+2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
+  ディレクトリをインポートしてください。\r
 \r
+srcにはNyARToolkit本体、src.utilsにはキャプチャや3Dライブラリとの\r
+インタフェイスクラス群、sampleにはこれらを組み合わせた動作する\r
+サンプルプログラムがあります。\r
 \r
 \r
 \r
-・NyARToolkitとオリジナルの差分\r
 \r
-オリジナルと演算結果に互換性がありますが、関数構成を再設計した\r
-ため、関数名や関数コールの手順の互換性がほとんどありません。\r
+・プロジェクトの説明\r
 \r
-クラスは関数機能毎にまとめた作りになっていますので、オリジナルの\r
-コード読んだことがあれば、なんとなく判ると思います。\r
+ライブラリ\r
 \r
+NyARToolkit\r
+ NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
 \r
+NyARToolkit.utils.jmf\r
+ JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMFに依存します。\r
 \r
+NyARToolkit.utils.qt\r
+ QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
 \r
-・足りない機能等\r
+NyARToolkit.utils.jogl\r
+ OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,JOGLに依存します。\r
 \r
-マーカーのセーブ機能と、複数マーカーの認識機能が未実装です。\r
+NyARToolkit.utils.java3d\r
+ Java3DとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,Java3Dに依存します。\r
 \r
-今後実装していきます。\r
 \r
+サンプル\r
 \r
+NyARToolkit.sample.jogl\r
+ JOGL/JMFを使ったサンプルプログラムがあります。\r
 \r
+  -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
+   単一のマーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
+  -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
+   複数のマーカーを認識するサンプルです。~100個程度のマーカーを同時に\r
+   認識します。\r
+\r
+\r
+NyARToolkit.sample.java3d\r
+ JOGL/JMFを使ったサンプルプログラムです。\r
+ \r
+  -jp.nyatla.nyartoolkit.java3d.sample\r
+  simpleLiteをJava3Dで動かすサンプルがあります。\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
-GPLです。詳しくはLICENCE.txtをみてください。\r
 \r
 \r
 \r
+・足りない機能等\r
+\r
+カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
+今後実装していきます。\r
+\r
+\r
+\r
+\r
+・ライセンス\r
+GPLv2以降です。詳しくはLICENCE.txtをみてください。\r
+ソースコード毎のライセンスは、各ソースファイルを参照してください。\r
 \r
-・お願い\r
-NyARToolkitを使って面白いものが出来たら、是非教えてください。\r
 \r
-それと強制では有りませんが、NyARToolkitを使った感想などを\r
-送ってくれると、今後の励みになります。\r
 \r
 \r
+・謝辞\r
 \r
-ではでは、楽しく遊んでくださいネ。\r
+arc@dmzさん\r
+http://digitalmuseum.jp/\r
 \r
-2008.03.29 R.Iizuka nyatla.jp\r
+QuickTimeキャプチャモジュールを提供をして頂きました。有難うございます。
\ No newline at end of file