import jp.nyatla.nyartoolkit.core.types.NyARBufferType;\r
\r
/**\r
- * NyARCodeクラスの支援クラスです。このクラスは、NyARCodeのマーカファイル読み取り機能を担当します。\r
- * InputStreamからARToolkit形式のマーカデータを読み取って配列に格納する手順を実装します。\r
+ * {@link NyARCode}クラスの支援クラスです。\r
+ * このクラスは、{@link NyARCode}のマーカファイル読み取り機能のうち、InputStreamからARToolkit形式のマーカデータを読み取って配列に格納する手順を実装します。\r
+ * {@link NyARCode}以外から使用することはありません。\r
*/\r
class NyARCodeFileReader\r
{\r
\r
/**\r
- * ImputStreamからARToolKit形式のマーカデータを読み込んでo_raster[4]に格納します。\r
+ * ImputStreamからARToolKit形式のマーカデータを読み、o_raster[4]に格納します。\r
* @param i_stream\r
* 読出し元のストリームです。\r
* @param o_raster\r
- * 出力先のラスタ配列です。バッファ形式は形式はINT1D_X8R8G8B8_32であり、全て同一なサイズである必要があります。\r
+ * 出力先のラスタ配列です。\r
+ * バッファ形式は形式はINT1D_X8R8G8B8_32であり、4要素、かつ全て同一なサイズである必要があります。\r
* @throws NyARException\r
*/\r
public static void loadFromARToolKitFormFile(InputStream i_stream,NyARRaster[] o_raster) throws NyARException\r
{\r
- assert o_raster.length==4;\r
+ assert(o_raster.length==4);\r
//4個の要素をラスタにセットする。\r
try {\r
StreamTokenizer st = new StreamTokenizer(new InputStreamReader(i_stream));\r
return;\r
}\r
/**\r
- * ImputStreamã\81\8bã\82\89ARToolKitå½¢å¼\8fã\81®ã\83\9eã\83¼ã\82«ã\83\87ã\83¼ã\82¿ã\82\92èªã\81¿è¾¼ã\82\93ã\81§o_codeã\81«格納します。\r
+ * ImputStreamã\81\8bã\82\89ARToolKitå½¢å¼\8fã\81®ã\83\9eã\83¼ã\82«ã\83\87ã\83¼ã\82¿ã\82\92èªã\81¿è¾¼ã\81¿ã\80\81o_codeã\82ªã\83\96ã\82¸ã\82§ã\82¯ã\83\88ã\81¸格納します。\r
* @param i_stream\r
* 読出し元のストリームです。\r
* @param o_code\r
- * 出力先のNyARCodeオブジェクトです。\r
+ * 出力先の{@link NyARCode}オブジェクトです。\r
* @throws NyARException\r
*/\r
public static void loadFromARToolKitFormFile(InputStream i_stream,NyARCode o_code) throws NyARException\r
return;\r
}\r
/**\r
- * 1ブロック分のXRGBデータをi_stからo_bufへ読みだします。\r
+ * ストリームi_stから、1ブロック(1方位分)のXRGBデータをからo_bufへ読みだします。\r
* @param i_st\r
- * 入力元のStreamTokenizerを指定します。関数実行後、読み取り位置は更新されます。\r
+ * 入力元のStreamTokenizerを指定します。\r
+ * i_stの読み取り位置は更新されます。\r
* @param i_width\r
- * パターンの横幅です。\r
+ * パターンの横解像度(pixel)です。\r
* @param i_height\r
- * パターンの縦幅です。\r
+ * パターンの縦解像度(pixel)です。\r
* @param o_buf\r
* 読み取った値を格納する配列です。\r
* @throws NyARException\r
}\r
\r
/**\r
- * ARToolKitã\81®ã\83\9eã\83¼ã\82«ã\83¼ã\83\91ã\82¿ã\83¼ã\83³1å\80\8bã\81®ã\83\87ã\83¼ã\82¿ã\81«ç\9b¸å½\93するクラスです。\r
- * ã\83\9eã\83¼ã\82«ã\83¼ã\83\91ã\82¿ã\83¼ã\83³ã\81«å¯¾ã\81\99ã\82\8bã\80\81ARToolKitç\9b¸å½\93ã\81®ã\83\97ã\83ã\83\91ã\83\86ã\82£å\80¤を提供します。\r
+ * ARToolKitã\81®ã\83\9eã\83¼ã\82«ã\83¼ã\83\91ã\82¿ã\83¼ã\83³1å\80\8bã\81®ã\83\87ã\83¼ã\82¿ã\82\92æ ¼ç´\8dするクラスです。\r
+ * ã\83\9eã\83¼ã\82«ã\83¼ã\83\91ã\82¿ã\83¼ã\83³ã\81®ã\83\97ã\83ã\83\91ã\83\86ã\82£ã\81¨ã\80\81ã\83\87ã\83¼ã\82¿ã\81®ã\83ã\83¼ã\83\89æ©\9fè\83½を提供します。\r
*/\r
public class NyARCode\r
{\r
private int _height;\r
\r
/**\r
- * directionを指定して、NyARMatchPattDeviationColorDataオブジェクトを取得します。\r
+ * 指定したdirection(方位)の{@link NyARMatchPattDeviationColorData}オブジェクトの参照値を返します。\r
* @param i_index\r
- * 0<=n<4の数値\r
+ * 方位インデクスの値を指定します。\r
+ * 範囲は、0<=n<=3の数値です。\r
* @return\r
- * NyARMatchPattDeviationColorDataオブジェクト\r
+ * 指定した方位の{@link NyARMatchPattDeviationColorData}オブジェクトを返します。\r
*/\r
public NyARMatchPattDeviationColorData getColorData(int i_index)\r
{\r
return this._color_pat[i_index];\r
}\r
+ /**\r
+ * 指定したdirection(方位)の{@link NyARMatchPattDeviationBlackWhiteData}オブジェクトの参照値を返します。\r
+ * @param i_index\r
+ * 方位インデクスの値を指定します。\r
+ * 範囲は、0<=n<=3の数値です。\r
+ * @return\r
+ * 指定した方位の{@link NyARMatchPattDeviationBlackWhiteData}オブジェクトを返します。\r
+ */\r
public NyARMatchPattDeviationBlackWhiteData getBlackWhiteData(int i_index)\r
{\r
return this._bw_pat[i_index];\r
- } \r
+ }\r
+ /**\r
+ * ARマーカの横解像度を返します。\r
+ * @return\r
+ * 解像度値\r
+ */\r
public int getWidth()\r
{\r
return _width;\r
}\r
\r
/**\r
- * パターンデータの高さを取得します。\r
+ * ARマーカの縦解像度を返します。\r
* @return\r
+ * 解像度値\r
*/\r
public int getHeight()\r
{\r
return _height;\r
}\r
/**\r
- * コンストラクタです。空のNyARCodeオブジェクトを作成します。\r
+ * コンストラクタです。\r
+ * 空のNyARCodeオブジェクトを作成します。\r
* @param i_width\r
- * 作成するマーカパターンの幅\r
+ * 作成するマーカパターンの横解像度\r
* @param i_height\r
- * 作成するマーカパターンの高さ\r
+ * 作成するマーカパターンの縦解像度\r
* @throws NyARException\r
*/\r
public NyARCode(int i_width, int i_height) throws NyARException\r
return;\r
}\r
/**\r
- * ファイル名を指定して、パターンデータをロードします。\r
- * ロードするパターンデータのサイズは、現在の値と同じである必要があります。\r
+ * ARToolKit形式のパターンデータをファイルからロードします。\r
+ * ロードするパターンデータの縦横解像度は、このインスタンスの値と同じである必要があります。\r
* @param filename\r
- * ARToolKit形式のパターンデータファイルのå\90\8då\89\8d\r
+ * ARToolKit形式のパターンデータファイルのã\83\91ã\82¹å\90\8d\r
* @throws NyARException\r
*/\r
public void loadARPattFromFile(String filename) throws NyARException\r
return;\r
}\r
/**\r
- * 4枚のラスタから、マーカーパターンを生成して格納します。\r
+ * inputStreamから、ARToolKit形式のパターンデータをロードします。\r
+ * ロードするパターンデータの縦横解像度は、このインスタンスの値と同じである必要があります。\r
+ * @param i_stream\r
+ * 読出し元のStreamオブジェクト\r
+ * @throws NyARException\r
+ */\r
+ public void loadARPatt(InputStream i_stream) throws NyARException\r
+ {\r
+ //ラスタにパターンをロードする。\r
+ NyARCodeFileReader.loadFromARToolKitFormFile(i_stream,this);\r
+ return;\r
+ } \r
+ /**\r
+ * 4枚のラスタオブジェクトから、マーカーパターンを生成して格納します。\r
* @param i_raster\r
- * direction毎のパターンを格納したラスタ配列を指定します。\r
- * ラスタは同一なサイズ、かつマーカーパターンと同じサイズである必要があります。\r
+ * パターンデータを格納したラスタオブジェクト配列を指定します。\r
+ * ラスタは同一な解像度であり、かつこのインスタンスと同じ解像度である必要があります。\r
* 格納順は、パターンの右上が、1,2,3,4象限になる順番です。\r
* @throws NyARException\r
*/\r
return;\r
}\r
/**\r
- * 1枚のラスタから、マーカーパターンを生成して格納します。\r
+ * 1枚のラスタオブジェクトから、マーカーパターンを生成して格納します。\r
+ * 残りの3枚のデータは、関数がi_rasterを回転させて求めます。\r
* @param i_raster\r
- * 基準となるラスタを指定します。ラスタの解像度は、ARマーカコードと同じである必要があります。\r
+ * パターンデータを格納したラスタオブジェクトを指定します。\r
+ * ラスタは、このインスタンスと同じ解像度である必要があります。\r
* @throws NyARException\r
*/ \r
public void setRaster(INyARRgbRaster i_raster) throws NyARException\r
return;\r
}\r
\r
- /**\r
- * inputStreamから、パターンデータをロードします。\r
- * ロードするパターンのサイズは、現在の値と同じである必要があります。\r
- * @param i_stream\r
- * @throws NyARException\r
- */\r
- public void loadARPatt(InputStream i_stream) throws NyARException\r
- {\r
- //ラスタにパターンをロードする。\r
- NyARCodeFileReader.loadFromARToolKitFormFile(i_stream,this);\r
- return;\r
- }\r
+\r
}\r
OSDN Git Service
