このコールバックは、プロセッサ系ノードが新しいワークアイテムを生成する度に評価されます。 pdg.WorkItemHolder引数は、そのノード内で新しいワークアイテムを生成する際に使用されるファクトリーオブジェクトです。 コールバックが成功を返さない限り、そのワークアイテムはそのプロセッサ系ノードまたはPDGグラフに追加されません。 このコールバックが失敗すると、コールバックの途中まで評価されて生成されたすべてのものが削除されます。

addWorkItemメソッドを使用すると、ワークアイテムをホルダーに追加することができます。このメソッドには、キーワード引数のリストまたはpdg.WorkItemOptionsヘルパーオブジェクトを渡すことができます。 これらの引数は、ネットワークアイテムの名前、インデックス、タイプを設定する際に使用されます。 pdg.WorkItemOptions APIドキュメントに載っている各エントリーも同じ名前を使ってキーワード引数として渡すことができます:

# オプションの使い方:
options = pdg.WorkItemOptions()
options.name = "example"
options.inProcess = True
item_holder.addWorkItem(options)

# kwargsの使い方:
item_holder.addWorkItem(name="example", inProcess=True)

addWorkItemメソッドは、新しいワークアイテムを返すので、コールバックコードでアトリビュート値またはワークアイテムのコマンドラインを設定することができます:

new_item = item_holder.addWorkItem()
new_item.setStringAttrib('example_attrib', 'example value')
new_item.setCommand('echo "hello"')

ノードに何も入力がなかった場合、コールバックに渡される上流ワークアイテムのリストには、何のワークアイテムも入りません。 ノードに入力ノードがあった場合、そのノードが動的であればそのリストには1個のワークアイテムが、静的であればそのリストには上流ワークアイテムの全リストが入ります。 最後に、generation_type引数は、ワークアイテムを生成する際に、そのコールバックを静的ノードまたは動的ノードのどちらに対してコールするのかを決めます。 pdg.generationTypeは、そのコールバック関数に渡された列挙の詳細をリストします。

このコールバックは、ノードが既存のワークアイテムを持っていて、且つ、最後のクックからパラメータに変更があった時に静的クックプロセス中にコールされます。 このコールバックによって、ノードがワークアイテムをDirty(変更あり)、削除、修正したり、新しいワークアイテムを追加する機会が得られます。 デフォルトでは、どのノードもonGenerateフックのコールによってワークアイテムを再生成してマージする標準ビルトインの実装を持っています。 たいていの場合、あなたのノードが外部リソースを使ってワークアイテムを生成している場合にのみこのコールバックを実装する必要があります。 例えば、File Patternノードは、特定のパターンに合致したファイル毎にワークアイテムを作成するので、このコールバックでは、ディスク上のファイルのタイムスタンプと存在の有無をチェックする独自の再生成ロジックを定義します。

このコールバック関数の引数はonGenerateと同様ですが、追加のexisting_itemsリストには、このノード内に既に存在している静的ワークアイテムのリストを格納します。

このメソッドは、onGenerateコールバック時に生成されたワークアイテム間に兄弟/内部依存関係を追加する時にコールします。 これらは、同じノード内のワークアイテム間に存在する依存関係です。 このコールバックの入力は、最後のonGenerateコールバックで生成されたワークアイテムのリストです。

PDGは、これらの依存関係すべてがクックされた時にのみワークアイテムをクックするので、あなたのノードが特定の順番で完了させる必要のあるワークアイテムを生成する場合には、内部依存関係の追加が役に立ちます。 例えば、フィードバックループブロックの開始ノードは、ループ内の反復間で内部依存関係を追加します。

このコールバックは、クック中に評価されるすべてのノードに対して、そのクックの開始時点で1度コールされます。 このコールバックは、onGenerateコールバックの前にコールされ、そのノードが共有リソースを読み込んだり、変数を初期化する機会が得られます。

このコールバックは、最後のワークアイテムがクックを完了した後に、クック中にアクティブだったすべてのノードに対して1度コールされます。 このコールバックによって、ノードがクック中に使用した共有リソースをアンロードする機会が得られます。

このコールバックは、そのノード内の各ワークアイテムがクックのスケジュールに組まれる直前に1度コールされます。 このメソッドは、PDGがディスク上のキャッシュファイルをチェックする前にコールされるので、キャッシュ化の用途で必要な出力ファイルを追加する手段として使用することができます。 他にも、出力ファイルやワークアイテムの依存関係のアトリビュートにアクセスしたり、ワークアイテムのコマンドラインを変更したり、ワークアイテムをクックする直前に必要な処理を行う時にも使用することができます。 このメソッドがpdg.result.Failureを返すと、そのワークアイテムは失敗としてマークされます。

ROP Fetchノードは、分散シミュレーションを走らせる際にこのコールバックを使用することで、sim trackerが起動していることを確認し、シミュレーションワークアイテムをクックする前にトラッカー情報をそのシミュレーションワークアイテムに渡します。 ROP Fetch内のワークアイテムは、静的ワークアイテムとして生成することができ、クックを開始するまではsim trackerのポート/IPが分からないので、 このコールバックを使用して、シミュレーションワークアイテムにそのトラッカーの詳細を追加します。

onPrepareTaskコールバックは、バッチワークアイテム自体だけでなく、そのバッチ内のサブワークアイテム毎にコールされます。 コールバック呼び出しの順序は、バッチワークアイテムのアクティベーションモードによって異なります。 バッチのアクティベーションモードがpdg.batchActivation.Allに設定されていれば、PDGは、バッチの実行をするスケジュールが組まれる直前に、サブワークアイテム毎にonPrepareTaskフックを実行してから、そのバッチワークアイテム自体にonPrepareTaskフックを実行します。 アクティベーションモードが他のオプションのどれかに設定されていれば、このコールバックは、サブワークアイテム毎にそのサブワークアイテムの依存関係がすべて完了した後でコールされます。 このコールバックは、バッチの実行準備が整った時にバッチワークアイテム自体に対して実行されます。 つまり、バッチがpdg.batchActivation.Firstに設定されていると、onPrepareTaskコールの順序に保証がありません。 このコールバックは、サブワークアイテムのコール間でバッチワークアイテムに対してコールすることもできます。

このコールバックは、In-Processワークアイテムがクックを必要とした時にコールされます。 これは、In-Processワークアイテムとして明示的に生成されたワークアイテムに対してのみ実行されます。 In-Processワークアイテムは、onGenerateコールバック時にinProcess=True`引数を渡してワークアイテムをワークアイテムホルダに追加することで生成されます。 このコールバックは、ワークアイテムをクックする上で必要となるIn-Processロジックを実行するだけでなく、ワークアイテムにアトリビュートを書き出したり、出力結果を取り付けることもできます。 このコールバックは、メインHoudiniプロセス内でバックグラウンドスレッド上で実行されます。

Python Scriptノードは、 Evaluate In Process が有効に設定されていると、このコールバックを使ってスクリプトを実行します。

このコールバックは、ワークアイテムがクックに成功した時、且つ、下流ノードがそのワークアイテムから何かを生成する前にコールされます。 これを使用することで、そのワークアイテムの出力ファイルまたはアトリビュートを検証したり、クック中に生成された出力ファイルに基づいてアトリビュートに変更を加えることができます。 このコールバックは、そのワークアイテムがIn-Processでクックされていなかった場合でも実行されます。 このコールバックがpdg.result.Failureを返すと、そのワークアイテムは失敗としてマークされます。

このコールバックは、pdg.WorkItem.setIsPostCookメソッドを使ってポストクックロジックを実行する必要性があるものとしてワークアイテムがマークされた場合にのみコールされます。

これは、TOPs用途特有のUIコールバックです。 TOPs UI内でワークアイテムを選択する時、ワークアイテムが選択された後でこのフックが実行されます。 例えば、これをWedgeノードで使用することで、ワークアイテムパラメータ値をシーンに出すことができます。 他にも、独自の視覚化ロジックを実行することができます。

このコールバックは、onSelectコールバックの反対です。 TOPs UIでワークアイテムが選択解除される度に実行されます。 例えば、Wedgeノードは、このコールバックを使用して、選択解除時にパラメータ値を元の値に復元します。