git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@802 7cac0...

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / squaredetect / NyARSquareContourDetector_ARToolKit.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/squaredetect/NyARSquareContourDetector_ARToolKit.java b/lib/src/jp/nyatla/nyartoolkit/core/squaredetect/NyARSquareContourDetector_ARToolKit.java
index 6c5302c..3b01785 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/squaredetect/NyARSquareContourDetector_ARToolKit.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/squaredetect/NyARSquareContourDetector_ARToolKit.java
@@ -41,7 +41,11 @@ import jp.nyatla.nyartoolkit.core.types.NyARIntCoordinates;
 import jp.nyatla.nyartoolkit.core.types.NyARIntSize;\r
 \r
 \r
-\r
+/**\r
+ * このクラスは、{@link NyARLabeling_ARToolKit}クラスを用いた矩形検出器です。\r
+ * 検出した矩形を、自己コールバック関数{@link #onSquareDetect}へ通知します。\r
+ * 継承クラスで自己コールバック関数{@link #onSquareDetect}を実装する必要があります。\r
+ */\r
 public abstract class NyARSquareContourDetector_ARToolKit extends NyARSquareContourDetector\r
 {\r
        private static final int AR_AREA_MAX = 100000;// #define AR_AREA_MAX 100000\r
@@ -60,9 +64,10 @@ public abstract class NyARSquareContourDetector_ARToolKit extends NyARSquareCont
        private final NyARIntCoordinates _coord;\r
        private final int[] __detectMarker_mkvertex = new int[4];\r
        /**\r
-        * 最大i_squre_max個のマーカーを検出するクラスを作成する。\r
-        * \r
-        * @param i_param\r
+        * コンストラクタです。\r
+        * 入力画像のサイズを指定して、インスタンスを生成します。\r
+        * @param i_size\r
+        * 入力画像のサイズ\r
         */\r
        public NyARSquareContourDetector_ARToolKit(NyARIntSize i_size) throws NyARException\r
        {\r
@@ -78,14 +83,9 @@ public abstract class NyARSquareContourDetector_ARToolKit extends NyARSquareCont
                this._coord=new NyARIntCoordinates(number_of_coord);\r
                return;\r
        }\r
-\r
        /**\r
-        * arDetectMarker2を基にした関数\r
-        * この関数はNyARSquare要素のうち、directionを除くパラメータを取得して返します。\r
-        * directionの確定は行いません。\r
-        * @param i_raster\r
-        * 解析する２値ラスタイメージを指定します。\r
-        * @throws NyARException\r
+        * この関数は、ラスタから矩形を検出して、自己コールバック関数{@link #onSquareDetect}で通知します。\r
+        * ARToolKitのarDetectMarker2を基にしています。\r
         */\r
        public final void detectMarker(NyARBinRaster i_raster) throws NyARException\r
        {\r