trunk/src/jp/nyatla/nyartoolkit/core/pickup/INyARColorPatt.java

   1 /* \r
   2  * PROJECT: NyARToolkit\r
   3  * --------------------------------------------------------------------------------\r
   4  * This work is based on the original ARToolKit developed by\r
   5  *   Hirokazu Kato\r
   6  *   Mark Billinghurst\r
   7  *   HITLab, University of Washington, Seattle\r
   8  * http://www.hitl.washington.edu/artoolkit/\r
   9  *\r
  10  * The NyARToolkit is Java version ARToolkit class library.\r
  11  * Copyright (C)2008 R.Iizuka\r
  12  *\r
  13  * This program is free software; you can redistribute it and/or\r
  14  * modify it under the terms of the GNU General Public License\r
  15  * as published by the Free Software Foundation; either version 2\r
  16  * of the License, or (at your option) any later version.\r
  17  * \r
  18  * This program is distributed in the hope that it will be useful,\r
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  21  * GNU General Public License for more details.\r
  22  * \r
  23  * You should have received a copy of the GNU General Public License\r
  24  * along with this framework; if not, write to the Free Software\r
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  26  * \r
  27  * For further information please contact.\r
  28  *      http://nyatla.jp/nyatoolkit/\r
  29  *      <airmail(at)ebony.plala.or.jp>\r
  30  * \r
  31  */\r
  32 package jp.nyatla.nyartoolkit.core.pickup;\r
  33 \r
  34 import jp.nyatla.nyartoolkit.NyARException;\r
  35 import jp.nyatla.nyartoolkit.core.NyARSquare;\r
  36 import jp.nyatla.nyartoolkit.core.raster.rgb.*;\r
  37 \r
  38 public interface INyARColorPatt\r
  39 {\r
  40         /**\r
  41          * カラーパターンの幅をピクセル値で返します。\r
  42          * \r
  43          * @return\r
  44          */\r
  45         public int getWidth();\r
  46 \r
  47         /**\r
  48          * カラーパターンの高さをピクセル値で返します。\r
  49          * \r
  50          * @return\r
  51          */\r
  52         public int getHeight();\r
  53         /**\r
  54          * カメラパターンを格納した配列への参照値を返します。 配列は最低でも[height][wight][3]のサイズを持ちますが、\r
  55          * 配列のlengthとwidth,heightの数は一致しないことがあります。\r
  56          * setSize関数を実行すると、以前に呼び出されたgetPatArrayが返した値は不定になります。\r
  57          * \r
  58          * @return\r
  59          */\r
  60         public int[][][] getPatArray();\r
  61 \r
  62         /**\r
  63          * ラスタイメージからi_square部分のカラーパターンを抽出して、保持します。\r
  64          * \r
  65          * @param image\r
  66          * @param i_square\r
  67          * @return ラスターの取得に成功するとTRUE/失敗するとFALSE\r
  68          * @throws NyARException\r
  69          */\r
  70         public boolean pickFromRaster(INyARRgbRaster image, NyARSquare i_square) throws NyARException;\r
  71 }