UI ナビゲーションコントローラー

[アーティクル]
07/05/2024

このページでは、Windows.Gaming.Input.UINavigationController とユニバーサル Windows プラットフォーム (UWP) 用の関連 API を使った UI ナビゲーションデバイス向けプログラミングの基礎について説明します。

ここでは、次の項目について紹介します。

接続されている UI ナビゲーションデバイスとそのユーザーの一覧を収集する方法
ナビゲーションデバイスが追加または削除されたことを検出する方法
1 つ以上の UI ナビゲーションデバイスから入力を読み取る方法
ゲームパッドとアーケードスティックがナビゲーションデバイスとしてどのように動作するか

ほぼすべてのゲームには、ゲーム前のメニューやゲーム内のダイアログに過ぎない場合でも、ゲームプレイとは別のユーザーインターフェイスがあります。プレイヤーは、選択した入力デバイスを使用してこの UI をナビゲートできる必要がありますが、開発者は各種類の入力デバイスに対して特定のサポートを追加する必要があり、プレイヤーを混乱させるゲームと入力デバイスの間に不整合が生じる可能性もあります。このような理由から、 UINavigationController API が作成されました。

UI ナビゲーションコントローラーはさまざまな物理入力デバイスでサポートできる一般的な UI ナビゲーションコマンドのボキャブラリを提供するために存在する入力デバイスです。 UI ナビゲーションコントローラーは、物理入力デバイスを見る方法とは異なります。ナビゲーションコントローラーとして表示される物理入力デバイスを参照するにはナビゲーションデバイスを使用します。開発者は、特定の入力デバイスではなくナビゲーションデバイスに対してプログラミングすることで、さまざまな入力デバイスをサポートする負担を回避し、既定で一貫性を実現します。

各種類の入力デバイスでサポートされるコントロールの数と種類は非常に異なる場合があるため、また、一部の入力デバイスでは、より豊富な一連のナビゲーションコマンドをサポートする必要があるため、ナビゲーションコントローラーインターフェイスは、コマンドのボキャブラリを 必要なセットに分割し 最も一般的で重要なコマンドを含み、 オプションセット 便利なコマンドを含みます。すべてのナビゲーションデバイスは、必須セット内のすべてのコマンドをサポートしオプションセット内のすべてのコマンド、一部のコマンド、またはサポートしていないコマンド。

必須セット

ナビゲーションデバイスは、 必要なセット内のすべてのナビゲーションコマンドをサポートする必要があります。これらは方向 (上、下、左、右)、表示、メニュー、受け入れ、取り消しコマンドです。

方向コマンドは、単一の UI 要素間のプライマリ XY フォーカスナビゲーションを対象としています。ビューコマンドとメニューコマンドは、ゲームプレイ情報(多くの場合、瞬間的、時にはモーダル)を表示し、ゲームプレイとメニューコンテキストをそれぞれ切り替えることを目的としています。 accept コマンドと cancel コマンドは、それぞれ肯定的 (はい) と否定 (いいえ) の応答を目的としています。

次の表は、これらのコマンドとその使用目的を例と共にまとめたものです。 | コマンド | 使用目的 | -------:| --------------- | Up | XY フォーカスナビゲーションの上 | Down | XY フォーカスナビゲーションの下 | Left | XY フォーカスナビゲーションの左 | Right | XY フォーカスナビゲーションの右 | View | ゲームプレイの情報を表示 (スコアボード、ゲーム統計、目標、世界やマップ領域) | Menu | プライマリメニューまたは一時停止 (設定、状態、装備、道具、一時停止) | Accept | 肯定的な応答 (同意する、進む、確認する、開始する、はい) | Cancel | 否定的な応答 (拒否する、後退する、断る、停止する、いいえ)

省略可能なセット

また、ナビゲーションデバイスは、 オプションセット内のすべてのナビゲーションコマンド、一部、または何もサポートしていない場合もあります。これらはページング (上下左右)、スクロール (上、下、左、右)、コンテキスト (コンテキスト 1 から 4) のコマンドです。

コンテキストコマンドは、アプリケーション固有のコマンドとナビゲーションショートカットを明示的に目的としています。ページングおよびスクロールコマンドは、UI 要素のページまたはグループ間の迅速なナビゲーションと、それぞれ UI 要素内のきめ細かいナビゲーションを目的としています。

次の表は、これらのコマンドとその使用目的をまとめたものです。 | コマンド | 使用目的 | -----------:| ------------ | PageUp | 上方向にジャンプ (上側または垂直方向の前のページやグループに対して) | PageDown | 下方向にジャンプ (下側または垂直方向の次のページやグループに対して) | PageLeft | 左方向にジャンプ (左側または水平方向の前のページやグループに対して) | PageRight | 右方向にジャンプ (右側または水平方向の次のページやグループに対して) | ScrollUp | 上方向にスクロール (フォーカスが置かれた UI 要素またはスクロール可能なグループ内) | ScrollDown | 下方向にスクロール (フォーカスが置かれた UI 要素またはスクロール可能なグループ内) | ScrollLeft | 左方向にスクロール (フォーカスが置かれた UI 要素またはスクロール可能なグループ内) | ScrollRight | 右方向にスクロール (フォーカスが置かれた UI 要素またはスクロール可能なグループ内) | Context1 | 最初のコンテキストアクション | Context2 | 2 番目のコンテキストアクション | Context3 | 3 番目のコンテキストアクション | Context4 | 4 番目のコンテキストアクション

注ゲームは、実際の機能が使用目的と異なっているコマンドに対して自由に応答できますが、予期しない動作は避ける必要があります。特に、使用目的が必要な場合は、コマンドの実際の関数を変更しないでください。最も意味のあるコマンドに新しい関数を割り当て、対応する関数を PageUp/PageDown などの対応するコマンドに割り当ててみてください。最後に、各種類の入力デバイスでサポートされているコマンドと、それらがマップされるコントロールを検討し、すべてのデバイスから重要なコマンドにアクセスできるようにします。

Windows.Gaming.Input 名前空間でサポートされているすべての入力デバイスは、UI ナビゲーションデバイスです。

次の表は、ナビゲーションコマンドの 必要なセット がさまざまな入力デバイスにどのようにマップされるかをまとめたものです。

ナビゲーションコマンド	ゲームパッドの入力	アーケードスティック入力	レーシングホイールの入力
上へ	左サムスティックを上 / D パッドを上	スティックを上	方向パッド上
[下へ]	左サムスティックを下 / D パッドを下	スティックを下	方向パッド下
Left	左サムスティックを左 / D パッドを左	スティックを左	方向パッド左
Right	左サムスティックを右 / D パッドを右	スティックを右	方向パッド右
ビュー	View ボタン	View ボタン	View ボタン
メニュー	Menu ボタン	メニューボタン	Menu ボタン
同意する	A ボタン	アクション 1 ボタン	A ボタン
キャンセル	B ボタン	アクション 2 ボタン	B ボタン

次の表は、ナビゲーションコマンドの オプションセット がさまざまな入力デバイスにどのようにマップされるかをまとめたものです。

ナビゲーションコマンド	ゲームパッドの入力	アーケードスティック入力	レーシングホイールの入力
PageUp	左トリガー	サポートされない	状況に応じて異なる
PageDown	右トリガー	サポートされない	状況に応じて異なる
PageLeft	左バンパー	サポートされない	状況に応じて異なる
PageRight	右バンパー	サポートされない	状況に応じて異なる
ScrollUp	右サムスティック上	サポートされない	状況に応じて異なる
ScrollDown	右サムスティック下	サポートされない	状況に応じて異なる
ScrollLeft	右サムスティック左	サポートされない	状況に応じて異なる
ScrollRight	右サムスティック右	サポートされない	状況に応じて異なる
Context1	X ボタン	サポートされない	[X] ボタン (commonly)
Context2	Y ボタン	サポートされない	Y ボタン (commonly)
Context3	左サムスティック押下	サポートされない	状況に応じて異なる
Context4	右サムスティック押下	サポートされない	状況に応じて異なる

UI ナビゲーションコントローラーは論理入力デバイスですが、物理デバイスの表現であり、同じ方法でシステムによって管理されます。それらを作成または初期化する必要はありません。システムには、接続されている UI ナビゲーションコントローラーと、UI ナビゲーションコントローラーが追加または削除されたときに通知するイベントの一覧が表示されます。

UINavigationController クラスは、現在接続されている UI ナビゲーションデバイスの読み取り専用リストである静的プロパティ UINavigationControllers を提供します。接続されているナビゲーションデバイスの一部のみに関心がある場合があるため、 UINavigationControllers プロパティを使用してアクセスするのではなく、独自のコレクションを維持することをお勧めします。

次の例では、接続されているすべての UI ナビゲーションコントローラーを新しいコレクションにコピーします。

auto myNavigationControllers = ref new Vector<UINavigationController^>();

for (auto device : UINavigationController::UINavigationControllers)
{
    // This code assumes that you're interested in all navigation controllers.
    myNavigationControllers->Append(device);
}

UI ナビゲーションコントローラーが追加または削除されると、 UINavigationControllerAdded および UINavigationControllerRemoved イベントが発生します。これらのイベントのイベントハンドラーを登録して、現在接続されているナビゲーションデバイスを追跡できます。

次の例では、追加された UI ナビゲーションデバイスの追跡を開始します。

UINavigationController::UINavigationControllerAdded += ref new EventHandler<UINavigationController^>(Platform::Object^, UINavigationController^ args)
{
    // This code assumes that you're interested in all new navigation controllers.
    myNavigationControllers->Append(args);
}

次の例では、削除されたアーケードスティックの追跡を停止します。

UINavigationController::UINavigationControllerRemoved += ref new EventHandler<UINavigationController^>(Platform::Object^, UINavigationController^ args)
{
    unsigned int indexRemoved;

    if(myNavigationControllers->IndexOf(args, &indexRemoved))
	{
        myNavigationControllers->RemoveAt(indexRemoved);
    }
}

ユーザーとヘッドセット

各ナビゲーションデバイスをユーザーアカウントに関連付けて ID を入力にリンクしたり、ボイスチャットやナビゲーション機能を容易にするためにヘッドセットを接続したりできます。ユーザーとヘッドセットの操作の詳細については、「ユーザーとそのデバイスの追跡」と「ヘッドセット」を参照してください。

関心のある UI ナビゲーションデバイスを特定したら、そこから入力を収集する準備が整います。ただし、他の種類の入力とは異なり、ナビゲーションデバイスはイベントを発生させて状態変化を伝えません。代わりに、イベントをポーリングすることで現在の状態を定期的に読み取ります。

ポーリングによって、ナビゲーションデバイスの正確な時点のスナップショットがキャプチャされます。入力収集に対するこのアプローチは、ほとんどのゲームに適しています。そのロジックは通常、イベントドリブンではなく確定的なループで実行されるためです。また、一般に、一度に収集された入力からゲームコマンドを解釈する方が、時間の経過に伴って収集された多数の単一の入力からのコマンドよりも簡単です。

ナビゲーションデバイスをポーリングするには、 UINavigationController.GetCurrentReading; を呼び出します。この関数は、ナビゲーションデバイスの状態を含む UINavigationReading を返します。

auto navigationController = myNavigationControllers[0];

UINavigationReading reading = navigationController->GetCurrentReading();

ボタンの読み取り

各 UI ナビゲーションボタンは、押された (下向き)、または離された (上) かどうかに対応するブール値の読み取り値を提供します。効率を高める目的で、ボタンの読み取り値は個々のブール値として表されません。代わりに、これらはすべて、 RequiredUINavigationButtons および OptionalUINavigationButtons 列挙型によって表される 2 つのビットフィールドのいずれかにパックされます。

必須セットに属するボタンはUINavigationReading 構造体のRequiredButtonsプロパティから読み取られます。オプションセットに属するボタンは、OptionalButtons プロパティから読み取られます。これらのプロパティはビットフィールドであるため、関心のあるボタンの値を分離するためにビットごとのマスクが使用されます。対応するビットが設定されている場合、ボタンは押されます(下)。それ以外の場合はリリース (アップ)。

次の例では、 要求セットの [承諾] ボタン 押されているかどうかを確認します。

if (RequiredUINavigationButtons::Accept == (reading.RequiredButtons & RequiredUINavigationButtons::Accept))
{
    // Accept is pressed
}

次の例では、 要求セットの [承諾] ボタン を離すかどうかを決定します。

if (RequiredUINavigationButtons::None == (reading.RequiredButtons & RequiredUINavigationButtons::Accept))
{
    // Accept is released (not pressed)
}

オプションセット内のボタンを読み取る場合は、必ず OptionalButtons プロパティとOptionalUINavigationButtons列挙体を使用してください。

次の例では、 オプションセットの [コンテキスト 1] ボタン が押されているかどうかを確認します。

if (OptionalUINavigationButtons::Context1 == (reading.OptionalButtons & OptionalUINavigationButtons::Context1))
{
    // Context 1 is pressed
}

場合によっては、ボタンが押された状態から離されたボタンまたは離されたボタンに切り替えるタイミング、複数のボタンが押されているか離されているか、または一連のボタンが特定の方法で配置されているか、一部のボタンが押されていないかを判断する必要がある場合があります。これらの状態を検出する方法の詳細については、「ボタン移行の検出」および「複雑なボタン配置の検出」を参照してください。

InputInterfacingUWP サンプル (github)は、さまざまな入力デバイスが UI ナビゲーションコントローラーとしてどのように動作するかを示しています。

次の方法で共有