4 * License : The MIT License
5 * Copyright(c) 2011 MikuToga Partners
8 package jp.sfjp.mikutoga.vmd.parser;
10 import jp.sfjp.mikutoga.bin.parser.LoopHandler;
11 import jp.sfjp.mikutoga.bin.parser.MmdFormatException;
12 import jp.sfjp.mikutoga.bin.parser.ParseStage;
15 * VMDモーションファイルのライティング情報(照明光源・セルフシャドウ)
18 * <p>フレーム番号は相対的なものとなる。
20 * 一番若いモーションのフレーム番号が0となる模様。
22 public interface VmdLightingHandler extends LoopHandler {
24 /** 照明光源データ抽出ループ識別子。 */
25 ParseStage LUMINOUS_LIST = new ParseStage();
27 /** セルフシャドウデータ抽出ループ識別子。 */
28 ParseStage SHADOW_LIST = new ParseStage();
32 * 照明情報のキーフレーム番号に関する情報を通知する。
34 * <p>{@link #LUMINOUS_LIST}ループの構成要素。
36 * @param keyFrameNo キーフレーム番号
37 * @throws MmdFormatException 不正フォーマットによる
40 void vmdLuminousMotion(int keyFrameNo)
41 throws MmdFormatException;
46 * <p>色情報はRGB色空間で記述される。
48 * <p>MMDのUI上の各色成分指定0~255定義域に便宜上256を追加したものが、
51 * <li>0は正しく0.0にマップされる。
52 * <li>128は正しく0.5にマップされる。
53 * <li>255は1.0より少しだけ小さい数にマップされる。
56 * <p>{@link #LUMINOUS_LIST}ループの構成要素。
58 * @param rVal 赤成分(0.0以上1.0以下)
59 * @param gVal 緑成分(0.0以上1.0以下)
60 * @param bVal 青成分(0.0以上1.0以下)
61 * @throws MmdFormatException 不正フォーマットによる
64 void vmdLuminousColor(float rVal, float gVal, float bVal)
65 throws MmdFormatException;
71 * ワールド座標原点から伸びる方向ベクトルとして記述される。
72 * この方向ベクトルに向けて、無限遠の光源から照明が当たる。
74 * <p>MMDのスライダUI上では各軸成分の定義域は-1.0以上+1.0以下だが、
75 * さらに絶対値の大きな値を指定することも可能。
77 * <p>方向ベクトルの長さは演出上の意味を持たないが、
78 * キーフレーム間の照明方向の補間に影響を及ぼすかもしれない。
80 * <p>方向ベクトルが零ベクトル(0,0,0)の場合、全ポリゴンに影が落ちる。
82 * <p>{@link #LUMINOUS_LIST}ループの構成要素。
84 * @param xVec 方向ベクトルX軸成分
85 * @param yVec 方向ベクトルY軸成分
86 * @param zVec 方向ベクトルZ軸成分
87 * @throws MmdFormatException 不正フォーマットによる
90 void vmdLuminousDirection(float xVec, float yVec, float zVec)
91 throws MmdFormatException;
94 * シャドウ演出情報のキーフレーム番号に関する情報を通知する。
96 * <p>{@link #SHADOW_LIST}ループの構成要素。
98 * @param keyFrameNo キーフレーム番号
99 * @throws MmdFormatException 不正フォーマットによる
102 void vmdShadowMotion(int keyFrameNo)
103 throws MmdFormatException;
108 * <p>{@link #SHADOW_LIST}ループの構成要素。
110 * @param shadowMode シャドウモード指定。
113 * <li>1 : mode1 影描画の質がカメラからの距離の影響をあまり受けない。
114 * <li>2 : mode2 影描画の質をカメラからの距離に応じて劣化させる
115 * ことにより、カメラに近いオブジェクトの影描画の質を向上させる。
117 * @throws MmdFormatException 不正フォーマットによる
120 void vmdShadowMode(byte shadowMode)
121 throws MmdFormatException;
124 * セルフシャドウの描画対象となるオブジェクトの範囲(カメラからの距離)
127 * <p>通知されるのは幾何的な距離ではない。
128 * MMDのUI値(カメラからの距離の100倍?)を
129 * 10万で割った商を0.1から引いた値が通知される。
131 * <p>{@link #SHADOW_LIST}ループの構成要素。
133 * @param shadowScope 距離情報。
134 * @throws MmdFormatException 不正フォーマットによる
137 void vmdShadowScopeRaw(float shadowScope)
138 throws MmdFormatException;