関数 ¶
レシピ ¶
詳細は、レシピを参照してください。
saveParmPresetRecipe(name: str, label: str, location: str, parm: hou.ParmTuple, parmtype_patterns: str="", parmname_patterns: str="", nodetype_patterns: str="", visible: bool=True, submenu: str="", record_data: bool=True, prescript: str="", postscript: str="", comment: str="", expand_to_dir: bool=False, multiparm_operation: str="set", multiparm_start_index: int=0, multiparm_end_index: int=-1, evaluate_parmvalues=False, metadata=False, verbose=False) -> None
パラメータとマルチパラメータインスタンスの値をプリセットレシピとして保存します。 このレシピをパラメータに適用するには、hou.data.applyParmPresetRecipeを使用します。
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
parm
データを保存するhou.ParmTupleインスタンス。 マルチパラメータの親は、そのインスタンスパラメータも一緒に保存します。
parmtype_pattern
Houdiniは、このパターンに一致したパラメータ タイプ (hou.ParmTemplate.interfaceTypeが返す文字列)に対して、これを利用可能なプリセットとして表示します。
詳細は、パラメータタイプパターンを参照してください。
これが空っぽの場合、このレシピは、parm引数のタイプにのみマッチするパターンを使用します。
parmname_pattern
Houdiniは、内部名がこのパターンに一致したパラメータに対して、これを利用可能なプリセットとして表示します。
詳細は、パラメータ名パターンを参照してください。
これが空っぽの場合、このレシピは、parm引数の内部名にのみマッチするパターンを使用します。
nodetype_patterns
Houdiniは、(hou.NodeType.nameWithCategoryが返す文字列と同様の カテゴリ付きの)内部名がこのパターンにマッチしたノード タイプ に対して、これを利用可能なプリセットとして表示します。
詳細は、ターゲットノードパターンを参照してください。
これが空っぽの場合、このレシピは、node引数のノードタイプにのみマッチするパターンを使用します。
visible
これがFalseの場合、このレシピはメニューから非表示になります。
非表示のレシピは、引き続きRecipe Managerでリストされます。
submenu
サブメニューを指定すると、同じサブメニューを持つレシピが
Recipeメニューにまとめられ、
各サブメニューには直近で呼び出されたレシピの名前も表示されます。
record_data
レシピに対してJSONライクなデータ構造を記録するかどうか。
そのレシピの唯一の目的がPythonスクリプトの実行である場合は、これをFalseに設定してください。
prescript
レシピのデータが適用される前に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
レシピのデータが適用された後に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
expand_to_dir
これがTrueの場合、location引数で指定されたディレクトリ内にレシピの内容を展開します。
comment
レシピに関連付けるオプションのコメント文字列。
multiparm_operation
parm引数がマルチパラメータの親である場合、レシピが適用された時にマルチパラメータインスタンスが既存のマルチパラメータインスタンスに合成される方法を制御します。
set
既存のインスタンスがすべて削除され、このレシピに保存されたインスタンスに置換されます。
set_from_index
これは、ユーザにインデックスの指定を求めます。 そのインデックス以降の既存のマルチパラメータインスタンスすべてがこのレシピに保存されているインスタンスに基づいて変更されます。
insert_at_index
これは、ユーザにインデックスの指定を求めます。 このレシピに保存されているインスタンスがそのインデックスの後に挿入されます。
insert_first
このレシピに保存されているインスタンスが既存のインスタンスの先頭に追加されます。
append
このレシピに保存されているインスタンスが既存のインスタンスの末尾に追加されます。
multiparm_start_index
インスタンスの記録を開始するインスタンスインデックス番号。
multiparm_end_index
インスタンスの記録を終了するインスタンスインデックス番号。
デフォルトの-1は、すべてのインスタンスがmultiparm_startindex引数の後に記録されることを意味します。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
applyParmPresetRecipe(name: str, parm: parm: hou.ParmTuple, multiparm_operation: str="", multiparm_start_index: int = 0, prescript: bool=True, postscript: bool=True)
→ dict[str, Any]
nameで指定したレシピを、指定したhou.ParmTupleインスタンスに適用します。
name
適用するレシピの内部名。
parm
レシピを適用するhou.ParmTupleインスタンス。
multiparm_operation
parm引数がマルチパラメータの親である場合、レシピが適用された時にマルチパラメータインスタンスが既存のマルチパラメータインスタンスに合成される方法を制御します。
set
既存のインスタンスがすべて削除され、このレシピに保存されたインスタンスに置換されます。
set_from_index
これは、ユーザにインデックスの指定を求めます。 そのインデックス以降の既存のマルチパラメータインスタンスすべてがこのレシピに保存されているインスタンスに基づいて変更されます。
insert_at_index
これは、ユーザにインデックスの指定を求めます。 このレシピに保存されているインスタンスがそのインデックスの後に挿入されます。
insert_first
このレシピに保存されているインスタンスが既存のインスタンスの先頭に追加されます。
append
このレシピに保存されているインスタンスが既存のインスタンスの末尾に追加されます。
空っぽの文字列の場合、レシピ内に保存されているオペレーションが使用されます。
prescript
これがFalseの場合、レシピに保存されているPythonプリスクリプトは実行されません。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
これがFalseの場合、レシピに保存されているPythonポストスクリプトは実行されません。
詳細は、プリスクリプトとポストスクリプトを参照してください。
以下のキーを持つ辞書を返します:
node
レシピが適用されたプリセットパラメータを含んだhou.Nodeオブジェクト。
parms
レシピによってノードに設定されたhou.ParmTupleオブジェクト。
例えば、
Box SOPの Type パラメータを設定するパラメータプリセットの出力は次のようになります:
{ 'node': <hou.SopNode of type box at /obj/geo1/box1>, 'parm': hou.ParmTuple type in /obj/geo1/box1> }
saveNodePresetRecipe(name: str, label: str, location: str, node: hou.OpNode, nodetype_patterns: str="", visible: bool=True, submenu: str="", record_data: bool=True, prescript: str="", postscript: str="", expand_to_dir: bool=False, comment: str="", nodes_only: bool=False, flags: bool=False, children: bool=False, editables: bool=False, inputs: bool=False, position: bool=False, parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]]=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parms_as_brief: bool=True, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> None
ノードのパラメータおよび必要に応じてその子ノードや編集可能なコンテキストをプリセットレシピとして保存します。 このレシピをノードに適用するには、hou.data.applyNodePresetRecipeを使用します。
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
node
データを保存するhou.OpNodeインスタンス。
nodetype_patterns
Houdiniは、(hou.NodeType.nameWithCategoryが返す文字列と同様の カテゴリ付きの)内部名がこのパターンにマッチしたノード タイプ に対して、これを利用可能なプリセットとして表示します。
詳細は、ターゲットノードパターンを参照してください。
これが空っぽの場合、このレシピは、node引数のノードタイプにのみマッチするパターンを使用します。
visible
これがFalseの場合、このレシピはメニューから非表示になります。
非表示のレシピは、引き続きRecipe Managerでリストされます。
submenu
サブメニューを指定すると、同じサブメニューを持つレシピがRecipeメニューにまとめられ、
各サブメニューには直近で呼び出されたレシピの名前も表示されます。
record_data
レシピに対してJSONライクなデータ構造を記録するかどうか。
そのレシピの唯一の目的がPythonスクリプトの実行である場合は、これをFalseに設定してください。
prescript
レシピのデータが適用される前に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
レシピのデータが適用された後に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
expand_to_dir
これがTrueの場合、location引数で指定されたディレクトリ内にレシピの内容を展開します。
comment
レシピに関連付けるオプションのコメント文字列。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
children
これがFalseの場合、キャプチャ処理はトップレベルノードのみを保存し、サブネットやロック解除されたアセット内のノードを無視します。
editables
これがFalseの場合、キャプチャ処理はアセット内のEditable Dive Targetネットワーク内のノードを無視します。
inputs
これがTrueの場合、キャプチャ処理は入力コネクションを保存します。
position
これがTrueの場合、キャプチャ処理はノードの位置を保存します。
parms
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
applyNodePresetRecipe(name: str, node: hou.OpNode, prescript: bool=True, postscript: bool=True, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, skip_notes: bool=True)
→ dict[str, Any]
name で指定されたレシピを、指定されたhou.OpNode インスタンスに適用します。
saveDecorationRecipe(name: str, label: str, location: str, central_node: [hou.OpNode], decorator_items: Sequence[hou.NetworkMovableItems], nodetype_patterns="", visible: bool=True, submenu: str="", record_data: bool=True, prescript: str="", postscript: str="", expand_to_dir: bool=False, comment: str="", frame_nodes: Sequence[hou.NetworkMovableItem]=None, selected_nodes: Sequence[hou.NetworkMovableItem]=None, current_node: hou.NetworkMovableItem=None, nodes_only: bool=False, flags: bool=False, central_children: bool=False, children: bool=True, central_editables: bool=False, editables: bool=True, central_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]]=True, parms: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parms_as_brief: bool=True, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> None
一連のネットワークアイテムをデコレーションレシピとして保存します。 保存されたデコレーションレシピを適用するには、hou.data.applyDecorationRecipeを使用します。
central_node
デコレーションの“中心”ノードとして使用する[Hom:hou.OpNode]インスタンス。
詳細は、デコレーションレシピを参照してください。
decorator_items
レシピの適用時に作成されるキャプチャ対象のhou.NetworkMovableItemインスタンスのシーケンス。
nodetype_patterns
Houdiniは、(hou.NodeType.nameWithCategoryが返す文字列と同様の カテゴリ付きの)内部名がこのパターンにマッチしたノード タイプ に対して、これを利用可能なプリセットとして表示します。
詳細は、ターゲットノードパターンを参照してください。
これが空っぽの場合、このレシピは、node引数のノードタイプにのみマッチするパターンを使用します。
visible
これがFalseの場合、このレシピはメニューから非表示になります。
非表示のレシピは、引き続きRecipe Managerでリストされます。
submenu
サブメニューを指定すると、同じサブメニューを持つレシピがRecipeメニューにまとめられ、
各サブメニューには直近で呼び出されたレシピの名前も表示されます。
record_data
レシピに対してJSONライクなデータ構造を記録するかどうか。
そのレシピの唯一の目的がPythonスクリプトの実行である場合は、これをFalseに設定してください。
prescript
レシピのデータが適用される前に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
レシピのデータが適用された後に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
expand_to_dir
これがTrueの場合、location引数で指定されたディレクトリ内にレシピの内容を展開します。
comment
レシピに関連付けるオプションのコメント文字列。
frame_nodes
アイテム作成後にそれらをネットワークエディタの枠内に収めるために使用されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
これを機能させるには、アイテムを作成する関数(例えば、hou.data.applyDecorationRecipeやhou.data.applyToolRecipe)でも、frame =Trueという引数を使用する必要があります。
selected_nodes
アイテム作成後に選択されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
current_node
オプションのhou.NetworkMovableItemインスタンス。 アイテム作成後に現行ノードとして設定されるアイテムを指定します。 このノードのパラメータインターフェースがパラメータエディタに表示されます。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
central_children
ターゲット/セントラル/アンカーノード(サブネットワークまたはロック解除されたアセットの場合)の内容を再帰的に保存するかどうかを指定します。
children
ターゲット/セントラル/アンカーノード 以外 のサブネットワークおよびロック解除済みアセットの内容を再帰的に保存するかどうかを指定します。
central_editables
ターゲット/セントラル/アンカーノード内にEditable Dive Targetsが存在する場合、その内容を保存するかどうかを指定します。
editables
ターゲット/セントラル/アンカーノード 以外 のアセット内にあるEditable Dive Targetsの内容を保存するかどうか。
central_parms
ターゲット/セントラル/アンカーノードのパラメータ値(存在する場合)を保存するかどうかを指定します。
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
parms
ターゲット/セントラル/アンカーノード 以外 のノードのパラメータ値を保存するかどうかを指定します。
default_parmvalues引数に基づいて、キャプチャ処理は、デフォルト以外のパラメータ値のみ、または、すべてのパラメータ値を保存します。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
applyDecorationRecipe(name: str, central_node: hou.OpNode, external_connections: bool=False, drop_on_wire: bool=False, click_to_place: bool=False, avoid_overlap: bool=False, frame: bool=False, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, skip_notes: bool=True) -> dict[str, Any]
nameで指定したデコレーションレシピを、指定したhou.OpNodeインスタンスに適用します。
name
適用するレシピの内部名。
central_node
デコレーションを適用する“ターゲット”hou.OpNodeインスタンス。 レシピのデコレータアイテムは、このインスタンスを中心に再現されます。
external_connections
external_connectionsとは、他のhou.NetworkMovableItemに接続されているものの、レシピの一部としてキャプチャされなかったワイヤのことです。
これがTrueの場合、それらの接続は、同じ名前の既存ノードに対して再作成されます。
drop_on_wire
指定したセントラルノードの入出力の既存接続を再接続します。
click_to_place
これがTrueの場合、レシピの内容を配置するためにネットワークエディタ内をクリックするようユーザに求められます。
avoid_overlap
これがTrueの場合、ノードのタイルを移動させて重なりを回避します。
frame
これがTrueの場合、レシピがキャプチャされる際にframe_nodesを使用して設定されたノードがネットワークエディタの枠の中心になります。
parms
これがFalseの場合、データに保存されているパラメータ値をノードに適用しません。
parmtemplates
これがFalseの場合、データに保存されているSpareパラメータを再現しません。
children
これがFalseの場合、データに保存されている子ネットワークを再帰的に再現しません。
editables
これがFalseの場合、データに保存されているEditable Dive Targetsの内容を再現しません。
skip_notes
これがTrueの場合、データに保存されているステッキーノートを再現しません。
以下のキーを持つ辞書を返します:
central_node
レシピが適用されたhou.OpNodeオブジェクト。
central_parms
レシピによってセントラルノードに設定されたhou.ParmTupleオブジェクトシーケンス。
framed_nodes
ネットワークエディタの枠に収まるように設定されたhou.OpNodeオブジェクトシーケンス。
selected_nodes
レシピの適用後に選択されるように設定されたhou.OpNodeオブジェクトシーケンス。
current_node
レシピが適用された後に最後に選択されるノードとして設定されたhou.OpNodeオブジェクト。
items
セントラルノードの周囲に設定されたhou.OpNodeオブジェクト(デコレータ)の辞書。 この辞書のキーは、データに記録されたノード名、値は、そのデータによって作成されたhou.OpNodeオブジェクトです。
例えば、セントラルノードに Type パラメータを設定し、セントラルノードの下に
Null SOPをデコレータとして作成するデコレーションの出力は次のようになります:
{ 'central_node': <hou.SopNode of type box at /obj/geo1/box1>, 'central_parms': [ <hou.ParmTuple type in /obj/geo1/box1> ], 'items': [ 'null1': <hou.SopNode of type box at /obj/geo1/null1> ] }
saveToolRecipe(name: str, label: str, location: str, anchor_node: hou.OpNode, items: Sequence[hou.NetworkMovableItem]=None, tool_types: Sequence[recipeutils.ToolType] = [recipeutils.ToolType.tab, ], tool_labels: Sequence[str], tab_submenu str:="Recipes", shelf_tab: str='Recipes', shelf_odering_index: float=-1.0, prompt_type: recipeutils.ToolPromptType=None, prompt_messages: Sequence[str], prompt_input_nodes: Sequence[hou.OpNode], prompt_posparms: Sequence[str]=None, prompt_bboxes: Sequence[hou.BoundingBox]=None, help_url: str="", example: bool=False, visible: bool=True, icon: str="BUTTONS_recipe", record_data: bool=True, prescript: str="", postscript: str="", expand_to_dir: bool=False, comment: str="", frame_nodes: Sequence[hou.NetworkMovableItem]=None, selected_nodes: Sequence[hou.NetworkMovableItem]=None, current_node: hou.NetworkMovableItem=None, nodes_only=False, flags: bool=False, anchor_children: bool=False, children: bool=True, anchor_editables: bool=False, editables: bool=True, anchor_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]] = True, parms: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parms_as_brief: bool=True, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> None
一連のネットワークアイテムをTabメニューのサブメニューやシェルフタブに表示されるツールレシピとして保存します。
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
anchor_node
レシピの一部として含めるhou.OpNodeインスタンス。 後でネットワークにこのツールをドロップすると、選択した位置がこのノードに適用され、レシピ内の他のアイテムはこのノードを基準に配置されます。
items
ツールレシピに含めるオプションのhou.NetworkMovableItemインスタンスシーケンス。
tool_types
このレシピをTabメニューのサブメニュー/シェルフタブに配置するかどうかを指定します。
recipeutilsモジュールにアクセスするには、import recipeutilsを使用します。
tool_labels
Tabメニューやシェルフ上でlabel引数とは異なるラベルをツールに付けたい場合のオプションの文字列シーケンス。
shelf_tab
tool_typesにrecipeutils.ToolType.shelfが含まれている場合、このツールを配置するシェルフタブの内部名を指定します。
shelf_ordering_index
シェルフタブに配置されたツールは、インデックス番号の小さい順に左から右へ配置されます。
デフォルト値の-1は、ツールが右端に配置されることを意味します。
インデックス番号が同じツールは、アルファベット順に並べ替えられます。
prompt_type
レシピが適用され、且つ、recipeutils.ToolPromptType.position_selectionが設定されている場合、 ビューポート 内の位置をピックするようユーザに求められます。
recipeutils.ToolPromptType.node_selectionが設定されている場合、ユーザは ネットワークエディタ 内のノードを選択する必要があります。
recipeutilsモジュールにアクセスするには、import recipeutilsを使用します。
prompt_messages
各プロンプト時にメッセージとして表示されるテキストシーケンス。
prompt_input_nodes
prompt_typeがrecipeutils.ToolPromptType.node_selectionに設定されている場合、プロンプト中に選択されたノードに置換されるhou.OpNodeシーケンスを指定します。
prompt_posparms
prompt_typeがrecipeutils.ToolPromptType.position_selectionに設定されている場合に、オプションでパラメータパスシーケンスを指定します。
パラメータの値は、ピックされた位置に置換されます。
prompt_bboxes
prompt_typeがrecipeutils.ToolPromptType.position_selectionに設定されている場合、オプションで各プロンプトに対してビューポート内に描画されるhou.BoundingBoxオブジェクトシーケンスを指定します。
help_url
ユーザがこのツールのヘルプをリクエストした際にヘルプビューアで表示するURLを設定します。
example
これがTrueの場合、このレシピがヘルプセクションのRecipeメニューに表示されます。
visible
これがFalseの場合、このレシピはメニューから非表示になります。
非表示のレシピは、引き続きRecipe Managerでリストされます。
icon
このレシピに関連付けるアイコン。
record_data
レシピに対してJSONライクなデータ構造を記録するかどうか。
そのレシピの唯一の目的がPythonスクリプトの実行である場合は、これをFalseに設定してください。
prescript
レシピのデータが適用される前に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
レシピのデータが適用された後に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
expand_to_dir
これがTrueの場合、location引数で指定されたディレクトリ内にレシピの内容を展開します。
comment
レシピに関連付けるオプションのコメント文字列。
frame_nodes
アイテム作成後にそれらをネットワークエディタの枠内に収めるために使用されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
これを機能させるには、アイテムを作成する関数(例えば、hou.data.applyDecorationRecipeやhou.data.applyToolRecipe)でも、frame =Trueという引数を使用する必要があります。
selected_nodes
アイテム作成後に選択されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
current_node
オプションのhou.NetworkMovableItemインスタンス。 アイテム作成後に現行ノードとして設定されるアイテムを指定します。 このノードのパラメータインターフェースがパラメータエディタに表示されます。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
children
ターゲット/セントラル/アンカーノード 以外 のサブネットワークおよびロック解除済みアセットの内容を再帰的に保存するかどうかを指定します。
anchor_editables
ターゲット/セントラル/アンカーノード内にEditable Dive Targetsが存在する場合、その内容を保存するかどうかを指定します。
editables
ターゲット/セントラル/アンカーノード 以外 のアセット内にあるEditable Dive Targetsの内容を保存するかどうか。
anchor_parms
ターゲット/セントラル/アンカーノードのパラメータ値(存在する場合)を保存するかどうかを指定します。
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
parms
ターゲット/セントラル/アンカーノード 以外 のノードのパラメータ値を保存するかどうかを指定します。
default_parmvalues引数に基づいて、キャプチャ処理は、デフォルト以外のパラメータ値のみ、または、すべてのパラメータ値を保存します。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
applyToolRecipe(name: str, network_editor: hou.NetworkEditor=None, parent: hou.OpNode=None, tool_inputs: Sequence[Tuple[hou.NetworkMovableItem, int]], tool_outputs: Sequence[Tuple[hou.NetworkMovableItem, int]], prompt: bool=True, drop_on_wire: bool=False, click_to_place: bool=False, avoid_overlap: bool=False, frame: bool=False, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, skip_notes: bool=True) -> dict[str, Any]
ユーザがネットワークエディタのTabメニューまたはシェルフタブからレシピを選択したかのようにツールレシピの内容を再現します。
name
適用するレシピの内部名。
network_editor
レシピを配置するhou.NetworkEditorオブジェクト。 これは、Tabメニューのサブメニューからレシピが呼び出された時に使用されます。
parent
network editorが指定されていない場合にレシピを配置するhou.OpNode。
これは、Pythonスクリプトからレシピを呼び出す時に役立ちます。
tool_inputs
drop_on_wireがTrueに設定されている場合にレシピの入力に接続すべきノードおよび出力コネクタインデックスのリスト。
ここには、ツールスクリプトコンテキストからのkwargs['inputs']の結果が必要です。
tool_outputs
drop_on_wireがTrueに設定されている場合にレシピの入力に接続すべきノードおよび入力コネクタインデックスのリスト。
ここには、ツールスクリプトコンテキストからのkwargs['outputs']の結果が必要です。
prompt
レシピがpromptを使用するように作成されている場合に、ビューポート内の位置をクリックするか、または、ネットワークエディタでノードを選択するかをユーザに促すかどうか。
drop_on_wire
レシピの入力および出力の既存コネクションを再接続します。
click_to_place
これがTrueの場合、レシピの内容を配置するためにネットワークエディタ内をクリックするようユーザに求められます。
avoid_overlap
これがTrueの場合、ノードのタイルを移動させて重なりを回避します。
frame
これがTrueの場合、レシピがキャプチャされる際にframe_nodesを使用して設定されたノードがネットワークエディタの枠の中心になります。
parms
これがFalseの場合、データに保存されているパラメータ値をノードに適用しません。
parmtemplates
これがFalseの場合、データに保存されているSpareパラメータを再現しません。
children
これがFalseの場合、データに保存されている子ネットワークを再帰的に再現しません。
editables
これがFalseの場合、データに保存されているEditable Dive Targetsの内容を再現しません。
skip_notes
これがTrueの場合、データに保存されているステッキーノートを再現しません。
以下のキーを持つ辞書を返します:
anchor_node
hou.OpNode。 これは、レシピが適用された時にネットワークエディタ内でマウス下にあるノードであり、配置のためにクリックするよう促すものです。
anchor_parms
レシピによってアンカーノードに設定されたhou.ParmTupleオブジェクトシーケンス。
framed_nodes
ネットワークエディタの枠に収まるように設定されたhou.OpNodeオブジェクトシーケンス。
selected_nodes
レシピの適用後に選択されるように設定されたhou.OpNodeオブジェクトシーケンス。
current_node
レシピの適用後に最後に選択されるノードとして設定されたhou.OpNodeオブジェクト。
items
アンカーノードの周囲に配置されたhou.OpNodeオブジェクトの辞書。 この辞書のキーは、データに記録されたノード名、値は、そのデータによって作成されたhou.OpNodeオブジェクトです。
以下は、 Foreach Connected Piece ツールの出力の例です:
{ 'anchor_node': <hou.SopNode of type connectivity at /obj/geo1/connectivity1>, 'anchor_parms': [ <hou.ParmTuple connecttype in /obj/geo1/connectivity1> ], 'items': { 'foreach_end1': <hou.SopNode of type block_end at /obj/geo1/foreach_end1>, 'foreach_begin1': <hou.SopNode of type block_begin at /obj/geo1/foreach_begin1>, 'connectivity1': <hou.SopNode of type connectivity at /obj/geo1/connectivity1> } }
saveTabToolRecipe(name: str, label: str, location: str, anchor_node: hou.OpNode, items: Sequence[hou.NetworkMovableItem]=None, tab_submenu str:="Recipes", help_url: str="", visible: bool=True, icon: str="BUTTONS_recipe", record_data: bool=True, prescript: str="", postscript: str="", expand_to_dir: bool=False, comment: str="", frame_nodes: Sequence[hou.NetworkMovableItem]=None, selected_nodes: Sequence[hou.NetworkMovableItem]=None, current_node: hou.NetworkMovableItem=None, nodes_only=False, flags: bool=False, anchor_children: bool=False, children: bool=True, anchor_editables: bool=False, editables: bool=True, anchor_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]] = True, parms: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parms_as_brief: bool=True, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> None
一連のネットワークアイテムをTabニューのサブメニューに表示されるツールレシピとして保存します。
これは、hou.data.saveToolRecipe()のショートカットです。
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
anchor_node
レシピの一部として含めるhou.OpNodeインスタンス。 後でネットワークにこのツールをドロップすると、選択した位置がこのノードに適用され、レシピ内の他のアイテムはこのノードを基準に配置されます。
items
データを作成する時にキャプチャするhou.NetworkMovableItemインスタンスシーケンス。
help_url
ユーザがこのツールのヘルプをリクエストした際にヘルプビューアで表示するURLを設定します。
visible
これがFalseの場合、このレシピはメニューから非表示になります。
非表示のレシピは、引き続きRecipe Managerでリストされます。
icon
このレシピに関連付けるアイコン。
record_data
レシピに対してJSONライクなデータ構造を記録するかどうか。
そのレシピの唯一の目的がPythonスクリプトの実行である場合は、これをFalseに設定してください。
prescript
レシピのデータが適用される前に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
postscript
レシピのデータが適用された後に実行されるオプションのPythonスクリプト。
詳細は、プリスクリプトとポストスクリプトを参照してください。
expand_to_dir
これがTrueの場合、location引数で指定されたディレクトリ内にレシピの内容を展開します。
comment
レシピに関連付けるオプションのコメント文字列。
frame_nodes
アイテム作成後にそれらをネットワークエディタの枠内に収めるために使用されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
これを機能させるには、アイテムを作成する関数(例えば、hou.data.applyDecorationRecipeやhou.data.applyToolRecipe)でも、frame =Trueという引数を使用する必要があります。
selected_nodes
アイテム作成後に選択されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
current_node
オプションのhou.NetworkMovableItemインスタンス。 アイテム作成後に現行ノードとして設定されるアイテムを指定します。 このノードのパラメータインターフェースがパラメータエディタに表示されます。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
children
ターゲット/セントラル/アンカーノード 以外 のサブネットワークおよびロック解除済みアセットの内容を再帰的に保存するかどうかを指定します。
anchor_editables
ターゲット/セントラル/アンカーノード内にEditable Dive Targetsが存在する場合、その内容を保存するかどうかを指定します。
editables
ターゲット/セントラル/アンカーノード 以外 のアセット内にあるEditable Dive Targetsの内容を保存するかどうか。
anchor_parms
ターゲット/セントラル/アンカーノードのパラメータ値(存在する場合)を保存するかどうかを指定します。
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
children
ターゲット/セントラル/アンカーノード 以外 のサブネットワークおよびロック解除済みアセットの内容を再帰的に保存するかどうかを指定します。
parms
ターゲット/セントラル/アンカーノード 以外 のノードのパラメータ値を保存するかどうかを指定します。
default_parmvalues引数に基づいて、キャプチャ処理は、デフォルト以外のパラメータ値のみ、または、すべてのパラメータ値を保存します。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
applyTabToolRecipe(name: str, network_editor: hou.NetworkEditor=None, parent: hou.OpNode=None, tool_inputs: Sequence[Tuple[hou.NetworkMovableItem, int]], tool_outputs: Sequence[Tuple[hou.NetworkMovableItem, int]], drop_on_wire: bool=False, click_to_place: bool=False, avoid_overlap: bool=False, frame: bool=False, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, skip_notes: bool=True) -> dict[str, Any]
ユーザがTabメニューからレシピを選択したかのようにツールレシピの内容を再現します。
これは、hou.data.saveToolRecipe()のショートカットです。
name
適用するレシピの内部名。
network_editor
レシピを配置するhou.NetworkEditorオブジェクト。 これは、Tabメニューのサブメニューからレシピが呼び出された時に使用されます。
parent
network editorが指定されていない場合にレシピを配置するhou.OpNode。
これは、Pythonスクリプトからレシピを呼び出す時に役立ちます。
tool_inputs
drop_on_wireがTrueに設定されている場合にレシピの入力に接続すべきノードおよび出力コネクタインデックスのリスト。
ここには、ツールスクリプトコンテキストからのkwargs['inputs']の結果が必要です。
tool_outputs
drop_on_wireがTrueに設定されている場合にレシピの入力に接続すべきノードおよび入力コネクタインデックスのリスト。
ここには、ツールスクリプトコンテキストからのkwargs['outputs']の結果が必要です。
drop_on_wire
レシピの入力および出力の既存コネクションを再接続します。
click_to_place
これがTrueの場合、レシピの内容を配置するためにネットワークエディタ内をクリックするようユーザに求められます。
avoid_overlap
これがTrueの場合、ノードのタイルを移動させて重なりを回避します。
frame
これがTrueの場合、レシピがキャプチャされる際にframe_nodesを使用して設定されたノードがネットワークエディタの枠の中心になります。
parms
これがFalseの場合、データに保存されているパラメータ値をノードに適用しません。
parmtemplates
これがFalseの場合、データに保存されているSpareパラメータを再現しません。
children
これがFalseの場合、データに保存されている子ネットワークを再帰的に再現しません。
editables
これがFalseの場合、データに保存されているEditable Dive Targetsの内容を再現しません。
skip_notes
これがTrueの場合、データに保存されているステッキーノートを再現しません。
以下のキーを持つ辞書を返します:
anchor_node
hou.OpNode。 これは、レシピが適用された時にネットワークエディタ内でマウス下にあるノードであり、配置のためにクリックするよう促すものです。
anchor_parms
レシピによってアンカーノードに設定されたhou.ParmTupleオブジェクトシーケンス。
framed_nodes
ネットワークエディタの枠に収まるように設定されたhou.OpNodeオブジェクトシーケンス。
selected_nodes
レシピの適用後に選択されるように設定されたhou.OpNodeオブジェクトシーケンス。
current_node
レシピの適用後に最後に選択されるノードとして設定されたhou.OpNodeオブジェクト。
items
アンカーノードの周囲に配置されたhou.OpNodeオブジェクトの辞書。 この辞書のキーは、データに記録されたノード名、値は、そのデータによって作成されたhou.OpNodeオブジェクトです。
以下は、 Foreach Connected Piece ツールの出力の例です:
{ 'anchor_node': <hou.SopNode of type connectivity at /obj/geo1/connectivity1>, 'anchor_parms': [ <hou.ParmTuple connecttype in /obj/geo1/connectivity1> ], 'items': { 'foreach_end1': <hou.SopNode of type block_end at /obj/geo1/foreach_end1>, 'foreach_begin1': <hou.SopNode of type block_begin at /obj/geo1/foreach_begin1>, 'connectivity1': <hou.SopNode of type connectivity at /obj/geo1/connectivity1> } }
dataFromRecipe(name: str) -> dict[str, Any]
内部レシピ名を指定すると、そのレシピに保存されているJSONライクなデータ構造のPython辞書を返します。
name
データ構造を返すレシピの内部名。
As Data関数 ¶
詳細は、レシピのデータ形式を参照してください。
dataFromParms(parms: Sequence[hou.ParmTuple], values: bool=True, evaluate_values: bool=False, locked: bool=True, brief: bool=True, multiparm_instances: bool=True, metadata: bool=False, verbose: bool=False) -> dict[str,Any]
ノードから、指定したhou.ParmTupleオブジェクトのリストを表現したJSONライクなデータ構造を返します。
parms
ノードから、保存するhou.ParmTupleまたはhou.Parmのインスタンスのリスト。
values
これがTrueの場合、キャプチャ処理は、パラメータの値を保存します。
evaluate_values
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
locked
これがTrueの場合、キャプチャ処理は、パラメータのロック状態を保存します。
brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
multiparm_instances
これがTrueの場合、キャプチャ処理は、マルチパラメータの親パラメータのマルチパラメータインスタンスを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
selectedItemsAsData(nodes_only: bool=False, children: bool=True, editables: bool=True, inputs: bool=True, position: bool=True, anchor_position: hou.Vector2=hou.Vector2(0, 0), flags: bool=True, parms: bool=True, parms_as_brief: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> dict[str, Any]
現在選択されているネットワークアイテムを表現したJSONライクなデータ構造を返します。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
children
これがFalseの場合、キャプチャ処理はトップレベルノードのみを保存し、サブネットやロック解除されたアセット内のノードを無視します。
editables
これがFalseの場合、キャプチャ処理はアセット内のEditable Dive Targetネットワーク内のノードを無視します。
inputs
これがTrueの場合、キャプチャ処理は入力コネクションを保存します。
position
これがTrueの場合、キャプチャ処理は、ネットワークエディタ内の各ネットワークアイテムの位置を保存します。
anchor_position
すべてのネットワークアイテムの位置の記録に使用される基準位置。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
parms
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
itemsAsData(items: Sequence[hou.NetworkMovableItems], nodes_only: bool=False, children: bool=True, editables:bool=True, inputs: bool=True, position: bool=True, anchor_position: hou.Vector2=hou.Vector2(0, 0), flags: bool=True, parms: bool=True, parms_as_brief: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> dict[str, Any]
指定したネットワークアイテムを表現したJSONライクなデータ構造を返します。
items
データを作成する時にキャプチャするhou.NetworkMovableItemインスタンスシーケンス。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
children
これがFalseの場合、キャプチャ処理はトップレベルノードのみを保存し、サブネットやロック解除されたアセット内のノードを無視します。
editables
これがFalseの場合、キャプチャ処理はアセット内のEditable Dive Targetネットワーク内のノードを無視します。
inputs
これがTrueの場合、キャプチャ処理は入力コネクションを保存します。
position
これがTrueの場合、キャプチャ処理はノードの位置を保存します。
anchor_position
すべてのネットワークアイテムの位置の記録に使用される基準位置。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
parms
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
createItemsFromData(parent: hou.OpNode, data: dict[str, Any], clear_content: bool=False, force_item_creation: bool=True, offset_position: hou.Vector2=hou.Vector2(0, 0), external_connections=True, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, skip_notes: bool=False) -> dict[str, hou.NetworkMovableItem]
ネットワークノードと(hou.data.selectedItemsAsData()やhou.data.itemsAsData()が返す)JSONライクなデータ構造を指定すると、そのネットワーク内にそのデータアイテムを再現します。
元のキャプチャされたアイテムの名前とそれに呼応して再現したアイテムの名前をマッピングした辞書を返します。
parent
再現されるアイテムの格納先となるhou.OpNode。
data
ネットワークアイテムのシーケンスをデータとして表現したネットワークアイテムデータの辞書。
clear_content
これがTrueの場合、アイテムの作成前にparentの内容が破棄されます。
force_item_creation
これがFalse、且つ、parentのデータに名前が一致するアイテムが存在した場合、新しいアイテムは作成されずに、既存のアイテムが使用されます。
offset_position
データによって再現されるすべてのアイテムの位置をオフセットさせるhou.Vector2。
external_connections
external_connectionsとは、他のhou.NetworkMovableItemに接続されているものの、レシピの一部としてキャプチャされなかったワイヤのことです。
これがTrueの場合、それらの接続は、同じ名前の既存ノードに対して再作成されます。
parms
これがFalseの場合、データに保存されているパラメータ値をノードに適用しません。
parmtemplates
これがFalseの場合、データに保存されているSpareパラメータを再現しません。
children
これがFalseの場合、データに保存されている子ネットワークを再帰的に再現しません。
editables
これがFalseの場合、データに保存されているEditable Dive Targetsの内容を再現しません。
skip_notes
これがTrueの場合、データに保存されているステッキーノートを再現しません。
clusterItemsAsData(items: Sequence[hou.NetworkMovableItems], target_node: [hou.OpNode], frame_nodes: Sequence[hou.NetworkMovableItem]=None, selected_nodes: Sequence[hou.NetworkMovableItem]=None, current_node: hou.NetworkMovableItem=None, flags: bool=True, nodes_only: bool=False, target_children: bool=False, children: bool=True, target_editables: bool=False, editables: bool=True, target_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]]=True, parms: bool=True, default_parmvalues: bool=False, evaluate_parmvalues: bool=False, parms_as_brief: bool=True, parmtemplates: str="spare_only", metadata: bool=False, verbose: bool=False) -> dict[str, Any]
指定したネットワークアイテムを表現したJSONライクなデータ構造を返します。
返される辞書には、hou.data.itemsAsData()が返す値がキーとして含まれるほか、ネットワークアイテムのシーケンスに関連するその他の様々なプロパティも含まれています。
詳細は、クラスタデータの辞書を参照してください。
items
データを作成する時にキャプチャするhou.NetworkMovableItemインスタンスシーケンス。
target_node
オプションのhou.OpNodeインスタンス。
選択されたノードは、データ構造内でタグ付けされます。
このデータの内容がhou.data.createClusterItemsFromData()によって新しいターゲットノードインスタンス(target_node引数を使用)を用いて再現される時に、他のアイテムの位置やチャネル参照は、その新しいターゲットノードを基準に変更されます。
frame_nodes
アイテム作成後にそれらをネットワークエディタの枠内に収めるために使用されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
これを機能させるには、アイテムを作成する関数(例えば、hou.data.applyDecorationRecipeやhou.data.applyToolRecipe)でも、frame =Trueという引数を使用する必要があります。
selected_nodes
アイテム作成後に選択されるオプションのhou.NetworkMovableItemインスタンスシーケンス。
current_node
オプションのhou.NetworkMovableItemインスタンス。 アイテム作成後に現行ノードとして設定されるアイテムを指定します。 このノードのパラメータインターフェースがパラメータエディタに表示されます。
flags
これがTrueの場合、キャプチャ処理はフラグ状態を保存します。
nodes_only
これがTrueの場合、キャプチャ処理はノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
target_children
ターゲット/セントラル/アンカーノード(サブネットワークまたはロック解除されたアセットの場合)の内容を再帰的に保存するかどうかを指定します。
children
これがFalseの場合、キャプチャ処理はトップレベルノードのみを保存し、サブネットやロック解除されたアセット内のノードを無視します。
target_editables
ターゲット/セントラル/アンカーノード内にEditable Dive Targetsが存在する場合、その内容を保存するかどうかを指定します。
editables
これがFalseの場合、キャプチャ処理はアセット内のEditable Dive Targetネットワーク内のノードを無視します。
target_parms
ターゲット/セントラル/アンカーノードのパラメータ値(存在する場合)を保存するかどうかを指定します。
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
parms
これがTrueの場合、default_parmvalues引数に基づいて、キャプチャ処理はデフォルト以外のパラメータ値、または、すべてのパラメータ値を保存します。
これがFalseの場合、パラメータは保存されません。
他にも、カスタムパラメータ値のセットを保存したいのであれば、hou.ParmTupleまたはhou.Parmのインスタンスのリスト、または、キャプチャするパラメータの名前を示した文字列を指定することができます。
default_parmvalues
通常、parmsがTrueの場合、キャプチャ処理はデフォルト値以外の値を持つパラメータのみを保存します。
これがTrueの場合、キャプチャ処理はデフォルト値に設定されたパラメータも保存します。
parms引数がキャプチャするパラメータのリストであった場合、この設定は無視されます。
evaluate_parmvalues
これがTrueの場合、キャプチャ処理は、エクスプレッションやキーフレームアニメーションを保存するのではなく、現在の時間でのパラメータの評価済み値(文字列内の変数の展開を含む)を保存します。
parms_as_brief
通常、各パラメータの値を格納するパラメータデータは、可能な限りコンパクトな形式で保存されます。
これがFalseの場合、パラメータデータはフル構造で保存されます。
このオプションは主にデバッグ用にあります。
詳細は、パラメータデータ辞書を参照してください。
parmtemplates
これがspare_onlyの場合、キャプチャ処理は、Spareパラメータテンプレートを再現できるようにそのSpareパラメータテンプレートのみを保存します。
これは、パラメータが追加されたノードのパラメータインターフェースへの変更を最小限に抑えるのに役立ちます。
これがallの場合、キャプチャ処理はすべてのパラメータのテンプレートデータを保存します。
metadata
これがTrueの場合、キャプチャ処理は、ノードやパラメータに関する追加情報を保存します。
verbose
通常、キャプチャ処理は、様々なデータ構造の省略/簡略化を試みます。
これがTrueの場合、キャプチャ処理は、すべてのデータをフル構造で保存します。
このオプションは主にデバッグ用にあります。
createClusterItemsFromData(parent: hou.OpNode, data: dict[str, Any], target_node: hou.OpNode=None, clear_content=False, force_item_creation: bool=True, external_connections=True, parms: bool=True, parmtemplates: bool=True, children: bool=True, editables: bool=True, offset_position: hou.Vector2=hou.Vector2(0, 0), skip_notes: bool=False) -> dict[str, hou.NetworkMovableItem]
ネットワークノードとhou.data.clusterItemsAsData()が返すようなJSONライクなデータ構造を与えると、そのネットワーク内にそのデータアイテムを再現します。
そのアイテムの再現方法に関する情報を含んだ辞書が返されます。
parent
再現されるアイテムの格納先となるhou.OpNode。
data
ネットワークアイテムのシーケンスをデータとして表現したクラスタデータの辞書。
target_node
オプションのhou.OpNodeインスタンス。
選択されたノードは、データ構造内でタグ付けされます。
このデータの内容がhou.data.createClusterItemsFromData()によって新しいターゲットノードインスタンス(target_node引数を使用)を用いて再現される時に、他のアイテムの位置やチャネル参照は、その新しいターゲットノードを基準に変更されます。
external_connections
external_connectionsとは、他のhou.NetworkMovableItemに接続されているものの、レシピの一部としてキャプチャされなかったワイヤのことです。
これがTrueの場合、それらの接続は、同じ名前の既存ノードに対して再作成されます。
parms
これがFalseの場合、データに保存されているパラメータ値をノードに適用しません。
parmtemplates
これがFalseの場合、データに保存されているSpareパラメータを再現しません。
children
これがFalseの場合、データに保存されている子ネットワークを再帰的に再現しません。
editables
これがFalseの場合、データに保存されているEditable Dive Targetsの内容を再現しません。
skip_notes
これがTrueの場合、データに保存されているステッキーノートを再現しません。
| See also |