src/main/java/jp/sfjp/mikutoga/vmd/parser/VmdLightingHandler.java

   1 /*
   2  * VMD lighting handler
   3  *
   4  * License : The MIT License
   5  * Copyright(c) 2011 MikuToga Partners
   6  */
   7
   8 package jp.sfjp.mikutoga.vmd.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  * VMDモーションファイルのライティング情報(照明光源・セルフシャドウ)
  16  * の通知用ハンドラ。
  17  * <p>フレーム番号は相対的なものとなる。
  18  * カメラ・照明・シャドウのうち
  19  * 一番若いモーションのフレーム番号が0となる模様。
  20  */
  21 public interface VmdLightingHandler extends LoopHandler {
  22
  23     /** 照明光源データ抽出ループ識別子。 */
  24     ParseStage LUMINOUS_LIST = new ParseStage();
  25
  26     /** セルフシャドウデータ抽出ループ識別子。 */
  27     ParseStage SHADOW_LIST = new ParseStage();
  28
  29
  30     /**
  31      * 照明情報のキーフレーム番号に関する情報を通知する。
  32      * <p>{@link #LUMINOUS_LIST}ループの構成要素。
  33      * @param keyFrameNo キーフレーム番号
  34      * @throws MmdFormatException 不正フォーマットによる
  35      * パース処理の中断をパーサに指示
  36      */
  37     void vmdLuminousMotion(int keyFrameNo)
  38             throws MmdFormatException;
  39
  40     /**
  41      * 光源の色情報を通知する。
  42      * <p>色情報はRGB色空間で記述される。
  43      * <p>MMDのUI上の各色成分指定0～255定義域に便宜上256を追加したものが、
  44      * 0.0以上1.0以下にマップされる。
  45      * <ul>
  46      * <li>0は正しく0.0にマップされる。
  47      * <li>128は正しく0.5にマップされる。
  48      * <li>255は1.0より少しだけ小さい数にマップされる。
  49      * </ul>
  50      * <p>{@link #LUMINOUS_LIST}ループの構成要素。
  51      * @param rVal 赤成分(0.0以上1.0以下)
  52      * @param gVal 緑成分(0.0以上1.0以下)
  53      * @param bVal 青成分(0.0以上1.0以下)
  54      * @throws MmdFormatException 不正フォーマットによる
  55      * パース処理の中断をパーサに指示
  56      */
  57     void vmdLuminousColor(float rVal, float gVal, float bVal)
  58             throws MmdFormatException;
  59
  60     /**
  61      * 光源の方向情報を通知する。
  62      * <p>照明方向は、
  63      * ワールド座標原点から伸びる方向ベクトルとして記述される。
  64      * この方向ベクトルに向けて、無限遠の光源から照明が当たる。
  65      * <p>MMDのスライダUI上では各軸成分の定義域は-1.0以上+1.0以下だが、
  66      * さらに絶対値の大きな値を指定することも可能。
  67      * <p>方向ベクトルの長さは演出上の意味を持たないが、
  68      * キーフレーム間の照明方向の補間に影響を及ぼすかもしれない。
  69      * <p>方向ベクトルが零ベクトル(0,0,0)の場合、全ポリゴンに影が落ちる。
  70      * <p>{@link #LUMINOUS_LIST}ループの構成要素。
  71      * @param xVec 方向ベクトルX軸成分
  72      * @param yVec 方向ベクトルY軸成分
  73      * @param zVec 方向ベクトルZ軸成分
  74      * @throws MmdFormatException 不正フォーマットによる
  75      * パース処理の中断をパーサに指示
  76      */
  77     void vmdLuminousDirection(float xVec, float yVec, float zVec)
  78             throws MmdFormatException;
  79
  80     /**
  81      * シャドウ演出情報のキーフレーム番号に関する情報を通知する。
  82      * <p>{@link #SHADOW_LIST}ループの構成要素。
  83      * @param keyFrameNo キーフレーム番号
  84      * @throws MmdFormatException 不正フォーマットによる
  85      * パース処理の中断をパーサに指示
  86      */
  87     void vmdShadowMotion(int keyFrameNo)
  88             throws MmdFormatException;
  89
  90     /**
  91      * セルフシャドウモードを通知する。
  92      * <p>{@link #SHADOW_LIST}ループの構成要素。
  93      * @param shadowMode シャドウモード指定。
  94      * <ul>
  95      * <li>0 : シャドウOFF
  96      * <li>1 : mode1 影描画の質がカメラからの距離の影響をあまり受けない。
  97      * <li>2 : mode2 影描画の質をカメラからの距離に応じて劣化させる
  98      * ことにより、カメラに近いオブジェクトの影描画の質を向上させる。
  99      * </ul>
 100      * @throws MmdFormatException 不正フォーマットによる
 101      * パース処理の中断をパーサに指示
 102      */
 103     void vmdShadowMode(byte shadowMode)
 104             throws MmdFormatException;
 105
 106     /**
 107      * セルフシャドウの描画対象となるオブジェクトの範囲(カメラからの距離)
 108      * を通知する。
 109      * <p>通知されるのは幾何的な距離ではない。
 110      * MMDのUI値(カメラからの距離の100倍？)を
 111      * 10万で割った商を0.1から引いた値が通知される。
 112      * <p>{@link #SHADOW_LIST}ループの構成要素。
 113      * @param shadowScope 距離情報。
 114      * @throws MmdFormatException 不正フォーマットによる
 115      * パース処理の中断をパーサに指示
 116      */
 117     void vmdShadowScopeRaw(float shadowScope)
 118             throws MmdFormatException;
 119
 120 }