OSDN Git Service

[TAG]NyARToolkit/2.5.0
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
index 1e9d2b1..4887071 100644 (file)
@@ -1,21 +1,21 @@
-ARToolkit Java class library NyARToolkit.\r
-Copyright (C)2008 R.Iizuka\r
+ARToolKit Java class library NyARToolkit.\r
+Copyright (C)2008-2010 Ryo Iizuka\r
 \r
-version 1.3.1\r
+version 2.5.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.5\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
@@ -29,14 +29,26 @@ http://www.hitl.washington.edu/artoolkit/
 \r
 ・NyARToolkitの特徴\r
 \r
- -ARToolKitの処理関数を全てクラスベースで再構築してあります。\r
+ -ARToolKitと同等な処理シーケンスを、クラスベースで再構築しています。\r
 \r
- -座標変換の演算性能が1.5倍ほど高速です。(JIT有効時)複数マーカー取り扱い時は、\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
@@ -54,23 +66,26 @@ http://www.hitl.washington.edu/artoolkit/
 ------------------------------------+-----------+\r
 \r
 \r
-映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
-\r
-3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
-\r
-NyARJMF/CaptureQT/NyARJog/NyARJ3dは、下位のキャプチャモジュール\r
-や3Dライブラリを使いやすくするためのラッパークラス群です。\r
-\r
-これらとNyARToolkitは疎結合になっており、インタフェイスをあわせる\r
-ことで、自作モジュール等との差し替えが出来ます。\r
+カメラインタフェイス\r
+  映像キャプチャにはJMF、又はQuickTimeを使用することが出来ます。\r
+  NyARJMF/CaptureQTは、各カメラライブラリのラッパークラス群です。\r
+  \r
+3Dレンダラインタフェイス\r
+ 3D描画にはJOGL又はJava3Dを使用することが出来ます。\r
+ NyARJolg/NyARJ3dは、各3dライブラリへのラッパークラス群です。\r
 \r
+NyARToolkitコア\r
+ NyARToolkitの中核部は、機能毎に細分化された部品クラスと、それらを\r
+ ユースケースに合せて動作させる管理クラスに分かれています。\r
+ jp.nyatla.nyartoolkit.core下にあるクラスは部品クラス、その上位に\r
+ あるものは、ユースケースごとの管理クラスです。\r
 \r
 \r
 \r
 ・サンプルなど\r
 \r
 1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
-  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
+  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
 \r
 \r
 動作確認したバージョンと入手先はこちらです。\r
@@ -90,13 +105,12 @@ http://www.apple.com/quicktime/qtjava/
 \r
 \r
 2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
-  ディレクトリをインポートしてください。\r
-\r
-srcにはNyARToolkit本体、src.utilsにはキャプチャや3Dライブラリとの\r
-インタフェイスクラス群、sampleにはこれらを組み合わせた動作する\r
-サンプルプログラムがあります。\r
-\r
+  ディレクトリをインポートしてください。\r
 \r
+srcディレクトリには、NyARToolkit本体(計算クラス群)があります。\r
+src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ\r
+用のラッパークラス群があります。\r
+sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
 \r
 \r
 ・プロジェクトの説明\r
@@ -104,71 +118,87 @@ srcにはNyARToolkit本体、src.utilsにはキャプチャや3Dライブラリ
 ライブラリ\r
 \r
 NyARToolkit\r
- NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
+ NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
 \r
 NyARToolkit.utils.jmf\r
- JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
- 外部ライブラリは、JMFに依存します。\r
+ JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMFに依存します。\r
 \r
 NyARToolkit.utils.qt\r
- QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
- 外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
+ QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
+  外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
 \r
 NyARToolkit.utils.jogl\r
- OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
- 外部ライブラリは、JMF,JOGLに依存します。\r
+ OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,JOGLに依存します。\r
 \r
 NyARToolkit.utils.java3d\r
- Java3DとNyARToolkitのインタフェイスクラス群があります。\r
- 外部ライブラリは、JMF,Java3Dに依存します。\r
+ Java3DとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,Java3Dに依存します。\r
 \r
 \r
 サンプル\r
 \r
 NyARToolkit.sample.jogl\r
- JOGL/JMFを使ったサンプルプログラムがあります。\r
+ JOGL/JMFを使ったサンプルプログラムがあります。\r
 \r
   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite\r
-   単一のマーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
+   単一のARToolKit用マーカーを認識するARToolkitのsimpleLite相当のサンプルです。\r
   -jp.nyatla.nyartoolkit.jogl.sample.JavaSimpleLite2\r
-   複数のマーカーを認識するサンプルです。~100個程度のマーカーを同時に\r
-   認識します。\r
+   複数のARToolKit用マーカーを認識するサンプルです。1~100個程度のマーカーを\r
+   同時に認識します。\r
+  -jp.nyatla.nyartoolkit.jogl.sample.SingleNyIdMarker\r
+   単一のNyIdマーカを認識するためのサンプルです。アプリケーションフレームワーク\r
+   SingleNyIdMarkerProcesserのリファレンス実装です。\r
 \r
 \r
 NyARToolkit.sample.java3d\r
- JOGL/JMFを使ったサンプルプログラムです。\r
- \r
+ JOGL/JMFを使ったサンプルプログラムです。\r
+\r
   -jp.nyatla.nyartoolkit.java3d.sample\r
-  simpleLiteをJava3Dで動かすサンプルがあります。\r
+   simpleLiteをJava3Dで動かすサンプルがあります。\r
 \r
 NyARToolkit.sample.jmf\r
   JMFを使ったサンプルプログラムです。\r
 \r
   -jp.nyatla..nyartoolkit.jmf.sample\r
- JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
- \r
+  JMFでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
 \r
 NyARToolkit.sample.qt\r
- Quicktime for Javaを使ったサンプルプログラムです。\r
+ Quicktime for Javaを使ったサンプルプログラムです。\r
+\r
+  -jp.nyatla.nyartoolkit.qt.sample\r
+  QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
+\r
 \r
- -jp.nyatla.nyartoolkit.qt.sample\r
- QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
- \r
+NyARToolkit.sandbox\r
+ 正式サポートされていない開発中の実験クラス群です。動作しないものもあります。\r
 \r
 \r
 \r
 \r
 ・足りない機能等\r
 \r
-カメラキャリブレーション、マーカーのセーブ機能等がありません。\r
+カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
 今後実装していきます。\r
 \r
 \r
 \r
 \r
 ・ライセンス\r
-GPLv2以降です。詳しくは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
+ http://www.msoft.co.jp/pressrelease/press090928-1.html\r
 \r
 \r
 \r