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 / matrix / NyARDoubleMatrix44.java
index 52e3aea..0f746f7 100644 (file)
@@ -30,22 +30,45 @@ import jp.nyatla.nyartoolkit.core.types.NyARDoublePoint3d;
 \r
 public class NyARDoubleMatrix44 implements INyARDoubleMatrix\r
 {\r
+       /** 行列の要素値です。*/\r
        public double m00;\r
+       /** 行列の要素値です。*/\r
        public double m01;\r
+       /** 行列の要素値です。*/\r
        public double m02;\r
+       /** 行列の要素値です。*/\r
        public double m03;\r
+       /** 行列の要素値です。*/\r
        public double m10;\r
+       /** 行列の要素値です。*/\r
        public double m11;\r
+       /** 行列の要素値です。*/\r
        public double m12;\r
+       /** 行列の要素値です。*/\r
        public double m13;\r
+       /** 行列の要素値です。*/\r
        public double m20;\r
+       /** 行列の要素値です。*/\r
        public double m21;\r
+       /** 行列の要素値です。*/\r
        public double m22;\r
+       /** 行列の要素値です。*/\r
        public double m23;\r
+       /** 行列の要素値です。*/\r
        public double m30;\r
+       /** 行列の要素値です。*/\r
        public double m31;\r
+       /** 行列の要素値です。*/\r
        public double m32;\r
+       /** 行列の要素値です。*/\r
        public double m33;\r
+       /**\r
+        * この関数は、オブジェクトの配列を生成して返します。\r
+        * @param i_number\r
+        * 配列の長さ\r
+        * @return\r
+        * 新しいオブジェクト配列\r
+        */     \r
        public static NyARDoubleMatrix44[] createArray(int i_number)\r
        {\r
                NyARDoubleMatrix44[] ret=new NyARDoubleMatrix44[i_number];\r
@@ -56,7 +79,8 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return ret;\r
        }\r
        /**\r
-        * 配列の内容をセットします。順番は、00,01,02,03,10...の順です。\r
+        * この関数は、要素数16の配列を、行列にセットします。\r
+        * 00,01,02,03,10...の順です。\r
         */\r
        public void setValue(double[] i_value)\r
        {\r
@@ -79,8 +103,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * i_valueの内容を、このインスタンスにセットします。\r
+        * この関数は、オブジェクトの内容をインスタンスにコピーします。\r
         * @param i_value\r
+        * コピー元のオブジェクト\r
         */\r
        public void setValue(NyARDoubleMatrix44 i_value)\r
        {\r
@@ -103,8 +128,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * 行列の内容を配列に出力します。順番は、00,01,02,03,10...の順です。\r
-        */\r
+        * この関数は、要素数16の配列に、行列の内容をコピーします。\r
+        * 順番は、00,01,02,03,10...の順です。\r
+        */     \r
        public void getValue(double[] o_value)\r
        {\r
                o_value[ 0]=this.m00;\r
@@ -126,8 +152,10 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * 行列の内容を転置してから配列に出力します。\r
+        * この関数は、要素数16の配列に、行列の内容を転置してからコピーします。\r
         * 順番は、00,10,20,30,01...の順です。\r
+        * @param o_value\r
+        * 値を受け取る配列\r
         */     \r
        public void getValueT(double[] o_value)\r
        {\r
@@ -150,9 +178,11 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * 逆行列を計算して、i_srcのthisへ格納します。i_srcにはthisも指定可能です。\r
+        * この関数は、逆行列を計算して、インスタンスにセットします。\r
         * @param i_src\r
+        * 逆行列を計算するオブジェクト。thisを指定できます。\r
         * @return\r
+        * 逆行列を得られると、trueを返します。\r
         */\r
        public boolean inverse(NyARDoubleMatrix44 i_src)\r
        {\r
@@ -240,13 +270,17 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                \r
                return true;\r
        }\r
-       \r
        /**\r
-        * 行列を姿勢変換行列として、3次元座標を座標変換します。4列目は1で仮定します。\r
+        * この関数は、3次元座標を座標変換します。\r
+        * 4列目は1と仮定します。\r
         * @param i_x\r
+        * 変換する三次元座標(X)\r
         * @param i_y\r
+        * 変換する三次元座標(Y)\r
         * @param i_z\r
+        * 変換する三次元座標(Z)\r
         * @param o_out\r
+        * 変換後の座標を受け取るオブジェクト\r
         */\r
        public final void transform3d(double i_x,double i_y,double i_z,NyARDoublePoint3d o_out)\r
        {\r
@@ -255,21 +289,23 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                o_out.z=this.m20*i_x+this.m21*i_y+this.m22*i_z+this.m23;\r
                return;\r
        }\r
-       \r
        /**\r
-        * 行列を姿勢変換行列として、3次元座標を座標変換します。\r
-        * i_inとo_outには同一なインスタンスを指定できます。\r
+        * この関数は、3次元座標を座標変換します。\r
+        * 4列目は1と仮定します。\r
         * @param i_in\r
+        * 返還前する座標値\r
         * @param o_out\r
-        */\r
+        * 変換後の座標を受け取るオブジェクト\r
+        */     \r
        public final void transform3d(NyARDoublePoint3d i_in,NyARDoublePoint3d o_out)\r
        {\r
                transform3d(i_in.x,i_in.y,i_in.z,o_out);\r
        }\r
        /**\r
-        * 行列を姿勢行列として、ZXY系の角度値を返します。\r
-        * この関数は、0-PIの間で値を返します。\r
+        * この関数は、行列の回転成分から、ZXY系の角度値を計算します。\r
         * @param o_out\r
+        * 角度値を受け取るオブジェクトです。\r
+        * 角度値の範囲は、0-PIです。\r
         */\r
        public final void getZXYAngle(NyARDoublePoint3d o_out)\r
        {\r
@@ -289,9 +325,12 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                }\r
        }\r
        /**\r
-        * 行列の掛け算を実行して、結果を格納します。i_mat_lとi_mat_rには、thisを指定しないでください。\r
+        * この関数は、行列同士の掛け算をして、インスタンスに格納します。\r
+        * i_mat_lとi_mat_rには、thisを指定しないでください。\r
         * @param i_mat_l\r
+        * 左成分の行列\r
         * @param i_mat_r\r
+        * 右成分の行列\r
         */\r
        public final void mul(NyARDoubleMatrix44 i_mat_l,NyARDoubleMatrix44 i_mat_r)\r
        {\r
@@ -319,7 +358,7 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * この行列を単位行列にします。\r
+        * この関数は、行列を単位行列にします。\r
         */\r
        public final void identity()\r
        {\r
@@ -328,8 +367,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * 行列に、右手系のX軸回転を設定します。\r
+        * この関数は、行列に右手系のX軸回転を設定します。\r
         * @param i_radian\r
+        * 設定するX回転角(radian)\r
         */\r
        public final void setRotateX(double i_radian)\r
        {\r
@@ -343,8 +383,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * 行列に、右手系のY軸回転を設定します。\r
+        * この関数は、行列に右手系のY軸回転を設定します。\r
         * @param i_radian\r
+        * 設定するY回転角(radian)\r
         */\r
        public final void setRotateY(double i_radian)\r
        {\r
@@ -357,8 +398,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                this.m22=c;\r
        }       \r
        /**\r
-        * 行列に、右手系のZ軸回転を設定します。\r
+        * この関数は、行列に右手系のZ軸回転を設定します。\r
         * @param i_radian\r
+        * 設定するZ回転角(radian)\r
         */\r
        public final void setRotateZ(double i_radian)\r
        {\r
@@ -372,8 +414,13 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                \r
        }\r
        /**\r
-        * 行列に、右手系の並行移動を設定します。\r
-        * @param i_radian\r
+        * この関数は、行列に右手系の平行移動量を設定します。\r
+        * @param i_x\r
+        * x軸方向の平行移動量\r
+        * @param i_y\r
+        * y軸方向の平行移動量\r
+        * @param i_z\r
+        * z軸方向の平行移動量\r
         */\r
        public final void setTranslate(double i_x,double i_y,double i_z)\r
        {\r
@@ -383,8 +430,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                this.m23=i_z;\r
        }\r
        /**\r
-        * この行列をX軸回転します。\r
+        * この関数は、現在の行列をX軸で回転します。\r
         * @param i_mat_r\r
+        * 回転量(radian)\r
         */\r
        public final void rotateX(double i_radian)\r
        {\r
@@ -406,8 +454,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                this.m32=t1*(-s) + t2*c;\r
        }\r
        /**\r
-        * この行列をY軸回転します。\r
+        * この関数は、現在の行列をY軸で回転します。\r
         * @param i_mat_r\r
+        * 回転量(radian)\r
         */\r
        public final void rotateY(double i_radian)\r
        {\r
@@ -429,8 +478,9 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                this.m32=t1*s + t2*c;\r
        }\r
        /**\r
-        * この姿勢行列をZ軸回転します。\r
-        * @i_radian\r
+        * この関数は、現在の行列をZ軸で回転します。\r
+        * @param i_mat_r\r
+        * 回転量(radian)\r
         */\r
        public final void rotateZ(double i_radian)\r
        {\r
@@ -456,10 +506,13 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                return;\r
        }\r
        /**\r
-        * この姿勢行列を右手系で平行移動します。\r
+        * この関数は、現在の行列を平行移動します。\r
         * @param i_x\r
+        * X方向の平行移動量\r
         * @param i_y\r
+        * Y方向の平行移動量\r
         * @param i_z\r
+        * Z方向の平行移動量\r
         */\r
        public final void translate(double i_x,double i_y,double i_z)\r
        {\r
@@ -469,6 +522,10 @@ public class NyARDoubleMatrix44 implements INyARDoubleMatrix
                this.m33=this.m30*i_x + this.m31*i_y + this.m32*i_z + this.m33;\r
                return;\r
        }\r
+       /**\r
+        * テストプログラム\r
+        * @param args\r
+        */\r
        public static void main(String[] args)\r
        {\r
 \r