modify javadoc format.

[mikutoga/TogaGem.git] / src / main / java / jp / sfjp / mikutoga / vmd / parser / VmdBasicHandler.java

diff --git a/src/main/java/jp/sfjp/mikutoga/vmd/parser/VmdBasicHandler.java b/src/main/java/jp/sfjp/mikutoga/vmd/parser/VmdBasicHandler.java
index 08b8ba0..6915fad 100644 (file)
--- a/src/main/java/jp/sfjp/mikutoga/vmd/parser/VmdBasicHandler.java
+++ b/src/main/java/jp/sfjp/mikutoga/vmd/parser/VmdBasicHandler.java
@@ -14,14 +14,18 @@ import jp.sfjp.mikutoga.bin.parser.ParseStage;
 /**
  * VMDモーションファイルの基本情報(ボーンモーション／モーフモーション)
  * の通知用ハンドラ。
 /**
  * VMDモーションファイルの基本情報(ボーンモーション／モーフモーション)
  * の通知用ハンドラ。

+ *

  * <p>フレーム番号は相対的なものとなる。
  * 一番若いモーションのフレーム番号が0となる模様。
  * <p>フレーム番号は相対的なものとなる。
  * 一番若いモーションのフレーム番号が0となる模様。

+ *

  * <p>位置情報の座標基準は左手系ワールド座標で表される。
  * <p>位置情報の座標基準は左手系ワールド座標で表される。

+ *

  * <p>モーション補間情報は三次ベジェ曲線により記述される。
  * 三次ベジェ曲線は4つの制御点P0,P1,P2,P3により定義される。
  * P0は(0,0)、P3は(127,127)で固定。
  * P1,P2はP0,P3を対角線とする正方形の内部になければならない。
  * 直線補間の場合、P1には(20,20)、P2には(107,107)が使われることが多い。
  * <p>モーション補間情報は三次ベジェ曲線により記述される。
  * 三次ベジェ曲線は4つの制御点P0,P1,P2,P3により定義される。
  * P0は(0,0)、P3は(127,127)で固定。
  * P1,P2はP0,P3を対角線とする正方形の内部になければならない。
  * 直線補間の場合、P1には(20,20)、P2には(107,107)が使われることが多い。

+ *

  * <p>補間情報は直後のボーンモーション情報との差分に関するもの。
  */
 public interface VmdBasicHandler extends LoopHandler {
  * <p>補間情報は直後のボーンモーション情報との差分に関するもの。
  */
 public interface VmdBasicHandler extends LoopHandler {


@@ -63,8 +67,10 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * モーションの適用先モデル名に関する情報を通知する。
 
     /**
      * モーションの適用先モデル名に関する情報を通知する。

+     *

      * <p>カメラやライティングなどの演出データには
      * 特殊なモデル名が使われる。
      * <p>カメラやライティングなどの演出データには
      * 特殊なモデル名が使われる。

+     *

      * @param modelName モデル名
      * @throws MmdFormatException 不正フォーマットによる
      * パース処理の中断をパーサに指示
      * @param modelName モデル名
      * @throws MmdFormatException 不正フォーマットによる
      * パース処理の中断をパーサに指示


@@ -74,7 +80,9 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーンモーションのボーン名及びキーフレーム番号に関する情報を通知する。
 
     /**
      * ボーンモーションのボーン名及びキーフレーム番号に関する情報を通知する。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param boneName ボーン名
      * @param keyFrameNo キーフレーム番号
      * @throws MmdFormatException 不正フォーマットによる
      * @param boneName ボーン名
      * @param keyFrameNo キーフレーム番号
      * @throws MmdFormatException 不正フォーマットによる


@@ -85,8 +93,11 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーン移動モーション情報の通知を受け取る。
 
     /**
      * ボーン移動モーション情報の通知を受け取る。

+     *

      * <p>座標基準は親ボーンもしくはワールド座標。
      * <p>座標基準は親ボーンもしくはワールド座標。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param xPos X座標
      * @param yPos Y座標
      * @param zPos Z座標
      * @param xPos X座標
      * @param yPos Y座標
      * @param zPos Z座標


@@ -98,11 +109,16 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーン回転モーション情報の通知を受け取る。
 
     /**
      * ボーン回転モーション情報の通知を受け取る。

+     *

      * <p>回転及び姿勢はクォータニオンによって記述される。
      * MMDUI上のボーン数値入力YXZオイラー角と等価な回転。
      * <p>回転及び姿勢はクォータニオンによって記述される。
      * MMDUI上のボーン数値入力YXZオイラー角と等価な回転。

+     *

      * <p>座標基準は親ボーンもしくはワールド座標。
      * <p>座標基準は親ボーンもしくはワールド座標。

+     *

      * <p>※ボーン種別によっては、無意味な情報。
      * <p>※ボーン種別によっては、無意味な情報。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param qx クォータニオン虚部 X
      * @param qy クォータニオン虚部 Y
      * @param qz クォータニオン虚部 Z
      * @param qx クォータニオン虚部 X
      * @param qy クォータニオン虚部 Y
      * @param qz クォータニオン虚部 Z


@@ -115,8 +131,11 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーンモーションX軸移動補間情報の通知を受け取る。
 
     /**
      * ボーンモーションX軸移動補間情報の通知を受け取る。

+     *

      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。
      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param xP1x P1点のX座標
      * @param xP1y P1点のY座標
      * @param xP2x P2点のX座標
      * @param xP1x P1点のX座標
      * @param xP1y P1点のY座標
      * @param xP2x P2点のX座標


@@ -129,8 +148,11 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーンモーションY軸移動補間情報の通知を受け取る。
 
     /**
      * ボーンモーションY軸移動補間情報の通知を受け取る。

+     *

      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。
      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param yP1x P1点のX座標
      * @param yP1y P1点のY座標
      * @param yP2x P2点のX座標
      * @param yP1x P1点のX座標
      * @param yP1y P1点のY座標
      * @param yP2x P2点のX座標


@@ -143,8 +165,11 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーンモーションZ軸移動補間情報の通知を受け取る。
 
     /**
      * ボーンモーションZ軸移動補間情報の通知を受け取る。

+     *

      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。
      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * @param zP1x P1点のX座標
      * @param zP1y P1点のY座標
      * @param zP2x P2点のX座標
      * @param zP1x P1点のX座標
      * @param zP1y P1点のY座標
      * @param zP2x P2点のX座標


@@ -157,9 +182,13 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * ボーンモーション回転量補間情報の通知を受け取る。
 
     /**
      * ボーンモーション回転量補間情報の通知を受け取る。

+     *

      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。
      * <p>三次ベジェ曲線のP1,P2点に関する情報を受け取る。

+     *

      * <p>{@link #BONEMOTION_LIST}ループの構成要素。
      * <p>{@link #BONEMOTION_LIST}ループの構成要素。

+     *

      * <p>クォータニオン間のslerp処理に利用される。
      * <p>クォータニオン間のslerp処理に利用される。

+     *

      * @param rP1x P1点のX座標
      * @param rP1y P1点のY座標
      * @param rP2x P2点のX座標
      * @param rP1x P1点のX座標
      * @param rP1y P1点のY座標
      * @param rP2x P2点のX座標


@@ -173,7 +202,9 @@ public interface VmdBasicHandler extends LoopHandler {
 
     /**
      * モーフモーション情報の通知を受け取る。
 
     /**
      * モーフモーション情報の通知を受け取る。

+     *

      * <p>{@link #MORPH_LIST}ループの構成要素。
      * <p>{@link #MORPH_LIST}ループの構成要素。

+     *

      * @param morphName モーフ名。特殊モーフ名「base」は無視してもよい？
      * @param keyFrameNo フレーム番号
      * @param flex モーフ変量。通常は0.0以上1.0以下。
      * @param morphName モーフ名。特殊モーフ名「base」は無視してもよい？
      * @param keyFrameNo フレーム番号
      * @param flex モーフ変量。通常は0.0以上1.0以下。