OSDN Git Service

git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@702 7cac0...
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
index 8c369da..8b51150 100644 (file)
@@ -1,54 +1,57 @@
-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 2.0.0\r
+version 2.5.2\r
 \r
 http://nyatla.jp/nyartoolkit/\r
 airmail(at)ebony.plala.or.jp\r
+wm(at)nyatla.jp\r
 --------------------------------------------------\r
 \r
 \r
 \r
 \r
-・NyARToolkit/2.0\r
+[[NyARToolkit/2.5]]\r
 \r
 NyARToolkitは、Pure Javaで実装したARToolKitクラスライブラリです。\r
+ARToolKit 2.72.1をベースに作られています。\r
 \r
-ARToolKit 2.72.1をベースに構築されています。\r
 \r
-NyARToolkit/1.xと比較し、構造的な最適化がされ、可読性が向上しています。\r
+※ARToolkitは加藤博一先生とHuman Interface Technology Labにより\r
+ 開発されたAugmented Reality (AR) ライブラリです。\r
+ 詳しくは、下記URLをご覧ください。\r
+ http://www.hitl.washington.edu/artoolkit/\r
 \r
 \r
+[[NyARToolkitの特徴]]\r
 \r
-J2SEでのみ動作を確認しました。\r
-J2MEやMIDP2.0にはそのうち対応します。\r
+ -ARToolKitと同等な機能を、クラスベースAPIで提供します。\r
+ -計算器チューニングにより、ARToolKitと比較して、処理性能が\r
+  向上しています。より高い性能を持つNyARToolkit最適化モード\r
+  と、ARToolKitと互換性のある互換モードを搭載しています。\r
 \r
+  --NyARToolkit最適化モード\r
+    いくつかのアルゴリズムをARToolKitのものと差換え、高速化・精度の向上を図ります。\r
+    ARToolKit比で、約2倍の性能があります。(JIT有効時)\r
+    ただし、計算結果はARToolKitのそれと若干ズレがでます。\r
 \r
-ARToolkitは加藤博一先生とHuman Interface Technology Labにより\r
-開発されたAugmented Reality (AR) ライブラリです。\r
-詳しくはこちらをご覧下さい。\r
-http://www.hitl.washington.edu/artoolkit/\r
+  --ARToolKit互換モード\r
+    ARToolKitのアルゴリズムを最適化し、高速化を図ります。\r
+    ARToolKitとほぼ同等の処理性能です。(JIT有効時)\r
 \r
+ -取り扱える画像サイズに制限がなく、静止画も扱えます。\r
+ -取り扱えるマーカー個数の最大値が可変です。\r
+ -Idマーカシステム(NyId)が利用できます。\r
 \r
-・NyARToolkitの特徴\r
 \r
- -ARToolKitと同等な処理シーケンスを、クラスベースで再構築してあります。\r
 \r
-  -構造的な最適化がされており、ARToolKitと比較して可読性に優れています。\r
+[[構成]]\r
 \r
- -座標変換の演算性能が1.5倍ほど高速です。(JIT有効時)複数マーカー取り扱い時は、\r
-  オリジナルよりも良い成績が得られます。\r
+NyARToolkitは、環境に依存しない計算部分の"NyARToolkit"\r
+と、カメラ/3Dレンダラに接続するための、インタフェイス\r
+クラスモジュールで作られています。\r
 \r
- -取り扱える画像サイズに制限がありません。\r
 \r
- -取り扱えるマーカー個数の最大値が可変です。\r
-\r
-\r
-\r
-\r
-\r
-\r
-・構成\r
 \r
 +-----------------------------------------------+\r
 |                   Application                 |\r
@@ -61,23 +64,25 @@ 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
+ カメラインタフェイスは、イメージソースからリアルタイムに画像を\r
+ 取り込む為のモジュールです。\r
+ JMF(NyARJMF)、又はQuickTime(CaptureQT)が用意されています。\r
 \r
+-3Dレンダラインタフェイス\r
+ 3Dレンダラインタフェイスは、3Dレンダリングシステムに、画像や、\r
+ 計算値を設定するためのモジュールです。\r
+ JOGL(NyARJolg)又はJava3D(NyARJ3d)を使用することが出来ます。\r
 \r
+-NyARToolkitコア\r
+ NyARToolkitの中心的なモジュールです。数学処理、画像処理、管理機能\r
+ などが、機能毎にクラス化されています。\r
 \r
 \r
-・サンプルなど\r
+[[サンプルの動かし方]]\r
 \r
-1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
-  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
+1.動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
+  QuickTimeを使う場合には、QuickTime for Javaも必要です。\r
 \r
 \r
 動作確認したバージョンと入手先はこちらです。\r
@@ -96,76 +101,88 @@ http://www.apple.com/quicktime/qtjava/
 \r
 \r
 \r
-2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
-  ディレクトリをインポートしてください。\r
+2.eclipseで空のワークスペースを作成し、sample,src,src.utils\r
+  ディレクトリをインポートしてください。\r
+  各ディレクトリの説明については、\r
 \r
-srcにはNyARToolkit本体、src.utilsにはキャプチャや3Dライブラリとの\r
-インタフェイスクラス群、sampleにはこれらを組み合わせた動作する\r
-サンプルプログラムがあります。\r
+-ディレクトリの説明\r
+  --srcディレクトリには、NyARToolkitコアモジュールを配置してあります。\r
+  --src.utilsディレクトリには、カメラキャプチャクラスや、3Dライブラリ\r
+    用のラッパークラス等の、インタフェイスモジュールが配置してあります。\r
+    があります。\r
+  --sampleディレクトリには、NyARToolkitを使用したサンプルプログラムがあります。\r
 \r
 \r
+[[プロジェクトの説明]]\r
 \r
+[[[ライブラリ]]]\r
 \r
-・プロジェクトの説明\r
+-NyARToolkit\r
+ NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
 \r
-ライブラリ\r
+-NyARToolkit.utils.jmf\r
+ JMF用のインタフェイスモジュールです。\r
+ JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
+ 外部ライブラリは、JMFに依存します。\r
 \r
-NyARToolkit\r
- NyARToolkitライブラリの本体です。依存する外部モジュールはありません。\r
+-NyARToolkit.utils.qt\r
+ QuickTime用のインタフェイスモジュールです。\r
+ QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
+  外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
 \r
-NyARToolkit.utils.jmf\r
- JMFからの画像をNyARToolkitに取り込むクラス群があります。\r
- 外部ライブラリは、JMFに依存します。\r
+-NyARToolkit.utils.jogl\r
+ OpenGL用のインタフェイスモジュールです。\r
+ OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,JOGLに依存します。\r
 \r
-NyARToolkit.utils.qt\r
- QuickTimeからの画像をNyARToolkitに取り込むクラス群があります。\r
- 外部ライブラリは、JMF、QuickTime for Javaに依存します。\r
+-NyARToolkit.utils.java3d\r
+ Java3D用のインタフェイスモジュールです。\r
+ Java3DとNyARToolkitのインタフェイスクラス群があります。\r
+ 外部ライブラリは、JMF,Java3Dに依存します。\r
 \r
-NyARToolkit.utils.jogl\r
- OpenGLとNyARToolkitのインタフェイスクラス群があります。\r
- 外部ライブラリは、JMF,JOGLに依存します。\r
 \r
-NyARToolkit.utils.java3d\r
- Java3DとNyARToolkitのインタフェイスクラス群があります。\r
- 外部ライブラリは、JMF,Java3Dに依存します。\r
-\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
+ JAVA3D/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
 \r
 NyARToolkit.sample.qt\r
- Quicktime for Javaを使ったサンプルプログラムです。\r
+ Quicktime for Javaを使ったサンプルプログラムです。\r
+\r
+  -jp.nyatla.nyartoolkit.qt.sample\r
+   QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
 \r
- -jp.nyatla.nyartoolkit.qt.sample\r
- QuickTimeでキャプチャした画像をNyARToolkitで処理するサンプルプログラムです。\r
- \r
 \r
+NyARToolkit.sandbox\r
+ 正式サポートされていない開発中の実験クラス群です。動作しないものもあります。\r
 \r
 \r
 \r
-・足りない機能等\r
+\r
+[[足りない機能等]]\r
 \r
 カメラキャリブレーション、マーカーのセーブ機能等が相変わらずありません。\r
 今後実装していきます。\r
@@ -173,10 +190,20 @@ NyARToolkit.sample.qt
 \r
 \r
 \r
-・ライセンス\r
-GPLv2以降です。詳しくはLICENCE.txtをみてください。\r
-ソースコード毎のライセンスは、各ソースファイルを参照してください。\r
+[[ライセンス]]\r
+\r
+NyARToolkitは、商用ライセンスとGPLv3以降のデュアルライセンスを採用しています。\r
+(Version/2.4.0より、GPLv3になりました。)\r
+\r
+ -GPLv3\r
+ GPLv3については、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