ShotGrid Server Begin TOP node

持続型ShotGridコマンドサーバーを起動します。

On this page	Top_attributes パラメータ
Since	18.0

このノードを使用することで、ShotGrid Serverワークアイテムを作成することができます。このノード内のセッションワークアイテムは、持続型ShotGridプロセスに関連付けられます。

Note

ShotGrid APIはHoudiniには用意されていませんので、手動でインストールする必要があります。

ShotGrid APIをインストールするには、以下の手順を踏んでください:

https://github.com/shotgunsoftware/python-api/releasesから最新リリースをダウンロードして解凍します。
shotgun_api3フォルダをHoudiniのPythonパスの場所にコピーします。この場所はコマンドプロンプトまたはターミナルから以下のコマンドを叩くことで調べることができます: Houdiniのコマンドプロンプトではhython -c 'import sys; print(sys.path)'、HoudiniのPythonシェルではimport sys; print(sys.path)です。

ShotGridで認証を通すためには、以下の3つの方法のどれかが必要です。

Note

ShotgunはShotGridという新しい名前に変わりましたので、既存の$PDG_SHOTGUN_*環境変数とshotgun.jsonは今後のリリースで廃止されます。それぞれShotGridに名前を変更した$PDG_SHOTGRID_*、shotgrid.jsonに移行してください。

$HOUDINI_USER_PREF_DIRまたは定義した$PDG_SHOTGRID_AUTH_DIR内に以下の構文でshotgrid.jsonファイルを作成します:

{ “script_name”: “”, “api_key”: “” }
$HOUDINI_USER_PREF_DIRまたは定義した$PDG_SHOTGRID_AUTH_DIR内に以下の構文でshotgrid.jsonファイルを作成します:

{ “session_token”: “” }
$PDG_SHOTGRID_LOGIN環境変数と$PDG_SHOTGRID_PASSWORD環境変数を定義します。
$PDG_SHOTGRID_SCRIPT_NAME環境変数と$PDG_SHOTGRID_API_KEY環境変数を定義します。
$PDG_SHOTGRID_SESSION_TOKEN環境変数を定義します。

認証の優先順位は、$PDG_SHOTGRID_LOGIN、$PDG_SHOTGRID_SCRIPT_NAME、$PDG_SHOTGRID_SESSION_TOKENの順で、それらがなければ次にshotgrid.jsonを検索してそれを使用します。つまり、環境変数でオーバーライドを指定できるようになっています。

環境変数内に認証情報を公開するのはセキュリティ的に危険なので、shotgrid.jsonの使用を推奨します。

コマンドチェーンの使い方の詳細は、コマンドサーバーを参照してください。

TOP Attributes ¶

loopiter

[int]

このアトリビュートは、Feedback Beginノードから継承されます。

これは、ループに関連付けられた一連のワークアイテムをループさせる反復回数です。入れ子のフィードバックループを使用する時は、レベル毎に反復回数を指定したいので、このアトリビュートには配列値を指定することができます。一番外側のループのループ反復値はloopiter[0]に格納し、次のレベルはloopiter[1]にといったように格納します。

loopnum

int

このアトリビュートは、Feedback Beginノードから継承されます。

ワークアイテムがどのループに関連しているのかを追跡します。このアトリビュートは、同じFeedback Beginノード内で複数の独立したループを生成させる時に関係します。例えば、Wedgeノードを使ってFeedback Beginノードを駆動させる時です。

loopsize

int

このアトリビュートは、Feedback Beginノードから継承されます。

このアトリビュートは、ループの合計の反復回数です。

パラメータ ¶

Work Item Generation

Generate When

このノードがワークアイテムを生成するタイミングを決めます。このノードがどの生成モードを必須にしているのか、もしくは、ワークアイテムを動的に生成させる必要があるのかどうか分からないのであれば、通常では、これを“Automatic”のままに設定してください。

All Upstream Items are Generated

このノードは、すべての入力ノードが自身のワークアイテムを生成した時にワークアイテムを生成します。

All Upstream Items are Cooked

このノードは、すべての入力ノードが自身のワークアイテムをクックした時にワークアイテムを生成します。

Each Upstream Item is Cooked

このノードは、入力ノード内のワークアイテムがクックされる度にワークアイテムを生成します。

Automatic

入力ノードの生成モードに基づいて生成モードが選択されます。入力ノードのどれかがその入力のクック時にワークアイテムが生成されている場合、このノードには Each Upstream Item is Cooked が設定されます。そうでない場合、 All Upstream Items are Generated が設定されます。

Session Count from Upstream Items

このトグルを有効にすると、このノードは、上流のワークアイテム毎に、単一サーバーワークアイテムとそのサーバー付きセッションを作成します。無効にすると、上流のワークアイテム毎にサーバーアイテムが作成されます。

Number of Sessions

サーバーと一緒に作成するセッションの数。各セッションワークアイテムは、同じサーバーを使って他のセッションワークアイテムと直列でクックされます。このノードからCommand Server Endノードまでの一連のセッションワークアイテムは、クックを完了した後に次のセッションを開始します。

Server Port

サーバーと通信するTCPポート番号( Connect To Existing Server が無効な時)、 または 、既存サーバーに接続する際に使用するポート番号( Connect To Existing Server が有効な時)。デフォルト値の0は、システム側に未使用ポートを動的に選択するように伝えます。通常では、これがあなたの求めている挙動でしょう。そのポート番号を特定の範囲内に維持したい(ポート番号が利用できることを保証したい)場合、ここには9000 + @pdg_indexのようなエクスプレッションを使用することができます。

Copy Inputs For

入力ファイルをループアイテムにコピーさせる方法を決定します。デフォルトでは、上流のファイルがすべての入力ファイルにコピーされますが、1回目のループだけ入力ファイルをコピーすることも何もコピーしないこともできます。

No Iterations

上流の入力ファイルをどのループ反復アイテムの出力にもコピー しません 。

First Iteration

上流の入力ファイルを1回目のループのみの出力ファイルリストにコピーします。

All Iterations

上流の入力ファイルをすべてのループの出力ファイルリストにコピーします。

Cook Loops Sequentially

このトグルを有効にすると、このノードで作成されたループは、1度に1ループで順々に完了させてクックします。このトグルを無効にすると、独立したループは並列でクックすることができます。

Feedback Attributes

有効にすると、各反復の終了時点における指定されたアトリビュートが、次の反復の開始時点での該当するワークアイテム上にコピーされます。これは、ワークアイテムが次の反復のクックを開始する直前に行なわれます。

Tip

フィードバックさせたいアトリビュート(s)は、スペース区切りのリストまたはアトリビュートパターン構文を使用して指定することができます。アトリビュートパターンの記述の方法の詳細は、アトリビュートパターン構文を参照してください。

Feedback Output Files

有効にすると、各反復の出力ファイルが次のループの反復の開始時点での該当するワークアイテム上にコピーされます。これらのファイルはそのワークアイテムの出力として追加されるので、ループ内のワークアイテムの入力として利用可能になります。

Server Configuration

Server Type

このノードがサービスまたはShared Serverを使用するブロックを作成するかどうかを決めます。

Note

Shared ServerはHoudini20.0で廃止されました。

Service Name

Server Type が Service に設定されている時、このパラメータは、ブロック内のワークアイテムに使用するサービスの名前を決めます。

Reset Service

Determines whether or not service clients should be reset before executing work items. If this node is a service block, the reset operation is only performed once per block loop. Otherwise, the reset operation occurs for each work item in this node.

None

The service client is used as-is. This means that any imported modules, global variables, or scene state are preserved between work item cooks.

Reset Client

The service client is sent the “reset” command, which clears state but does not restart the service process.

Restart Client

The service client process is completely restarted before running a work item.

Connect to Existing Server

このトグルを有効にすると、ワークアイテムは、新しいサーバーを起動せずに、既存サーバーに接続されます。

Server Address

Connect to Existing Server が有効な時のその既存サーバーアドレス。

Load Timeout

共有サーバーインスタンスに到達可能であるかどうかを初期検証する時に使用するタイムアウト。通信に成功せずにこのタイムアウトが過ぎると、そのサーバーのワークアイテムが失敗としてマークされます。