OSDN Git Service

[リリース]NyARToolkit 1.0.0
[nyartoolkit-and/nyartoolkit-and.git] / readme.ja.txt
1 ARToolkit Java class library NyARToolkit.\r
2 Copyright (C)2008 R.Iizuka\r
3 \r
4 version 1.0.0.20080428.0\r
5 \r
6 http://nyatla.jp/\r
7 airmail(at)ebony.plala.or.jp\r
8 --------------------------------------------------\r
9 \r
10 \r
11 \r
12 \r
13 ・NyARToolkit\r
14 \r
15 NyARToolkitは、nativeなコードを一切使用しない、Pure Javaのみで\r
16 構成されたARToolkitクラスライブラリです。\r
17 \r
18 ARToolkit 2.72.1をベースに構築されています。\r
19 \r
20 J2SEでのみ動作を確認しました。\r
21 J2MEやMIDP2.0にはそのうち対応します。\r
22 \r
23 \r
24 ARToolkitは加藤博一先生とHuman Interface Technology Labにより\r
25 開発されたAugmented Reality (AR) ライブラリです。\r
26 詳しくはこちらをご覧下さい。\r
27 http://www.hitl.washington.edu/artoolkit/\r
28 \r
29 \r
30 \r
31 ・構成\r
32 \r
33 +-------------------------------------------+\r
34 |               Application                 |\r
35 +-------+---------+-------+-----------------+\r
36 |NyARJMF| NyARJogl|NyARJ3d|                 |\r
37 +-------+---------+-------+                 |\r
38 |  JMF  |  JOGL   |Java3D |Java3DNyARToolkit|\r
39 +-------+---------+-------+                 |\r
40 |Camera |       3D        |                 |\r
41 --------------------------------------------+\r
42 \r
43 映像キャプチャにはJMFを使用し、3D描画にはJOGL又はJava3Dを使用しています。\r
44 NyARJMFとNyJogl,NyJ3dは、これらのエクステンションをApplicationや\r
45 NyARToolKitから使いやすくするためのラッパーです。\r
46 \r
47 これらとNyARToolkitは完全に分離していますので、入力・出力ともに容易に\r
48 差し替えが出来ると思います。\r
49 \r
50 \r
51 \r
52 \r
53 ・サンプルなど\r
54 \r
55 動作させる前に、JMFとJOGLかJava3Dをインストールしてください。\r
56 動作確認したバージョンと入手先はこちらです。\r
57 \r
58 JMF JavaTM Media Framework 2.1.1e\r
59 http://java.sun.com/products/java-media/jmf/index.jsp\r
60 \r
61 jogl-1.1.1-pre-20080328-xxxx-i586.zip\r
62 https://jogl.dev.java.net/\r
63 \r
64 java3d-1_5_1-xxxx-i586.exe\r
65 https://java3d.dev.java.net/binary-builds.html\r
66 \r
67 \r
68 \r
69 サンプルは以下のディレクトリにあります。\r
70 \r
71 ./src\r
72  NyARToolkitのEclipseプロジェクトがあります。\r
73  jp.nyatla.nyartoolkit.sampleパッケージに、Rawイメージから\r
74  変換行列を求めるサンプルがあります。\r
75 \r
76 ./sample\r
77 NyARToolkitのアプリケーションサンプルEclipseプロジェクトがあります。\r
78 \r
79  jmf\r
80   jp.nyatla.nyartoolkit.jmf.sample\r
81   ビデオキャプチャの試験プログラム と、マーカー検出プログラムがあります。\r
82 \r
83  jogl\r
84   jp.nyatla.nyartoolkit.jogl.sample\r
85   ARToolkitのsimpleLite相当のサンプルがあります。\r
86 \r
87  java3d\r
88   jp.nyatla.nyartoolkit.java3d.sample\r
89   simpleLiteのようなものをJava3Dで動かすサンプルがあります。\r
90 \r
91 \r
92 NyARJMFのプロジェクトはNyARToolKitに依存し、NyARJOGLとJava3Dのプロジェクトは\r
93 NyARToolKitとNyARJMFに依存しています。\r
94 zipを展開すると多分参照関係が壊れてますので、再設定してください。\r
95 \r
96 \r
97 \r
98 ・サンプル内のパッケージ注意点\r
99 sampleディレクトリ以下にあるソースはAPIは仕様が固まっていないので、\r
100 時々APIそのものを変更しています。\r
101 \r
102 自前のプロジェクトの部品として使われる場合は、パッケージをコピーして\r
103 使用することをお勧めします。\r
104 \r
105 \r
106 \r
107 ・NyARToolkitとオリジナルの差分\r
108 \r
109 オリジナルと演算結果に互換性がありますが、関数構成を再設計した\r
110 ため、関数名や関数コールの手順の互換性がほとんどありません。\r
111 \r
112 クラスは関数機能毎にまとめた作りになっていますので、オリジナルの\r
113 コード読んだことがあれば、なんとなく判ると思います。\r
114 \r
115 演算性能は、Windows環境下でVCリリース版の約85%です。\r
116 マーカー認識部分はネイティブ版よりも低速ですが、変換行列計算部分\r
117 はネイティブ版よりも高速に動作します。\r
118 \r
119 \r
120 ・足りない機能等\r
121 \r
122 マーカーのセーブ機能と、複数マーカーの認識機能が未実装です。\r
123 \r
124 今後実装していきます。\r
125 \r
126 \r
127 \r
128 \r
129 ・ライセンス\r
130 GPLです。詳しくはLICENCE.txtをみてください。\r
131 \r
132 \r
133 \r
134 \r
135 ・お願い\r
136 NyARToolkitを使って面白いものが出来たら、是非教えてください。\r
137 \r
138 それと強制では有りませんが、NyARToolkitを使った感想などを\r
139 送ってくれると、今後の励みになります。\r
140 \r
141 \r
142 \r
143 ではでは、楽しく遊んでくださいネ。\r
144 \r
145 2008.04.28 R.Iizuka A虎@nyatla.jp\r