======================================================================
NyARToolkitAS3
 version 4.0.1
======================================================================

Copyright (C)2008-2012 Ryo Iizuka

http://nyatla.jp/nyartoolkit/
airmail(at)ebony.plala.or.jp
wm(at)nyatla.jp

----------------------------------------------------------------------
 About NyARToolkit
----------------------------------------------------------------------
 * NyARToolkitは、NyARToolKit 4.0.1のAPIを基盤としたARアプリケーション向けの
   クラスライブラリです。
 * Flash10以上(Stage3Dを使う場合は11以上)に対応しています。
 * ARToolKitの基本機能と、NyARToolKitオリジナルの拡張機能、フレームワーク
   で構成しています。
 * ライブラリは4部構成です。NyARTookitを純粋に移植したsrcモジュール、NyARToolkitの
   RPF(Reality Platform)クラスのあるsrc.rpf,Flash向けの拡張クラスのあるsrc.flarif,
   サンプルのある、sampleです。
 * このSDKが提供する3Dレンダラアダプタは、paperVision3Dのみです。他の3Dレンダラ
   アダプタに対応するときの参考にして下さい。(FLARToolKitでは対応すると思います。)
 * sampleモジュールは、いくつかの動作チェックプログラムと、RPFを使ったサンプルアプ
   リケーションがあります。


 ARToolKitについては、下記のURLをご覧ください。
 http://www.hitl.washington.edu/artoolkit/

----------------------------------------------------------------------
NyARToolkitAS3の特徴
----------------------------------------------------------------------
NyARToolkitAS3の特徴を紹介します。

 * 入力画像、内部画像のフォーマットが、BitmapData形式です。
 * 次の項目について、高速な機能が利用できます。(ラべリング、姿勢最適化、
   画像処理、行列計算、方程式計算)
 * NyId規格のIDマーカが使用できます。
 * RPF(RealityPlatform - マーカ状態管理システム)が利用できます。
 * MarkerSystemが使用できます。
 * 簡易スケッチシステムがあります。MarkerSystemと組み合わせることで、
   以前と比較して、コンパクトな実装ができます。


----------------------------------------------------------------------
 NyARToolkitAS3 License
----------------------------------------------------------------------


NyARToolkitAS3は、商用ライセンスとGPLv3以降のデュアルライセンスを採用して
います。

GPLv3を承諾された場合には、商用、非商用にかかわらず、無償でご利用にな
れます。GPLv3を承諾できない場合には、商用ライセンスの購入をご検討くだ
さい。


 * GPLv3
   GPLv3については、LICENCE.txtをお読みください。

 * 商用ライセンス(日本国)
   株式会社 エム・ソフトにお問い合わせください。
   http://www.msoft.co.jp/pressrelease/press090928-1.html

 * 商用ライセンス(その他の国)
   商用ライセンスについては、ARToolWorks社に管理を委託しております。
   http://www.artoolworks.com/Home.html

----------------------------------------------------------------------
 インストール
----------------------------------------------------------------------
FlashDevelopでコンパイルできるプロジェクトが、sampleフォルダにあります。

FlashDevelopはこちらからダウンロードして下さい。
http://www.flashdevelop.org/wikidocs/index.php?title=Main_Page

----------------------------------------------------------------------
 外部ライブラリ
----------------------------------------------------------------------
NyARToolkitAS3のサンプルを動作させるには、PaperVision3d、またはAway3Dが
必要です。

PaperVision3D
http://blog.papervision3d.org/

Away3D
http://away3d.com/

Away3Dについては、3.4以前と、4.0以降向けの２種類があります。

----------------------------------------------------------------------
 サンプルの概要
----------------------------------------------------------------------
サンプルプログラムの概要です。2つのFlashDevelopプロジェクトについて、
説明します。

Sample/nytest project

 NyARToolkitのテストプログラムです。

 * Main.as
   NyARToolkitのテストプログラムです。
   ベンチマークと、基本クラスのテストを実行して、結果を表示します。
   依存する外部ライブラリはありません。

Sample/FLTest project

 FLARToolkitのテストプログラムです。

 * Main.as
   NyARToolkitのFlash拡張部分のテストと、ベンチマークプログラムです。
   テスト結果をコンソールに出力します。
   依存する外部ライブラリはありません。

 * ARTKView.as
   RPFを使った、ARToolKitマーカの出力プログラムです。マーカには、Hiroマーカ
   を使ってください。

 * NyIdView.as
   RPFを使った、NyIdマーカの出力プログラムです。Idマーカを使ってください。

Sample/Pv3d
 paperVision3dを使ったサンプルプログラムです。sketchのサンプルのみとなります。

  *IdMarker.as
   IDマーカを認識するプログラムです。ID0のマーカを使ってください。
  *ImagePickup.as
   マーカ平面から画像を取得するプログラムです。Hiroマーカを使ってください。
  *JpegInput.as
   カメラ画像の変わりにJpeg画像を入力するプログラムです。
  *MarkerPlane.as
   マーカ平面とマウス座標の相互変換をするプログラムです。
  *PngMarker.as
   マーカパターンにPNG画像を使うプログラムです。
  *SimpleLite.as
   ARマーカに立方体を表示するプログラムです。Hiroマーカを使ってください。
  *SimpleLiteM.as
   複数のARマーカに立方体を表示するプログラムです。HiroマーカとKanjiマーカを
   使ってください。

Sample/Away3d
 Away3D version 3.4以前向けのサンプルです。スクリーン制御に難があるため、640x480
 以外のサイズではうまく動きません。

Sample/Away3D4
 Away3D version 4.0.0 beta向けのデモです。
 

----------------------------------------------------------------------
 既知の不具合
----------------------------------------------------------------------
 1.RPFの姿勢フィードバックが未実装。
 2.RPFの輪郭線抽出系のノイズ処理が最小二乗法の為、遅延が大きい。
 3.RPFの輪郭線抽出系のアルゴリズム不備で輪郭線のドリフトが発生し、トラッキング
   性能が低下する。
 4.RPFの二次元系追跡機能の性能が低い。
 5.RPFのエッジ抽出が、ブラーに弱い。
 6.RPFの初期検出性能が、旧NyARToolkit系と比較して、低い。

----------------------------------------------------------------------
 Special thanks
----------------------------------------------------------------------
加藤博一先生 (Hirokazu Kato, Ph. D.)
 http://www.hitl.washington.edu/artoolkit/

Prof. Mark Billinghurst
 http://www.hitlabnz.org/

Saqooshaさん
 http://saqoo.sh/a/
