ビジュアル デバッグ

サーバをアクティブにする

World の VisualDebugServer をアクティブにするには、World::StartVisualDebug() を呼び出します。

サーバを設定する

VisualDebugServer をアクティブにする場合、VisualDebugServerConfig 設定オブジェクトを提供する必要があります。この設定オブジェクトには、必要に応じて設定できるいくつかのパラメータが含まれています。

最も重要な設定パラメータは、おそらくポートの設定である VisualDebugServerConfig::m_serverPort と VisualDebugServerConfig::m_broadcastPort です。この 2 つのパラメータは、サーバが入力接続をリッスンするのに使ったり、利用できることをブロードキャストするために使われるポートを決定します。ゲームに Navigation Lab を接続するのに問題がある場合は、これらのポートが開いていることを確認するか、ゲーム内および Navigation Lab の接続時に両方のパラメータを変更します。

サーバを取得する

World の VisualDebugServer を取得するには、World::GetVisualDebugServer() を呼び出します。

サーバを停止する

いつでも World::StopVisualDebug() を呼び出して、World の VisualDebugServer を停止できます。

コード例

「統合フェーズ 1d: ビジュアル デバッギングを設定する」、または Tutorial_VisualDebug.cpp ファイルを参照してください。

LOD を設定する

オブジェクトの SetCurrentVisualDebugLOD() メソッドを呼び出すことで、いつでも任意のオブジェクトに LOD を設定できます。次のいずれかのレベルを渡すことができます。

• VisualDebugLOD_None: オブジェクトに関するデータは Navigation Lab に送信されません。
• VisualDebugLOD_Default: ビジュアル デバッグ情報のデフォルト レベルが送信されます。
• VisualDebugLOD_Maximal: オブジェクトに関する追加データに対する追加表示リストが内部的に作成されて Navigation Lab に送信されます。

シェイプとボリューム

ScopedDisplayList クラスの API は、さまざまな共通のシェイプとボリュームを作成するためのメソッドを提供します。

視覚的な凡例としては、Navigation Lab のコマンド ラインに次のコマンドを入力します。

ToggleDrawAllShapes

ライフスパン

作成するすべての ScopedDisplayList は、それを作成したフレームの後で、Navigation Lab に 1 回だけ送信されます。ただし、各表示リストには、Navigation Lab でそのデータが表示される期間を決定するライフスパンが含まれています。

単一フレームのライフスパンの表示リストは、Navigation Lab がゲームからその表示リストを受信すると 1 回だけレンダリングされます。単一フレーム表示リストのデータを、Navigation Lab で複数フレームに渡って表示するには、新しい ScopedDisplayList オブジェクトを各フレームで作成し直す必要があります。この方法は通常、頻繁に変更されるデータに使用されます。例:

{
    Kaim::ScopedDisplayList displayList(navWorld);
    displayList.InitSingleFrameLifespan("Display list name", "Category name");
    displayList.PushLine(gameBot->GetPosition(), Kaim::Vec3f::Zero(), Kaim::VisualColor::White);
    ... // Add more shapes here
} // Here the ScopedDisplayList is sent to the Navigation Lab.

複数フレーム ライフスパンの表示リストも Navigation Lab に 1 回送信されますが、それ以降は修正または削除されるまですべてのフレームでレンダリングされます。ゲームプレイ セッションを通じてずっと変化のないデータがある場合、この方法を使用すると、各フレームで表示リストを再作成する計算をする必要がなくなり、各フレームで表示リストを再送信するのにかかわるネットワーク帯域幅を節約できます。

複数フレーム ライフスパンの表示リストは、指定したカテゴリ名と表示リスト名の組み合わせ、または DisplayListManager によって生成された数値 ID により一意に識別されます。

• 一意の ID を指定せずに、または無効な ID (KyUInt32MAXVAL)を指定して表示リストを初期化した場合、DisplayListManager が有効な ID を自動的に生成して返します。
• または、DisplayListManager::GenerateDisplayListId() メソッドを呼び出して有効な数値 ID を事前生成することもできます。

このカテゴリと名前の組み合わせ、または一意の ID を使用して、修正または削除が必要なときに表示リストを識別することができます。

• 複数フレームの ScopedDisplayList を修正するには、元の ScopedDisplayList に以前割り当てられていたのと同じカテゴリと名前を持つ、または同じ一意の ID を持つ、新しい ScopedDisplayList オブジェクトを作成します。
• 複数フレームの ScopedDisplayList を削除するには、DisplayListManager::RemoveDisplayList() メソッドを呼び出して ScopedDisplayList に以前割り当てられていたカテゴリと名前、または一意の ID を渡します。

たとえば、一意の ID を明示的に使用します:

// Get a unique ID
m_displayListId = navWorld->GetDisplayListManager()->GenerateDisplayListId();

// Create a ScopedDisplayList:
{
    Kaim::ScopedDisplayList displayList(navWorld);
    m_displayListId = displayList.InitUserControlledLifespan("Display list name", "Category name", m_displayListId);
    displayList.PushLine(gameBot->GetPosition(), Kaim::Vec3f::Zero(), Kaim::VisualColor::White);
    ... // Add more shapes here
} // Here the ScopedDisplayList is sent to the Navigation Lab and rendered every frame.

...

// Modify the existing ScopedDisplayList:
{
    Kaim::ScopedDisplayList displayList(navWorld);
    m_displayListId = displayList.InitUserControlledLifespan("Display list name", "Category name", m_displayListId);
    ... // Add different shapes here
} // Here the ScopedDisplayList is sent to the NavigationLab, replacing the previous display list.

...

// Remove the existing ScopedDisplayList:
{
    navWorld->GetDisplayListManager()->RemoveDisplayList(m_displayListId); // The list is no longer displayed in the Navigation Lab.
}

Navigation Lab での表示リストの表示と非表示

Navigation Lab は、ゲーム内のフレームのデータを表示するたびに、Visual debug パネルの Display lists という見出しの下に、そのフレームで有効なすべての表示リストを、表示リストに提供されたカテゴリ名別に一覧表示します。これらのコントロールを使用して、3D ビュー内の各表示リストの表示/非表示を切り替えることができます。

たとえば、次のイメージでは、"MeleeCombat" はカテゴリ名であり、"MeleeDistance"、"MeleeEdgeCollector"、"MeleeTarget"、"VisitedTriangles" などの異なる表示リスト名を持つ表示リストに対して設定されています。これらの各表示リストには専用のチェックボックスがあり、共有カテゴリ名で整理されています。

表示リストと WorldElement を関連付ける

ScopedDisplayList は、Bot や動的障害物などの特定の WorldElement と関連付けることができます。表示リストを WorldElement と関連付けると、そのオブジェクトに関連する情報の他の項目の変化に従って、Navigation Lab 内の表示リストのレンダリングをコントロールできます。

WorldElement を ScopedDisplayList と関連付けるには、GetVisualDebugId() メソッドを呼び出して WorldElement オブジェクトの ID を取得し、ScopedDisplayList の初期化でその ID を指定します。また、カテゴリ名を指定することができます。このカテゴリ名は Visual debug パネル内でその WorldElement の表示リストを整理するために使用されます。

前のセクションで説明したように、ユーザにコントロールされるライフスパンを持つ表示リストでは、カテゴリ名と表示名を組み合わせることによって、または一意の ID を明示的に指定することによって、表示リストを特定することができます。

例:

KyUInt32 worldElementId = m_gameBot->GetVisualDebugId();
displayList.InitSingleFrameLifespan("Display list name", "Category name", worldElementId);

または

KyUInt32 worldElementId = m_gameBot->GetVisualDebugId();
m_displayListId = displayList.InitUserControlledLifespan("Display list name", "Category name", worldElementId, m_displayListId);

コード例

「統合フェーズ 1e: Visual Debugger にデータを送信する」を参照してください。