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

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / transmat / solver / INyARTransportVectorSolver.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/transmat/solver/INyARTransportVectorSolver.java b/lib/src/jp/nyatla/nyartoolkit/core/transmat/solver/INyARTransportVectorSolver.java
index 25ad4eb..ea85970 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/transmat/solver/INyARTransportVectorSolver.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/transmat/solver/INyARTransportVectorSolver.java
@@ -35,21 +35,29 @@ import jp.nyatla.nyartoolkit.core.types.NyARDoublePoint2d;
 import jp.nyatla.nyartoolkit.core.types.NyARDoublePoint3d;\r
 \r
 /**\r
- * 並進ベクトル[T]を３次元座標[b]と基点の回転済行列[M]から計算するインタフェイスです。\r
- * [M][T]=[b]\r
- *\r
+ * このインタフェイスは、姿勢変換行列の並進ベクトルを計算する関数を定義します。\r
+ * 並進ベクトルは、３次元座標と、射影後の二次元座標を元に計算します。\r
  */\r
 public interface INyARTransportVectorSolver\r
 {\r
+       /**\r
+        * この関数は、射影変換後の２次元頂点座標をセットします。\r
+        * 実装クラスでは、射影変換後の２次元座標を元にしたパラメータを、インスタンスに記録する処理を書いてください。\r
+        * @param i_ref_vertex_2d\r
+        * 射影変換後の頂点座標配列。\r
+        * @param i_number_of_vertex\r
+        * 頂点座標配列の要素数\r
+        * @throws NyARException\r
+        */\r
        public void set2dVertex(NyARDoublePoint2d[] i_ref_vertex_2d,int i_number_of_vertex) throws NyARException;\r
        /**\r
         * 画面座標群と3次元座標群から、平行移動量を計算します。\r
-        * 2d座標系は、直前に実行したset2dVertexのものを使用します。\r
-        * @param i_vertex_2d\r
-        * 直前のset2dVertexコールで指定したものと同じものを指定してください。\r
+        * 2d座標系は、直前に実行した{@link #set2dVertex}のものを使用します。\r
+        * 実装クラスでは、並進ベクトルを計算して返却する処理を書いてください。\r
         * @param i_vertex3d\r
         * 3次元空間の座標群を設定します。頂点の順番は、画面座標群と同じ順序で格納してください。\r
         * @param o_transfer\r
+        * 並進ベクトルを受け取るオブジェクトを指定します。\r
         * @throws NyARException\r
         */\r
        public void solveTransportVector(NyARDoublePoint3d[] i_vertex3d,NyARDoublePoint3d o_transfer) throws NyARException;\r