NyARToolkit for Android v2.x, 3.x mainline.
master: NyARToolkit core.
android-1.6: for Android 1.6. obsolete version.
android-2.2: for Android 2.2. current version.
| Revision | 60e7b5a28220c111ed3a05c49010901fb5e203a7 (tree) |
|---|---|
| Time | 2011-04-05 18:46:01 |
| Author | nyatla <nyatla@7cac...> |
| Commiter | Atsuo Igarashi |
git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@811 7cac0a50-4618-4814-88d0-24b83990f816
| @@ -44,9 +44,10 @@ import jp.nyatla.nyartoolkit.core.labeling.artoolkit.NyARLabelingImage; | ||
| 44 | 44 | import jp.nyatla.nyartoolkit.core.labeling.artoolkit.NyARLabelingLabel; |
| 45 | 45 | |
| 46 | 46 | /** |
| 47 | - * bitmapとして利用可能なラベリングイメージです。 | |
| 48 | - * | |
| 49 | - * | |
| 47 | + * このクラスは、デバック用途のクラスです。 | |
| 48 | + * NyARToolkit形式の画像を、BufferedImage形式へ変換してコピーします。 | |
| 49 | + * NyARBufferedImageRasterをか、NyARRasterImageIOを使用してください。 | |
| 50 | + * @deprecated | |
| 50 | 51 | */ |
| 51 | 52 | public class LabelingBufferdImage extends BufferedImage |
| 52 | 53 | { |
| @@ -12,14 +12,17 @@ import jp.nyatla.nyartoolkit.core.types.NyARBufferType; | ||
| 12 | 12 | import jp.nyatla.nyartoolkit.core.types.NyARIntSize; |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | - * バッファにBufferedImageを使用するNyARRgbRasterです。 | |
| 16 | - * ラップするbufferedImageの種類によっては、パフォーマンスが低下する事があるので注意してください。 | |
| 17 | - * @author nyatla | |
| 18 | - * | |
| 15 | + * このクラスは、BufferedImageをピクセルバッファに持つNyARToolKit互換のラスタクラスです。 | |
| 16 | + * BufferedImageインスタンスをラップしています。 | |
| 17 | + * 通常のJavaプログラムと相互運用する場合に便利です。 | |
| 18 | + * BufferedImageの形式はコンストラクタで指定できます。 | |
| 19 | 19 | */ |
| 20 | 20 | public class NyARBufferedImageRaster extends NyARRgbRaster |
| 21 | 21 | { |
| 22 | 22 | private BufferedImage _buffered_image; |
| 23 | + /** | |
| 24 | + * この関数は、NyARRgbRasterに、NyARBufferedImageRasterの機能を追加します。 | |
| 25 | + */ | |
| 23 | 26 | protected boolean initInstance(NyARIntSize i_size,int i_raster_type,boolean i_is_alloc) |
| 24 | 27 | { |
| 25 | 28 | if(super.initInstance(i_size, i_raster_type, i_is_alloc)){ |
| @@ -39,15 +42,24 @@ public class NyARBufferedImageRaster extends NyARRgbRaster | ||
| 39 | 42 | } |
| 40 | 43 | |
| 41 | 44 | /** |
| 42 | - * NyARBufferTypeと互換性のある形式のBufferedImageを作成します。 | |
| 45 | + * コンストラクタです。 | |
| 46 | + * BufferedImage形式のバッファを持つラスタオブジェクトを作成します。 | |
| 47 | + * BufferedImageのピクセル形式には特色があります。i_raster_typeの説明を参考にして下さい。 | |
| 43 | 48 | * @param i_width |
| 49 | + * ラスタの幅を指定します。 | |
| 44 | 50 | * @param i_height |
| 51 | + * ラスタの高さを指定します。 | |
| 45 | 52 | * @param i_raster_type |
| 46 | - * バッファタイプを指定します。使用できるラスタタイプは、次の種類です。 | |
| 47 | - * NyARBufferType.BYTE1D_R8G8B8_24,NyARBufferType.BYTE1D_B8G8R8_24,NyARBufferType.INT1D_X8R8G8B8_32,NyARBufferType.OBJECT_Java_BufferedImage | |
| 48 | - * NyARBufferType.OBJECT_Java_BufferedImageは低速低速です。パフォーマンスが必要なシステムでは他のバッファタイプを指定してください。 | |
| 53 | + * BufferedImageのバッファタイプを指定します。使用できるラスタタイプは次の種類です。 | |
| 54 | + * <ul> | |
| 55 | + * <li>NyARBufferType.BYTE1D_R8G8B8_24(推奨)</li> | |
| 56 | + * <li>NyARBufferType.BYTE1D_B8G8R8_24(推奨)</li> | |
| 57 | + * <li>NyARBufferType.INT1D_X8R8G8B8_32</li> | |
| 58 | + * <li>NyARBufferType.OBJECT_Java_BufferedImage</li> | |
| 59 | + * </ul> | |
| 60 | + * NyARBufferType.OBJECT_Java_BufferedImageは低速です。パフォーマンスが必要なシステムでは他のバッファタイプを指定してください。 | |
| 49 | 61 | * NyARToolKitの入力・出力に使用する場合は、関数に最適なバッファタイプを使用するとパフォーマンスが向上します。詳細は関数のドキュメントを参照してください。 |
| 50 | - * (NyARBufferType.OBJECT_Java_BufferedImageは全ての関数で低速であり、他の直値タイプは概ね高速に動作します。) | |
| 62 | + * (NyARBufferType.OBJECT_Java_BufferedImageは全ての関数で低速であり、他のタイプは概ね高速に動作します。) | |
| 51 | 63 | * @throws NyARException |
| 52 | 64 | */ |
| 53 | 65 | public NyARBufferedImageRaster(int i_width,int i_height,int i_raster_type) throws NyARException |
| @@ -120,7 +132,7 @@ public class NyARBufferedImageRaster extends NyARRgbRaster | ||
| 120 | 132 | return; |
| 121 | 133 | } |
| 122 | 134 | /** |
| 123 | - * 既にあるbufferedImageをラップしてラスタをつくります。BufferedImageの内容により、ラスタタイプは自動的に決定します。 | |
| 135 | + * この関数は、既にあるBufferedImageをラップしてラスタをつくります。BufferedImageの内容により、ラスタタイプは自動的に決定します。 | |
| 124 | 136 | * @param i_bfi |
| 125 | 137 | * ラップするbufferedImageを設定します。インスタンスが参照するのは、このインスタンスのデフォルトバンクのイメージです。 |
| 126 | 138 | * NyARToolKitと互換性が低いBufferedImageを指定すると、パフォーマンスが劣化することがあります。注意してください。 |
| @@ -155,16 +167,18 @@ public class NyARBufferedImageRaster extends NyARRgbRaster | ||
| 155 | 167 | return; |
| 156 | 168 | } |
| 157 | 169 | /** |
| 158 | - * BufferedImageを返します。 | |
| 170 | + * この関数は、ラップしているBufferedImageを返します。 | |
| 159 | 171 | * @return |
| 172 | + * ラップしているBufferedImageの実体 | |
| 160 | 173 | */ |
| 161 | 174 | public final BufferedImage getBufferedImage() |
| 162 | 175 | { |
| 163 | 176 | return this._buffered_image; |
| 164 | 177 | } |
| 165 | 178 | /** |
| 166 | - * BufferedImageのGraphicsを返します。 | |
| 179 | + * この関数は、BufferedImageのGraphicsを返します。 | |
| 167 | 180 | * @return |
| 181 | + * ラップしているBufferedImageのGraphicsオブジェクト | |
| 168 | 182 | */ |
| 169 | 183 | public final Graphics getGraphics() |
| 170 | 184 | { |
| @@ -172,7 +186,7 @@ public class NyARBufferedImageRaster extends NyARRgbRaster | ||
| 172 | 186 | } |
| 173 | 187 | |
| 174 | 188 | /** |
| 175 | - * BufferedImageを分析して、WriterbleRasterと互換性のあるNyARBufferTypeを調べます。 | |
| 189 | + * この関数は、BufferedImageを分析して、WriterbleRasterと互換性のあるNyARBufferTypeを調べます。 | |
| 176 | 190 | * @param im |
| 177 | 191 | * @return |
| 178 | 192 | */ |
| @@ -229,9 +243,8 @@ public class NyARBufferedImageRaster extends NyARRgbRaster | ||
| 229 | 243 | |
| 230 | 244 | |
| 231 | 245 | /** |
| 232 | - * BufferedImage用の低速PixelReader | |
| 233 | - * @author nyatla | |
| 234 | - * | |
| 246 | + * このクラスは、BufferedImage用の低速なPixelReaderです。 | |
| 247 | + * BufferedImageの形式に依存しない代わりに、ピクセルへのアクセス速度が極端に低速です。 | |
| 235 | 248 | */ |
| 236 | 249 | final class NyARRgbPixelReader_OBJECT_Java_BufferedImage implements INyARRgbPixelReader |
| 237 | 250 | { |
| @@ -55,21 +55,19 @@ public class NyARRealityGl extends NyARReality | ||
| 55 | 55 | /** |
| 56 | 56 | * この関数は、透視投影行列と視錐体パラメータを元に、インスタンスを作成します。 |
| 57 | 57 | * 初期状態のインスタンスを生成します。 |
| 58 | - * この関数は、i_prjmatにnullを指定することで、樽型歪み矯正を行わないインスタンスを生成できます。 | |
| 58 | + * この関数は、樽型歪み矯正を行わないインスタンスを生成できます。 | |
| 59 | 59 | * @param i_prjmat |
| 60 | 60 | * ARToolKit形式の射影変換パラメータを指定します。 |
| 61 | - * @param i_screen | |
| 61 | + * @param i_screen_size | |
| 62 | 62 | * スクリーン(入力画像)のサイズを指定します。 |
| 63 | 63 | * @param i_near |
| 64 | - * {@link #NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 64 | + * {@link NyARReality#NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 65 | 65 | * @param i_far |
| 66 | - * {@link #NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 67 | - * @param i_dist_factor | |
| 68 | - * 樽型歪み矯正オブジェクトを指定します。歪み矯正が不要な時は、nullを指定します。 | |
| 66 | + * {@link NyARReality#NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 69 | 67 | * @param i_max_known_target |
| 70 | - * {@link #NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 68 | + * {@link NyARReality#NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 71 | 69 | * @param i_max_unknown_target |
| 72 | - * {@link #NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 70 | + * {@link NyARReality#NyARReality(NyARParam i_param,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target)}を参照 | |
| 73 | 71 | * @throws NyARException |
| 74 | 72 | */ |
| 75 | 73 | public NyARRealityGl(NyARPerspectiveProjectionMatrix i_prjmat,NyARIntSize i_screen_size,double i_near,double i_far,int i_max_known_target,int i_max_unknown_target) throws NyARException |
| @@ -203,7 +203,7 @@ public class NyARGLDrawUtil | ||
| 203 | 203 | * この関数は、スクリーン座標系をOpenGLにロードします。 |
| 204 | 204 | * スクリーンに二次元系の情報をそのまま書きこむときに使います。 |
| 205 | 205 | * この関数は、PROJECTIONとMODELVIEWスタックをそれぞれ1づつpushします。 |
| 206 | - * スクリーン座標系を使用し終わったら、{@link endScreenCoordinateSystem}を必ず呼び出してください。 | |
| 206 | + * スクリーン座標系を使用し終わったら、{@link #endScreenCoordinateSystem}を必ず呼び出してください。 | |
| 207 | 207 | * @param i_gl |
| 208 | 208 | * OpenGLのインスタンス |
| 209 | 209 | * @param i_width |