
MGL週報 #34 - UIのキー入力まわりの仕組みなど
このエントリはゲーム開発用フレームワーク「MGL」の開発記録です.MGLはzlibライセンスの下に無償で提供されています.
ドキュメントはこちら
進捗状況の確認と問い合わせはこちら
今週の作業内容
ドキュメントの更新
今週の作業は主にドキュメントの更新.地味ながら重要な作業ですよ.
MGLはドキュメントをとても重要視していて,Doxygenでソースコードから自動生成できるにも関わらず手動で作成しています.特にAPIリファレンスは型や定数などを除いたほぼ全ての項目にサンプルコードを載せるようにしています.
当然ながら時間も手間もかかっていて,APIリファレンスを1ページ書くのに大体1日作業になります.実装よりもドキュメントを書く方が時間がかかるなんてのは珍しい事ではありません.
それでもあえて手書きしている理由はというと,それはドキュメントの品質の問題だけではありません.サンプルコードを交えて1つ1つ解説していくことによって,その機能が意図した通りに実装されているかのチェックも兼ねているのです.一見非効率的なように思えるかもしれませんが,実際のところ手間に見合う以上の恩恵はあるのですよ.
とは言え,もうちょっと効率を上げられないかとは常々考えています.いつ書き終わるのか分からない現状も,それはそれで問題ですからね.
UIのキー入力まわりの仕組み
先週少しだけお話ししたUIのキー入力の仕組みについて,もう少しだけ詳しく説明しましょう.より詳細な解説となるとウィジットやその他の様々な要素が絡んでくるため,キー入力部分に特化して軽く説明します.
フォーカスという概念
まず基本的なお約束として,MGLのUIはウィジットという単位の部品で構成されています.この辺のお話は結構前の週報で既に述べているため割愛しましょう.
さて,各ウィジットにはUIイベントを処理するための状態として「フォーカス」というものがあります.フォーカス状態のウィジットは要するに「選択状態」です.MGLのUIでは,「押された」や「決定された」といった確定を知らせるイベントを発行するのはフォーカス状態にあるウィジットに限定されています.
マウス操作の場合,マウスカーソルの下にあるウィジットがフォーカス状態になります.タッチ操作のであれば触れた指の下のウィジットがフォーカス状態です.この辺のルールは,呼び方などの細かい部分は違えど,基本的にはどのようなGUIでも似た概念を持っています.
では,キー入力の場合はどうでしょう?
キー入力の場合,各々のウィジット間でフォーカスを移動させる事になります.右を押したら現在フォーカス中の右側にあるウィジットへとフォーカスが移り,下を押せばその下側にあるウィジットにフォーカスが移ります.これは多くのゲームで共通の挙動です.
問題は,そのウィジット間の移動ルールが画面ごとに異なるという点です.右を押した時にどのウィジットに移るべきか,上の場合はどれかなど,目で見えている通りに動かすのは簡単なように思えて意外と困難なのです.ウィジットの位置関係から割り出すという試みも無くはないのですが,結局は画面ごとに細かい調整が必要になり,手放しに自動化とはいかないのが実情です.
フォーカスベースのUIライブラリの実装例としては,AppleTV向けに用意されたUIFocusなどがあります.UIFocusは位置関係から移動先を自動で判別しますが,同時にヒントなどの様々なパラメータで調整可能な作りになっています.これが理由でゲーム開発とは相性の悪い面もあるため,MGLではUIFocusとは異なる方針での解決を図っています.
フォーカスの移動テーブル
さて,一般化しにくい法則を持ったデータを一括で処理するためのテクニックはもう定番化しています.すなわち,テーブル化です.MGLの次のバージョンでは,キー入力の移動法則をテーブルとして受け取り,それに準じてフォーカスを移動させる仕組みを導入する予定です.
では,具体的な例を挙げてみましょう.次のようなオーソドックスな縦方向の選択リストがあったとします.

この選択リストの移動テーブルは次のようになります.
表中の「」というのは,上から下へ,または下から上へとループしている事を表しています.標準の動作ではこの属性を付与しておくことで,リピート入力の際にはループ移動を行わないようになります.
また,最下段の移動元が「」となっている要素は,どこにもフォーカスされていない状態での移動先になります.キー操作のみのゲームであればこの要素は不要ですが,マウス操作と併用する場合などには対応が必要になります.ここでは,上を押したら最下段の項目を,下を押したら最上段の項目をフォーカスするよう設定しています.
ここで挙げた選択リストは法則性があるため,画面ごとに移動テーブルを用意する必要はないでしょう.汎用化のために選択リストウィジットを作成し,そこに要素を追加する度にテーブルを動的に更新するという実装になるはずです.これはウィジットを作る側,すなわちUIライブラリを用意する側のお仕事ですので,画面を作る側は移動テーブルについて意識する必要はありません.多くの場合,移動テーブルの編集はウィジット側が吸収できる範囲であると想定しています.
上下左右や決定にどのキーを使用するかにつてもカスタマイズが可能です.こちらはテーブルではなく,特定の関数をオーバーライドする形で実装します.先述したループ移動に関する挙動などもこの機能で変更可能です.
もちろん「移動テーブルなど用いず完全にこちら側のルールで実装したい」というレベルのカスタマイズも可能です.その際にはマウスやタッチ操作だけ標準のものを流用することも可能です.至れり尽くせりでしょう?
導入時期
この機能は既に実装済みですので,次のバージョンである1.1.10には入る予定です.ですが,先述の通りドキュメント化によって仕様や実装のチェックも兼ねているため,これを経なければ仕様が固まりません.
まだ他に調整したい部分もいくつかあるため,UI全体が固まるのはもう少し先になりそうです.
その他
noteってのコマンド使えたんですね.今回の表の部分はその機能で作っています.最近はSphinxやRe:VIEWがメインなのでほぼ忘れてしまいましたが,かつては好んで常用していた思い入れの強い組版システムだったりします.