src/main/java/jp/sfjp/mikutoga/pmd/parser/PmdMorphHandler.java

   1 /*
   2  * PMD morph information handler
   3  *
   4  * License : The MIT License
   5  * Copyright(c) 2010 MikuToga Partners
   6  */
   7
   8 package jp.sfjp.mikutoga.pmd.parser;
   9
  10 import jp.sfjp.mikutoga.bin.parser.LoopHandler;
  11 import jp.sfjp.mikutoga.bin.parser.MmdFormatException;
  12 import jp.sfjp.mikutoga.bin.parser.ParseStage;
  13
  14 /**
  15  * PMDモデルのモーフ情報の通知用ハンドラ。
  16  */
  17 public interface PmdMorphHandler extends LoopHandler {
  18
  19     /** モーフ抽出ループ。 */
  20     ParseStage MORPH_LIST = new ParseStage();
  21
  22     /** モーフ頂点抽出ループ。 */
  23     ParseStage MORPHVERTEX_LIST = new ParseStage();
  24
  25     /** モーフ出現順抽出ループ。 */
  26     ParseStage MORPHORDER_LIST = new ParseStage();
  27
  28     /**
  29      * モーフ情報の通知を受け取る。
  30      *
  31      * <p>{@link #MORPH_LIST}ループの構成要素
  32      *
  33      * @param morphName モーフ名
  34      * @param morphType モーフ種別。
  35      * <ul>
  36      * <li>0:base
  37      * <li>1:まゆ
  38      * <li>2:目
  39      * <li>3:リップ
  40      * <li>4:その他
  41      * </ul>
  42      * @throws MmdFormatException 不正フォーマットによる
  43      * パース処理の中断をパーサに指示
  44      */
  45     void pmdMorphInfo(String morphName, byte morphType)
  46             throws MmdFormatException;
  47
  48     /**
  49      * モーフ形状の通知を受け取る。
  50      *
  51      * <p>{@link #MORPH_LIST}ループの下位{@link #MORPHVERTEX_LIST}の構成要素。
  52      *
  53      * <p>※ base型頂点IDの出現順がモーフ頂点IDとなる。
  54      *
  55      * @param serialId base型の場合は頂点ID、それ以外はモーフ頂点ID
  56      * @param xPos base型の場合はX座標、それ以外はX軸変位
  57      * @param yPos base型の場合はY座標、それ以外はY軸変位
  58      * @param zPos base型の場合はZ座標、それ以外はZ軸変位
  59      * @throws MmdFormatException 不正フォーマットによる
  60      * パース処理の中断をパーサに指示
  61      */
  62     void pmdMorphVertexInfo(int serialId,
  63                                float xPos, float yPos, float zPos)
  64             throws MmdFormatException;
  65
  66     /**
  67      * 各モーフ種別内のGUI表示順の通知を受け取る。
  68      *
  69      * <p>{@link #MORPHORDER_LIST}ループの構成要素
  70      *
  71      * @param morphId モーフ通し番号。同一モーフ種別内の大小関係のみ意味がある。
  72      * @throws MmdFormatException 不正フォーマットによる
  73      * パース処理の中断をパーサに指示
  74      */
  75     void pmdMorphOrderInfo(int morphId) throws MmdFormatException;
  76
  77 }