readme.ja.txt

   1 ======================================================================\r
   2 NyARToolkit\r
   3  version 3.0.0\r
   4 ======================================================================\r
   5 \r
   6 Copyright (C)2008-2010 Ryo Iizuka\r
   7 \r
   8 http://nyatla.jp/nyartoolkit/\r
   9 airmail(at)ebony.plala.or.jp\r
  10 wm(at)nyatla.jp\r
  11 \r
  12 ----------------------------------------------------------------------\r
  13  About NyARToolkit\r
  14 ----------------------------------------------------------------------\r
  15  * NyARToolkitは、ARToolKit 2.72.1を基盤としたARアプリケーション向けの\r
  16    クラスライブラリです。\r
  17  * J2SE5.0以上に対応しています。\r
  18  * ARToolKitの基本機能と、NyARToolKitオリジナルの拡張機能、フレームワーク\r
  19    で構成しています。\r
  20  * ライブラリは3部構成です。環境依存の少ないlibモジュール、環境依存性のある\r
  21    utilsモジュール、アプリケーションサンプルを実装したsampleモジュールです。\r
  22  * libモジュールは、J2ME規格(ファイルIOのみJ2SE)での実装です。\r
  23  * utilsモジュールは、カメラ制御、3Dシステム制御等、外部モジュール毎に\r
  24    接続の為のヘルパークラスを提供します。\r
  25  * sampleモジュールは、最低限の機能を持つ、ARアプリケーションです。\r
  26 \r
  27 \r
  28  ARToolKitについては、下記のURLをご覧ください。\r
  29  http://www.hitl.washington.edu/artoolkit/\r
  30 \r
  31 \r
  32 ----------------------------------------------------------------------\r
  33 NyARToolkitの特徴\r
  34 ----------------------------------------------------------------------\r
  35 NyARToolkitの特徴を紹介します。\r
  36 \r
  37  * 多くの入力画像を使用できます。(BufferedImage,JMF出力,バイナリ入力,他)\r
  38  * リファクタリングにより、ARToolkitと比較して再利用性が向上しています。\r
  39  * ARToolKitと比較して、2～4倍ほど高速です。\r
  40  * 次の項目について、高速な機能が利用できます。(ラべリング、姿勢最適化、\r
  41    画像処理、行列計算、方程式計算)\r
  42  * NyId規格のIDマーカが使用できます。\r
  43  * RealityPlatform(マーカ状態管理システム)が利用できます。\r
  44 \r
  45 \r
  46 ----------------------------------------------------------------------\r
  47  NyARToolkit License\r
  48 ----------------------------------------------------------------------\r
  49 \r
  50 \r
  51 NyARToolkitは、商用ライセンスとGPLv3以降のデュアルライセンスを採用して\r
  52 います。\r
  53 \r
  54 GPLv3を承諾された場合には、商用、非商用にかかわらず、無償でご利用にな\r
  55 れます。GPLv3を承諾できない場合には、商用ライセンスの購入をご検討くだ\r
  56 さい。\r
  57 \r
  58 \r
  59  * GPLv3\r
  60    GPLv3については、LICENCE.txtをお読みください。\r
  61 \r
  62  * 商用ライセンス(日本国)\r
  63    株式会社 エム・ソフトにお問い合わせください。\r
  64    http://www.msoft.co.jp/pressrelease/press090928-1.html\r
  65 \r
  66  * 商用ライセンス(その他の国)\r
  67    商用ライセンスについては、ARToolWorks社に管理を委託しております。\r
  68    http://www.artoolworks.com/Home.html\r
  69 \r
  70 \r
  71 \r
  72 ----------------------------------------------------------------------\r
  73  インストール\r
  74 ----------------------------------------------------------------------\r
  75 Eclipse環境に、NyARToolkit開発環境をインストールする方法を説明します。\r
  76 \r
  77 \r
  78  1.Eclipseで空のワークスペースを作成します。\r
  79 \r
  80  2.lib,sample,utilsディレクトリをワークスペースにインポートします。\r
  81 \r
  82  3.インポートしたプロジェクトのエラーを修正します。多くの場合、エラーは\r
  83    文字コードの不一致と外部JARファイルの参照ミスです。文字コードの不一致\r
  84    は、プロジェクトの文字コードをUTF8に変更することで解決します。\r
  85    外部JARファイルの参照ミスについては、外部ライブラリの章を参考にして\r
  86    下さい。\r
  87 \r
  88 ----------------------------------------------------------------------\r
  89  外部ライブラリ\r
  90 ----------------------------------------------------------------------\r
  91 NyARToolkitの使用する外部ライブラリは、以下の通りです。\r
  92 新しいバージョンのものがあれば、そちらを使用してください。\r
  93 \r
  94 \r
  95  1. JMF JavaTM Media Framework 2.1.1e\r
  96     utils.jmf,sample.joglの実行に必要です。\r
  97     website: http://java.sun.com/products/java-media/jmf/index.jsp\r
  98 \r
  99  2. QuickTime 7.5\r
 100     utils.qtの実行に必要です。\r
 101     http://www.apple.com/quicktime/qtjava/\r
 102 \r
 103  3. Jogl\r
 104     utils.jogl,sample.joglの実行に必要です。\r
 105     website: https://jogl.dev.java.net/\r
 106     file   : jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
 107 \r
 108  4. java3d\r
 109     utils.java3d,sample.java3dの実行に必要です。\r
 110     website: https://java3d.dev.java.net/binary-builds.html\r
 111     file:    java3d-1_5_1-xxxx-i586.exe\r
 112 \r
 113 \r
 114 実行するプロジェクトによっては、全ての外部ライブラリを揃える必要は\r
 115 ありません。必要なものだけをインストールしてください。\r
 116 \r
 117 \r
 118 \r
 119 \r
 120 ----------------------------------------------------------------------\r
 121  プロジェクトの概要\r
 122 ----------------------------------------------------------------------\r
 123 Eclipseプロジェクトの概要です。\r
 124 \r
 125  * NyARToolkit\r
 126    NyARToolkitライブラリの本体です。基本的はJ2ME規格のコードです。\r
 127    (一部、J2SE規格のコードが混じっています。)\r
 128    2つのソースフォルダがあります。srcには画像処理、数値計算クラス群が\r
 129    あります。src.rpfには、RealityPlatformを構成するクラス群があります。\r
 130    依存する外部ライブラリはありません。\r
 131 \r
 132  * NyARToolkit.sample.java3d\r
 133    Java3dを出力先とするサンプルアプリケーションです。1個のサンプル\r
 134    プログラムがあります。外部ライブラリは、Java3DとJMFに依存しています。\r
 135 \r
 136  * NyARToolkit.sample.jogl\r
 137    OpenGLを出力先とするサンプルアプリケーションです。2つのソースフォル\r
 138    ダがあります。srcには従来形式のサンプルプログラムが5個、src.rpfには、\r
 139    RealityPlatformを使ったサンプルプログラムが5個あります。\r
 140 \r
 141  * NyARToolkit.sandbox\r
 142    お砂場です。実験プログラムや作りかけのコードなどを埋蔵しています。\r
 143    品質は未保証です（不具合等が多く放置されています）。\r
 144    testソースフォルダにあるサンプルプログラムは、RealityPlatformの試験\r
 145    に役立つかもしれません。\r
 146 \r
 147  * NyARToolkit.utils.j2se\r
 148    JavaSEに依存したヘルパークラス群と、テストプログラムがあります。\r
 149    BufferedImageをそのままNyARToolkitへ入力するためのクラスなどが\r
 150    あります。\r
 151 \r
 152  * NyARToolkit.utils.java3d\r
 153    Java3Dに依存したヘルパークラス群と、テストプログラムがあります。\r
 154    NyARToolkitの出力値のJava3dへの入力を支援します。\r
 155 \r
 156  * NyARToolkit.utils.jogl\r
 157    Joglに依存したヘルパークラス群と、テストプログラムがあります。\r
 158    NyARToolkitの出力値のJoglへの入力を支援します。\r
 159 \r
 160  * NyARToolkit.utils.qt\r
 161    QTJavaに依存したヘルパークラス群と、テストプログラムがあります。\r
 162    QuickTimeからのキャプチャを支援します。\r
 163 \r
 164 ----------------------------------------------------------------------\r
 165  NyARToolkitのパフォーマンス\r
 166 ----------------------------------------------------------------------\r
 167 \r
 168 NyARToolkitは、ARToolKitの処理系のいくつかを差し替え、高速化を図ってい\r
 169 ます。1マーカ検出時の性能では、アルゴリズムレベルで4倍、単純な速度比で\r
 170 約2倍程度高速です。\r
 171 \r
 172 3.0.0から追加されたRPF(RealityPlatform)を使用した場合、さらに1.5倍程度\r
 173 の高速化が可能です。RealityPlatformについては別資料の公開をお待ち下さい。\r
 174 \r
 175 ----------------------------------------------------------------------\r
 176  FAQ\r
 177 ----------------------------------------------------------------------\r
 178  *Q1.Windows7でJMFの設定が保存できません。\r
 179    >JMFRegistryを、管理者権限で実行することで、保存ができるようになります。\r
 180 \r
 181  *Q2.2.5.3以前のNyARToolkitとそのまま差し替えできません。\r
 182    >いくつかの関数で、引数が変更になりました。サンプルファイルを参考に、\r
 183     関数コールを修正してください。\r
 184 \r
 185  *Q3.RealityPlatform(RPF)とは何ですか。使い方が判りません。\r
 186   >RPFは、マーカ系ARアプリケーションの為の、フレームワークです。これを\r
 187    使うと、未知のマーカを認識したり、マーカの環境プロパティに簡単に\r
 188    アクセスできるようになります。また、軽度のマーカのはみ出しや、部分破壊\r
 189    にも対応できます。\r
 190    概念や説明書は今から書きますので、しばらくお待ちください。\r
 191 ----------------------------------------------------------------------\r
 192  既知の不具合\r
 193 ----------------------------------------------------------------------\r
 194  1.RPFの姿勢フィードバックが未実装。\r
 195  2.RPFの輪郭線抽出系のノイズ処理が最小二乗法の為、遅延が大きい。\r
 196  3.RPFの輪郭線抽出系のアルゴリズム不備で、輪郭線のドリフト現象が発生する。\r
 197  4.RPFの二次元系の移動検出性能が低い。\r
 198  5.RPFのエッジ抽出が、ブラーに弱い。\r
 199  6.RPFの初期検出性能が、旧NyARToolkit系と比較して低い。\r
 200  \r
 201 ----------------------------------------------------------------------\r
 202  お問い合わせ\r
 203 ----------------------------------------------------------------------\r
 204 NyARToolkitに関するお問い合わせは、wm(at)nyatla.jp までご連絡ください。\r
 205 状況により、お返事が遅れることもあります。ご了承ください。\r
 206 \r
 207 ----------------------------------------------------------------------\r
 208  Special thanks\r
 209 ----------------------------------------------------------------------\r
 210 加藤博一先生 (Hirokazu Kato, Ph. D.)\r
 211  http://www.hitl.washington.edu/artoolkit/\r
 212 \r
 213 Prof. Mark Billinghurst\r
 214  http://www.hitlabnz.org/\r
 215 \r
 216 arc@dmzさん\r
 217  http://digitalmuseum.jp/\r