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

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / labeling / NyARLabelOverlapChecker.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/labeling/NyARLabelOverlapChecker.java b/lib/src/jp/nyatla/nyartoolkit/core/labeling/NyARLabelOverlapChecker.java
index 7e4b033..6b52d26 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/labeling/NyARLabelOverlapChecker.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/labeling/NyARLabelOverlapChecker.java
@@ -34,16 +34,23 @@ import java.lang.reflect.Array;
 \r
 \r
 /**\r
- * ラベル同士の重なり（内包関係）を調べるクラスです。 \r
- * ラベルリストに内包するラベルを蓄積し、それにターゲットのラベルが内包されているか を確認します。\r
+ * このクラスは、ラベル同士の重なり関係を調べる機能を提供します。\r
+ * 重なりの判定アルゴリズムは、ARToolKitのそれと同一です。\r
+ * 登録済のラベルリストに対して、調査対象のラベルが重なっているかを調べます。\r
  */\r
 public class NyARLabelOverlapChecker<T extends NyARLabelInfo>\r
 {\r
        private T[] _labels;\r
        private int _length;\r
        private Class<T> _element_type;\r
-       /*\r
-       */\r
+       /**\r
+        * コンストラクタです。\r
+        * この関数は、NyARToolkitの矩形検出クラスから使います。\r
+        * @param i_max_label\r
+        * リストの最大登録数\r
+        * @param i_element_type\r
+        * リストのデータ型\r
+        */\r
        @SuppressWarnings("unchecked")\r
        public NyARLabelOverlapChecker(int i_max_label,Class<T> i_element_type)\r
        {\r
@@ -52,9 +59,9 @@ public class NyARLabelOverlapChecker<T extends NyARLabelInfo>
        }\r
 \r
        /**\r
-        * チェック対象のラベルを追加する。\r
-        * \r
+        * この関数は、チェックリストにラベルの参照を追加します。\r
         * @param i_label_ref\r
+        * 追加するラベルの参照値\r
         */\r
        public void push(T i_label_ref)\r
        {\r
@@ -63,10 +70,11 @@ public class NyARLabelOverlapChecker<T extends NyARLabelInfo>
        }\r
 \r
        /**\r
-        * 現在リストにあるラベルと重なっているかを返す。\r
-        * \r
+        * この関数は、チェックリストにあるラベルと、与えられたラベルが、重なっているかを調べます。\r
         * @param i_label\r
-        * @return 何れかのラベルの内側にあるならばfalse,独立したラベルである可能性が高ければtrueです．\r
+        * 調査するラベル\r
+        * @return\r
+        * 何れかのラベルの内側にあるならばfalse,独立したラベルである可能性が高ければtrueです．\r
         */\r
        public boolean check(T i_label)\r
        {\r
@@ -87,9 +95,9 @@ public class NyARLabelOverlapChecker<T extends NyARLabelInfo>
                return true;\r
        }\r
        /**\r
-        * 最大i_max_label個のラベルを蓄積できるようにオブジェクトをリセットする\r
-        * \r
+        * チェックリストの最大数を変更します。\r
         * @param i_max_label\r
+        * 新しいチェックリストの大きさを設定します。\r
         */\r
        @SuppressWarnings("unchecked")\r
        public void setMaxLabels(int i_max_label)\r