2 * VMD camerawork handler
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モーションファイルのカメラワーク情報の通知用ハンドラ。
17 * <p>フレーム番号は相対的なものとなる。
19 * 一番若いモーションのフレーム番号が0となる模様。
21 * <p>ターゲット位置、カメラ回転量とも、座標基準はワールド座標。
23 * <p>カメラターゲットの座標は左手系で表される。
25 * <p>ターゲットに対するカメラ位置は極座標で表される。
27 * <p>補間情報は直前カメラ情報との差分に関するもの。
29 public interface VmdCameraHandler extends LoopHandler {
31 /** カメラデータ抽出ループ識別子。 */
32 ParseStage CAMERA_LIST = new ParseStage();
36 * カメラモーションのキーフレーム番号に関する情報を通知する。
38 * <p>{@link #CAMERA_LIST}ループの構成要素。
40 * @param keyFrameNo キーフレーム番号
41 * @throws MmdFormatException
42 * 不正フォーマットによるパース処理の中断をパーサに指示
44 void vmdCameraMotion(int keyFrameNo)
45 throws MmdFormatException;
48 * ターゲットとカメラ間の距離情報を通知する。
50 * <p>球座標(極座標)の動径に相当する。
51 * 通常はターゲットより手前に位置するカメラまでの距離が負の値で渡される。
53 * <p>カメラ位置がターゲットを突き抜けた場合は正の値もとりうる。
56 * <p>{@link #CAMERA_LIST}ループの構成要素。
59 * @throws MmdFormatException 不正フォーマットによる
62 void vmdCameraRange(float range)
63 throws MmdFormatException;
68 * <p>{@link #CAMERA_LIST}ループの構成要素。
70 * @param xPos ターゲットのX座標
71 * @param yPos ターゲットのY座標
72 * @param zPos ターゲットのZ座標
73 * @throws MmdFormatException 不正フォーマットによる
76 void vmdCameraPosition(float xPos, float yPos, float zPos)
77 throws MmdFormatException;
80 * カメラの回転および回転量情報を通知する。
84 * <p>180度を超える値も回転量として意味を持つ。
86 * <p>{@link #CAMERA_LIST}ループの構成要素。
88 * @param latitude ターゲットから見たカメラの仰俯角(≒緯度)。
91 * <p>Y軸回転量が0の時のZ正軸がY正軸へ倒れる方向が正回転。
92 * (MMDのUIとは符号が逆になるので注意)</p>
95 * カメラはターゲットに対しXZ平面(水平)と平行な箇所に位置する。</p>
97 * @param longitude Y軸周りの回転量(≒経度)。単位はラジアン。
99 * <p>X正軸がZ正軸へ倒れる方向が正回転。(ボーン回転と逆)</p>
101 * <p>仰俯角およびY軸回転量が0の場合、
102 * カメラレンズはZ軸-∞方向からZ軸+∞方向を向く。</p>
104 * @param roll レンズをターゲットを向けたカメラのロール回転量。
107 * Y正軸がX正軸に倒れる方向が正回転。</p>
109 * <p>仰俯角およびロール回転量が0の場合、
110 * カメラ上部はY軸+∞の方を向く。</p>
112 * @throws MmdFormatException 不正フォーマットによる
115 void vmdCameraRotation(float latitude, float longitude, float roll)
116 throws MmdFormatException;
119 * カメラを通じたスクリーン座標への投影に関する情報を通知する。
121 * <p>{@link #CAMERA_LIST}ループの構成要素。
123 * @param angle 縦画角。単位は度数法。MMDのUIでは1から125が指定可能。
124 * @param hasPerspective パースペクティブスイッチがONならtrue。
125 * スイッチがOFFの場合、画角は無視され遠近感処理が行われなくなる。
127 * @throws MmdFormatException 不正フォーマットによる
130 void vmdCameraProjection(int angle, boolean hasPerspective)
131 throws MmdFormatException;
134 * カメラターゲットX軸移動補間情報の通知を受け取る。
135 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
137 * <p>{@link #CAMERA_LIST}ループの構成要素。
143 * @throws MmdFormatException 不正フォーマットによる
146 void vmdCameraIntpltXpos(byte p1x, byte p1y, byte p2x, byte p2y)
147 throws MmdFormatException;
150 * カメラターゲットY軸移動補間情報の通知を受け取る。
151 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
153 * <p>{@link #CAMERA_LIST}ループの構成要素。
159 * @throws MmdFormatException 不正フォーマットによる
162 void vmdCameraIntpltYpos(byte p1x, byte p1y, byte p2x, byte p2y)
163 throws MmdFormatException;
166 * カメラターゲットZ軸移動補間情報の通知を受け取る。
167 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
169 * <p>{@link #CAMERA_LIST}ループの構成要素。
175 * @throws MmdFormatException 不正フォーマットによる
178 void vmdCameraIntpltZpos(byte p1x, byte p1y, byte p2x, byte p2y)
179 throws MmdFormatException;
182 * カメラ回転量補間情報の通知を受け取る。
183 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
185 * <p>{@link #CAMERA_LIST}ループの構成要素。
187 * <p>カメラ回転でクォータニオン補間は使われない。
193 * @throws MmdFormatException 不正フォーマットによる
196 void vmdCameraIntpltRotation(byte p1x, byte p1y, byte p2x, byte p2y)
197 throws MmdFormatException;
200 * カメラ-ターゲット間距離補間情報の通知を受け取る。
201 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
203 * <p>{@link #CAMERA_LIST}ループの構成要素。
209 * @throws MmdFormatException 不正フォーマットによる
212 void vmdCameraIntpltRange(byte p1x, byte p1y, byte p2x, byte p2y)
213 throws MmdFormatException;
216 * スクリーン投影補間情報の通知を受け取る。
217 * 三次ベジェ曲線のP1,P2点に関する情報を受け取る。
219 * <p>{@link #CAMERA_LIST}ループの構成要素。
225 * @throws MmdFormatException 不正フォーマットによる
228 void vmdCameraIntpltProjection(byte p1x, byte p1y, byte p2x, byte p2y)
229 throws MmdFormatException;