コントロールリグをデバッグする

コントロールリグのデバッグ ツールを使用すると、コントロールリグ グラフ内の問題を検出して、修正できます。

Choose your operating system:

Windows

macOS

Linux

コントロールリグのデバッグ ツールを使用すると、リグの動作を評価して、リグ グラフ内の問題に対処することができます。このドキュメントでは、このツールの概要について説明します。

前提条件

デバッグ モード

ブループリントのデバッグと同様に、デバッグ モード を使用して、コントロールリグ グラフをデバッグすることができます。このモードを使用すると、ノードにブレークポイントを追加して、グラフ ロジックをステップ実行し、グラフの任意のポイントでプロパティのライブ値を調べることができます。

デバッグ モードを有効にするには、コントロールリグ ツールバーの [ReleaseMode] をクリックします。このボタンは、デバッグ モードと リリース モードを切り替えます。

control rig debug mode

デバッグ モードは、 Solve Direction コンテキストをサポートしており、Forwards SolveBackwards SolveSetup Event のどれを評価しているかに応じて適用されます。

ブレークポイント

ノード グラフをデバッグする際に、ブレークポイントを使用して、指定されたノードでグラフの評価を停止して、後続のノードをステップ実行することができます。これにより、ビューポート内のブレークポイントより前に評価されたグラフの一部を一時的にプレビューすることができます。ブレークポイントを使用すると、評価がグラフの最後に達するまで時間が進まないため、蓄積された時間のノードの結果は変わりません。

選択したノードでグラフの評価を一時停止するブレークポイントを追加するには、Rig Graph ノードを右クリックして、[Add Breakpoint (ブレークポイントを追加)] を選択します。ブレークポイントを追加すると、デバッグ モードが有効になってない場合は、自動的に有効になります。

control rig breakpoint

ブレークポイントを指定したら、ステップ ツールバー ボタンを使用して、ノードごとにグラフの評価をステップ実行します。コントロールリグは、ブレークポイントまたは現在評価されているノードまでしか評価を行いません。

control rig node step

ステップ ボタンは、次の機能を実行します。

名前

アイコン

説明

Resume (再開)

resume

ブレークポイントで停止した状態から、実行を再開します。この実行は、他のブレークポイントが出現すると停止します。

Focus (フォーカス)

focus

現在デバッグ中のノードのグラフ ビューにフォーカスします。

Step Next (次にステップ)

step node

ブレークポイントで停止している場合、評価の次のノードにデバッグのフォーカスを進めます。

Step Into Function (関数にステップ)

step in next

ブレークポイントで停止している場合、評価の次のノードにデバッグのフォーカスを進めます。次のノードが関数または折りたたまれたグループに含まれている場合、ビューがその関数に進み、そのグループの最初のノードをフォーカスします。

Step out of Function (関数からのステップ アウト)

step out next

ブレークポイントで停止している場合、評価の次のノードにデバッグのフォーカスを進めます。現在のノードが関数または折りたたまれたグループ内に含まれており、次のノードが関数またはグループ外にある場合、グラフ ビューはグループ外の次のノードにフォーカスするように変更されます。

プロパティの監視

デバッグ時に、リアルタイムに更新された値を表示するように各グラフ ノードのプロパティ値を設定できます。これを有効にするには、リアルタイムに更新したいノードのピンを右クリックして、[Watch this value (この値を監視)] を選択します。

control rig property watch

プロパティが監視されていると、ノードの上部に値情報が表示され、プロパティの横に監視中であることを示すアイコンが表示されます。

control rig property watch

プロパティのデバッグを停止するには、ピンを右クリックして、[Stop watching this value (この値の監視を停止)] を選択します。

control rig property watch

クラス設定のデバッグとプロファイリング

[Class Settings (クラス設定)]の [Details (詳細)] パネルには、グラフのパフォーマンスをデバッグするためのツールやプロパティがあります。このパネルを表示するには、[Class Settings] をクリックします。

control rig class settings

[Show Node Run Counts (ノード実行カウントを表示)] を有効にすると、ノードが実行された回数が表示されます。これは、ループ ノードやコレクション ノードが正しく実行されているかどうかを判断するうえで役立ちます。

control rig show node run count

VM プロファイリング

仮想マシン プロファイリング (VM プロファイリング) は、リアルタイムのグラフのパフォーマンスやノードの実行速度をデバッグするためにも使用することができます。

[VMRuntime Settings (VMRuntime 設定)] カテゴリの [Enable Profiling (プロファイリングの有効化)] をクリックして、リグ グラフのプロファイリングを開始します。Min Duration Color プロパティと Max Duration Color プロパティは、どのノードが実行時間が最も短いか長いかをマイクロ秒単位で表示するために使用されます。また、ノードの横に合計マイクロ秒数 (μs) も表示されます。

control rig vm profiling

実行スタック

[Execution Stack (実行スタック)] パネルでは、グラフ内のノードの操作順のリファレンスを提供します。これを使用して、ノードのデバッグとイベントのシーケンスの評価ができます。

[Execution Stack] パネルは、コントロールリグのメニュー バーに移動して、[Window (ウィンドウ)] > [Execution Stack] を選択すると、開くことができます。

execution stack

開くと、[Execution Stack] パネルでは以下の情報を表示します。

execution stack

  1. ノード列。すべてのノードを特定のソルブ方向からの評価する順序を表示します。ここでノードをダブルクリックすると、そのノードのリグ グラフ ビューが構成されます。リグ グラフでノードを選択すると、そのノードに関連付けられている命令もハイライトされます。

  2. ノード実行回数。そのノードが実行された回数を表示します。これは、Class Settings (クラス設定)[Show Node Run Counts] が有効になっている場合にのみ表示されます。

  3. マイクロ秒数プロファイリング が有効になっている場合、ノードの実行にかかった合計時間をマイクロ秒 (μs) 単位で表示します。