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

[nyartoolkit-and/nyartoolkit-and.git] / utils / jogl / src / jp / nyatla / nyartoolkit / jogl / utils / NyARGLUtil.java

diff --git a/utils/jogl/src/jp/nyatla/nyartoolkit/jogl/utils/NyARGLUtil.java b/utils/jogl/src/jp/nyatla/nyartoolkit/jogl/utils/NyARGLUtil.java
index 6a885ce..921e481 100644 (file)
--- a/utils/jogl/src/jp/nyatla/nyartoolkit/jogl/utils/NyARGLUtil.java
+++ b/utils/jogl/src/jp/nyatla/nyartoolkit/jogl/utils/NyARGLUtil.java
@@ -35,30 +35,32 @@ import jp.nyatla.nyartoolkit.core.param.NyARPerspectiveProjectionMatrix;
 import jp.nyatla.nyartoolkit.core.types.*;\r
 import jp.nyatla.nyartoolkit.core.types.matrix.*;\r
 /**\r
- * OpenGL向けの形式変換変換関数を提供します。\r
+ * このクラスは、NyARToolkitのデータ型と、OpenGLデータ型を変換する関数を定義します。\r
  * 描画系関数は{@link NyARGLDrawUtil}を参照してください。\r
  */\r
 public class NyARGLUtil\r
 {\r
        /**\r
-        * NyARToolKit 2.53以前のコードと互換性を持たせるためのスケール値。{@link #toCameraFrustumRH}のi_scaleに設定することで、\r
-        * 以前のバージョンの数値系と互換性を保ちます。\r
+        * NyARToolKit 2.53以前のコードと互換性を持たせるためのスケール値。\r
+        * {@link #toCameraFrustumRH}のi_scaleに設定することで、以前のバージョンの数値系と互換性を保ちます。\r
         */\r
        public final static double SCALE_FACTOR_toCameraFrustumRH_NYAR2=1.0;\r
        /**\r
-        * NyARToolKit 2.53以前のコードと互換性を持たせるためのスケール値。{@link #toCameraViewRH}のi_scaleに設定することで、\r
-        * 以前のバージョンの数値系と互換性を保ちます。\r
+        * NyARToolKit 2.53以前のコードと互換性を持たせるためのスケール値。\r
+        * {@link #toCameraViewRH}のi_scaleに設定することで、以前のバージョンの数値系と互換性を保ちます。\r
         */\r
        public final static double SCALE_FACTOR_toCameraViewRH_NYAR2=1/0.025;\r
 \r
-    private NyARGLUtil()\r
+       private NyARGLUtil()\r
     {//生成の禁止\r
     }  \r
 \r
        \r
        /**\r
-        * ARToolKitスタイルのカメラパラメータから、 CameraFrustamを計算します。\r
+        * この関数は、ARToolKitスタイルのカメラパラメータから、 CameraFrustamを計算します。\r
+        * カメラパラメータの要素のうち、ProjectionMatrix成分のみを使います。\r
         * @param i_arparam\r
+        * ARToolKitスタイルのカメラパラメータ。\r
         * @param i_scale\r
         * スケール値を指定します。1=1mmです。10ならば1=1cm,1000ならば1=1mです。\r
         * 2.53以前のNyARToolkitと互換性を持たせるときは、{@link #SCALE_FACTOR_toCameraFrustumRH_NYAR2}を指定してください。\r
@@ -67,6 +69,7 @@ public class NyARGLUtil
         * @param i_far\r
         * 視錐体のfarPointを指定します。単位は、i_scaleに設定した値で決まります。\r
         * @param o_gl_projection\r
+        * OpenGLスタイルのProjectionMatrixです。double[16]を指定します。\r
         */\r
        public static void toCameraFrustumRH(NyARParam i_arparam,double i_scale,double i_near,double i_far,double[] o_gl_projection)\r
        {\r
@@ -74,7 +77,7 @@ public class NyARGLUtil
                return;\r
        }\r
        /**\r
-        * ARToolKitスタイルのProjectionMatrixから、 CameraFrustamを計算します。\r
+        * この関数は、ARToolKitスタイルのProjectionMatrixから、 CameraFrustamを計算します。\r
         * @param i_promat\r
         * @param i_size\r
         * スクリーンサイズを指定します。\r
@@ -95,13 +98,14 @@ public class NyARGLUtil
                return;\r
        }\r
        /**\r
-        * NyARTransMatResultをOpenGLの行列へ変換します。\r
+        * この関数は、NyARTransMatResultをOpenGLのModelView行列へ変換します。\r
         * @param mat\r
         * 変換元の行列\r
         * @param i_scale\r
         * 座標系のスケール値を指定します。1=1mmです。10ならば1=1cm,1000ならば1=1mです。\r
         * 2.53以前のNyARToolkitと互換性を持たせるときは、{@link #SCALE_FACTOR_toCameraViewRH_NYAR2}を指定してください。\r
         * @param o_gl_result\r
+        * OpenGLスタイルのProjectionMatrixです。double[16]を指定します。\r
         */\r
        public static void toCameraViewRH(NyARDoubleMatrix44 mat,double i_scale, double[] o_gl_result)\r
        {\r