Inheritance |
|
メソッド ¶
isFeedbackAttribs
: True
Property
フィードバックノードがイテレーション間でアトリビュートをフィードバックするように設定されていれば、True
に設定されます。
isFeedbackFiles
: True
Property
フィードバックノードがイテレーション間で出力ファイルをフィードバックするように設定されていれば、True
に設定されます。
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。
Methods from pdg.Node ¶
addDependency(dependency_type, dependency_key)
Adds an external dependency to the node with the specified type and key. This method has the same effect as calling pdg.GraphContext.addDependency with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
addFileDependency(dependency_key)
Adds a file dependency to the node with the specified key. This method has the same effect as calling pdg.GraphContext.addiFileDependency with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
addEventHandler(handle, filter=pdg.EventType.All, pass_handler=False)
→ pdg.PyEventHandler
受信するイベントのタイプの値を使って、ノードにイベントハンドラーを追加します。
handler
引数には、pdg.Eventタイプの引数を受け取るコール可能オブジェクトを指定します。
pass_handler
がTrueの場合、ハンドラー自体が1番目の引数として関数に渡されます。
Falseの場合、イベントオブジェクトのみが関数に渡されます。
addParameter(port_name, port_label, port_tag, data_type, port_size)
Adds a custom parameter to a node. This method has the same effect as calling pdg.GraphContext.addParameter with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
cancel()
#cppname PDG_Node::cancel
このノード内でクック中のワークアイテムとまだスケジュールに組まれていない今後のワークアイテムをキャンセルします。 同じノードグラフ内の他のノードは影響を受けませんが、このノード内のワークアイテムに依存する下流のワークアイテムも間接的にキャンセルされます。
connect(port_name, dst_node_name, dst_port_name)
Connect another node to this one. This method has the same effect as calling pdg.GraphContext.connect with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
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)
Disconnect another node from this one. This method has the same effect as calling pdg.GraphContext.disconnect with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
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)
Removes an external dependency from the node. This method has the same effect as calling pdg.GraphContext.removeDependency with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
resultData(localize)
→ list
of pdg.File
このメソッドは廃止されました。代わりにpdg.Node.outputFilesを使用してください。
reserveIndexBlock(num_indices)
→ int
num_indices
の数だけ連続するワークアイテムインデックスを確保し、そのリスト内の最初のインデックスを返します。
このメソッドは、上流のワークアイテムデータに基づいてワークアイテム数が可変する動的ノードを実装する時に役立ちます。
このメソッドは、すべてのインデックスが生成された場合にのみ動作します。
つまり、ワークアイテムを追加するコールが実際にその確保された範囲内の値を使用するかどうかはノード作成者次第です。
setExpression(name, expression, index=0)
Sets a parameter with the specified name
to the Python expression
string.
This method has the same effect as calling pdg.GraphContext.setExpression with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setExpressions(dict)
Sets multiple parameter expressions on the node, expressed as a dictionary mapping parameter names to expression strings. This method has the same effect as calling pdg.GraphContext.setExpressions with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setParameter(name, value, index=0)
Sets a parameter with the specified name
to the specified value or expression.
This method has the same effect as calling pdg.GraphContext.setParameter with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setParameters(dict)
Sets multiple parameter values on the node, expressed as a dictionary mapping parameter names to value or expression strings. This method has the same effect as calling pdg.GraphContext.setParameters with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setScheduler(scheduler_name)
Sets the scheduler for the node. This method has the same effect as calling pdg.GraphContext.setScheduler with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setValue(name, value, index=0)
Sets a parameter with the specified name
to value
.
This method has the same effect as calling pdg.GraphContext.setValue with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
setValues(dict)
Sets multiple parameter values on the node, expressed as a dictionary mapping parameter names to values. This method has the same effect as calling pdg.GraphContext.setValues with the node’s name as its first argument.
Warning
This method should not be called on PDG nodes that were created using TOPs. Use methods from hou.TopNode intead to manipulate node parameters and connectivity.
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
The name of the service used by work items in this node. This value is derived from the service parameter and any active service blocks that contain the node.
workItems
: list
of pdg.WorkItem
Property
このノード上の静的ワークアイテムと動的アイテムの両方の通常のワークアイテムすべてのリスト。
Methods from pdg.Processor ¶
cookType
: pdg.workItemCookType
Property
プロセッサノードのクックタイプ。 これは、プロセッサノードをIn-ProcessまたはOut-of-Processのどちらで実行するのかを決めます。
staticWorkItems
: list
of pdg.WorkItem
Property
プロセッサノードに格納されている静的なワークアイテム。 このメソッドは廃止され、pdg.Node.workItemsに置換されました。
injectStaticItems()
→ pdg.InjectBlock
静的なワークアイテムを注入するためのコンテキストマネージャブロックを返します。
これは、Pythonのwith
ステートメント内で使用します。