| Inheritance |
このクラスは、Houdiniネットワークノードではなくて、 ディペンデンシーグラフノード を参照していることに注意してください。
Nodeオブジェクトには、ワークアイテムにアクセスしたり、ノードをDirty(変更あり)としてマークしたり、ノードを実行したり、ノードグラフを走査するためのメソッドが備わっています。
メソッド ¶
addDependency(dependency_type, dependency_key)
指定したタイプとキーを持つ外部ディペンデンシーをノードに追加します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.addDependencyをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
addFileDependency(dependency_key)
指定したキーを持つファイルディペンデンシーをノードに追加します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.addiFileDependencyをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
addEventHandler(handle, filter=pdg.EventType.All, pass_handler=False)
→ pdg.PyEventHandler
受信するイベントのタイプの値を使って、イベントハンドラーをノードに追加します。
handler引数には、pdg.Eventタイプの引数を受け取るコール可能オブジェクトを指定します。
pass_handlerがTrueの場合、ハンドラー自体が1番目の引数として関数に渡されます。
Falseの場合、イベントオブジェクトのみが関数に渡されます。
addEventHandler(handle, event_types:
pdg.EventType, pass_handler=False)
→ pdg.PyEventHandler
受信するイベントのタイプのリストを使って、イベントハンドラーをノードに追加します。
handler引数には、pdg.Eventタイプの引数を受け取るコール可能オブジェクトを指定します。
pass_handlerがTrueの場合、ハンドラー自体が1番目の引数として関数に渡されます。
Falseの場合、イベントオブジェクトのみが関数に渡されます。
addParameter(port_name, port_label, port_tag, data_type, port_size)
カスタムパラメータをノードに追加します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.addParameterをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
cancel()
#cppname PDG_Node::cancel
このノード内でクック中のワークアイテムとまだスケジュールに組まれていない今後のワークアイテムをキャンセルします。 同じノードグラフ内の他のノードは影響を受けませんが、このノード内のワークアイテムに依存する下流のワークアイテムも間接的にキャンセルされます。
connect(port_name, dst_node_name, dst_port_name)
他のノードをこのノードに接続します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.connectをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
cook(block)
→ bool
ノードをクックします。blockは、そのクックがCallerをブロックするのか、そのクックを非同期にするのか決定します。
成功するとTrueを返します。
cookError(message)
このノードのクックエラーを発生させます。
cookWarning(message)
このノードのクック警告を発生させます。
dirty(remove_outputs)
ノードをDirty(変更あり)としてマークし、そのすべてのワークアイテムを削除します。
remove_outputsをTrueにすると、ワークアイテムの出力ファイルがディスク上から削除されます。
PDGグラフがアクティブにクックされている時にノードをDirtyにするのは無効です。
disconnect(port_name, dst_node_name, dst_port_name)
他のノードをこのノードから接続解除します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.disconnectをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
nodeOptions(force_update)
ノードの現行pdg.NodeOptionsを返します。
force_updateがTrueの場合、それらのオプションは、ノードのonConfigureNodeコールバックを使って再生成されます。
outputFiles(localize)
→ list
of pdg.File
ノードのすべてのワークアイテムから集約した出力ファイルリストをpdg.Fileオブジェクトのリストとして返します。
prepareDirty()
→ pdg.WorkItemDirty
ノードのワークアイテムとその依存関係をDirty(変更あり)にする準備をしますが、その操作をそのノードに適用しません。 代わりに、そのDirty操作は後でそのノードに適用できるようにpdg.WorkItemDirtyインスタンスに格納されます。
removeEventHandler(handler)
ノードからイベントハンドラーを削除します。
removeAllEventHandlers()
ノードからすべてのイベントハンドラーを削除します。
removeDependency(dependency_key)
外部ディペンデンシーをこのノードから削除します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.removeDependencyをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
resultData(localize)
→ list
of pdg.File
このメソッドは廃止されました。代わりにpdg.Node.outputFilesを使用してください。
reserveIndexBlock(num_indices)
→ int
num_indicesの数だけ連続するワークアイテムインデックスを確保し、そのリスト内の最初のインデックスを返します。
このメソッドは、上流のワークアイテムデータに基づいてワークアイテム数が可変する動的ノードを実装する時に役立ちます。
このメソッドは、すべてのインデックスが生成された場合にのみ動作します。
つまり、ワークアイテムを追加するコールが実際にその確保された範囲内の値を使用するかどうかはノード作成者次第です。
setExpression(name, expression, index=0)
指定したnameのパラメータにPythonexpression文字列を設定します。
このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setExpressionをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setExpressions(dict)
パラメータ名とエクスプレッション文字列をマッピングした辞書を使用して、このノードに複数のパラメータエクスプレッションを設定します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setExpressionsをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setParameter(name, value, index=0)
指定したnameのパラメータに、指定した値またはエクスプレッションを設定します。
このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setParameterをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setParameters(dict)
パラメータ名と値またはエクスプレッション文字列をマッピングした辞書を使用して、このノードに複数のパラメータ値を設定します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setParametersをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setScheduler(scheduler_name)
このノードにスケジューラを設定します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setSchedulerをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setValue(name, value, index=0)
指定したnameのパラメータにvalueを設定します。
このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setValueをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
setValues(dict)
パラメータ名と値をマッピングした辞書を使用して、このノードに複数のパラメータ値を設定します。 このメソッドは、ノードの名前を最初の引数としてpdg.GraphContext.setValuesをコールすることと同じ効果を持っています。
Warning
このメソッドは、TOPを使用して作成されたPDGノードに対してコールしないでください。 ノードパラメータと接続を制御する場合は、代わりにhou.TopNodeのメソッドを使用してください。
isCooked
: bool
Property
ノードがクックされるとTrueに設定されます。
loopDepth
: int
Property
このノードがループブロックの中にある場合、その入れ子ループの深さを返します。そうでない場合、-1を返します。
partitions
: list
of pdg.WorkItem
Property
ノードがパーティショナーの場合、そのノードに保存されているパーティションのリスト。
regenerateReason
: pdg.regenerateReason
Property
このノードがワークアイテムを再生成している場合、このプロパティは、それが再生成された理由を示した列挙値を返します。
scheduler
: pdg.SchedulerBase
Property
ノードのカスタムスケジューラ。このノードにカスタムスケジューラがない場合、pdg.GraphContextのデフォルトのスケジューラが返されます。
serviceName
: str
Property
このノード内のワークアイテムで使用されているサービスの名前。 この値は、サービスパラメータとこのノードを含むアクティブなサービスブロックから取得されます。
workItems
: list
of pdg.WorkItem
Property
このノード上の静的ワークアイテムと動的アイテムの両方の通常のワークアイテムすべてのリスト。
Methods from pdg.NodeInterface ¶
default(parameter_name)
→ int
, float
or str
指定したパラメータのデフォルト値を返します。
inputsForNode(other_node)
→ list
of pdg.Port
指定したノードに接続されているこのノードのポート(s)を返します。何も接続されていない場合、空っぽのリストを返します。
inputsForWorkItem(work_item)
→ list
of pdg.Port
指定したワークアイテムを所有しているノードに接続されているこのノードのポート(s)を返します。 何も接続されていない場合、空っぽのリストを返します。
isItemFromPort(work_item, port_name)
→ bool
指定したport_nameの入力ポートからの入力としてそのワークアイテムが渡されている場合はTrueを返します。
そうでない場合はFalseを返します。
port(port_type, number)
→ pdg.Port
指定したpdg.portTypeとポート番号のポートを返します。
portCount()
→ int
インターフェース上のポイントの数を返します。
value(parameter_name)
→ int
, float
or str
指定したパラメータの定数値を返します。
attributeInfo
: pdg.AttributeInfo
Property
このPDGノードのアトリビュート情報オブジェクトを返します。
scriptInfo
: pdg.JobScriptInfo
Property
このPDGノードで使用されているジョブスクリプトに関する情報を返します。
topNodeId
: int
Property
このPDGノードに関連付けられているhou.TopNodeの固有セッションID。