OSDN Git Service

git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@803 7cac0...
[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / types / NyARDoublePoint3d.java
index d1d7e4a..30ac9e7 100644 (file)
  * \r
  */\r
 package jp.nyatla.nyartoolkit.core.types;\r
-\r
+/**\r
+ * このクラスはデータ型です。\r
+ * 3次元の浮動小数点座標を格納します。\r
+ */\r
 public class NyARDoublePoint3d\r
 {\r
+       /** X座標の値です。*/\r
        public double x;\r
+       /** Y座標の値です。*/\r
        public double y;\r
+       /** Z座標の値です。*/    \r
        public double z;\r
        /**\r
-        * 配列ファクトリ\r
+        * この関数は、オブジェクトの一次配列を作ります。\r
         * @param i_number\r
+        * 作成する配列の長さ\r
         * @return\r
+        * 新しい配列。\r
         */\r
        public static NyARDoublePoint3d[] createArray(int i_number)\r
        {\r
@@ -49,6 +57,11 @@ public class NyARDoublePoint3d
                }\r
                return ret;\r
        }\r
+       /**\r
+        * この関数は、オブジェクトからインスタンスに値をセットします。\r
+        * @param i_in\r
+        * コピー元のオブジェクト。\r
+        */     \r
        public final void setValue(NyARDoublePoint3d i_in)\r
        {\r
                this.x=i_in.x;\r
@@ -57,10 +70,12 @@ public class NyARDoublePoint3d
                return;\r
        }\r
        /**\r
-        * p2-p1間の距離の二乗値を計算します。\r
+        * この関数は、インスタンスの座標と、指定点との距離の2乗値を返します。\r
         * @param i_p1\r
+        * 点の座標\r
         * @return\r
-        */     \r
+        * i_p1との距離の二乗値\r
+        */             \r
        public final double sqDist(NyARDoublePoint3d i_p1)\r
        {\r
                double x,y,z;\r