詳細は、レシピを参照してください。
関数 ¶
レシピ ¶
saveNodePresetRecipe(name: str, label: str, location: str, node: hou.OpNode, nodetype_patterns: str="", comment: str="", nodes_only=False, children=False, editables=False, inputs=False, outputs=False, position=False, flags=True, parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]] = True, spareparms=True, parms_as_brief=True, default_parmvalues=False, evaluate_parmvalues=False, parmtemplates="spare_only", metadata=False, verbose=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引数のノードタイプにのみマッチするパターンを使用します。
children
これがFalseの場合、レシピはトップレベルノードのみを取得し、サブネットやロック解除されたアセット内のノードを無視します。
editables
これがFalseの場合、レシピは、アセット内のEditable Dive Targetネットワーク内のノードを無視します。
inputs
これがTrueの場合、レシピは、入力コネクションを取得します。
outputs
これがTrueの場合、レシピは、出力コネクションを取得します。
position
これがTrueの場合，レシピは、ノードの位置を取得します。
parms
これがTrueの場合、レシピは、(default_parmvalues引数とspareparms引数に応じて)非デフォルトパラメータ値またはSpareパラメータを取得します。
これがFalseの場合、レシピはどのパラメータも取得しません。
別の方法として、hou.ParmTupleインスタンスまたはhou.Parmインスタンスのリスト、または、取得するパラメータ名の文字列表現を指定することができます。
以下の共通の保存オプションを参照してください。
applyNodePresetRecipe(name: str, node: hou.OpNode, parmsTrue, parmtemplates=True, children=True, editables=True, skip_notes=True)
→ dict[str, Any]
nameで指定されたレシピを、指定したhou.OpNodeインスタンスに適用します。
name
nodeに適用するレシピの内部名。
node
レシピの適用先となるhou.OpNodeインスタンス。
以下の共通の適用オプションを参照してください。
レシピの内容の再現方法に関する情報を含んだ辞書を返します。
saveDecorationRecipe(name: str, label: str, location: str, central_node: [hou.OpNode], decorator_items: Collection[hou.NetworkItem], nodetype_patterns="", comment="", generic_tags: Sequence[hou.NetworkItem]=None, selected_node: hou.NetworkMovableItem=None, nodes_only=False, central_children=False, children=True, central_editables=False, editables=True, flags=False, central_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]]=True, parms=True, spareparms=True, parms_as_brief=True, default_parmvalues=False, evaluate_parmvalues=False, parmtemplates="spare_only", metadata=False, verbose=False) -> None
一連のネットワークアイテムをデコレーションレシピとして保存します。 保存されたデコレーションレシピを適用するには、hou.data.applyDecorationRecipeを使用します。
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
central_node
デコレーションの“中心”ノードとして使用する[Hom:hou.OpNode]インスタンス。
詳細は、デコレーションレシピを参照してください。
decorator_items
レシピの内容として取得するhou.NetworkMovableItemインスタンスのコレクション。
nodetype_patterns
Houdiniは、(hou.NodeType.nameWithCategoryが返す文字列と同様の カテゴリ付きの)内部名がこのパターンにマッチしたノード タイプ に対して、これを利用可能なプリセットとして表示します。
詳細は、ターゲットノードパターンを参照してください。
これが空っぽの場合、レシピは、node引数のノードタイプにのみマッチするパターンを使用します。
children
中央ノード 以外 のサブネットワークやロック解除されたアセットの内容を再帰的に保存するかどうか。
central_children
(中央ノードがサブネットワークやロック解除されたアセットの場合)中央ノードの内容を再帰的に保存するかどうか。
editables
中央ノード 以外 のアセット内のEditable Dive Targetネットワークの内容を保存するかどうか。
central_editables
中央ノード内のEditable Dive Targetネットワークの内容があれば、その内容を保存するかどうか。
parms
中央ノード 以外 のノード上のパラメータ値を保存するかどうか。
central_parms
これがTrueの場合、レシピは、(default_parmvalues引数とspareparms引数に応じて)非デフォルトパラメータ値またはSpareパラメータを取得します。
これがFalseの場合、レシピはどのパラメータも取得しません。
別の方法として、hou.ParmTupleインスタンスまたはhou.Parmインスタンスのリスト、または、取得するパラメータ名の文字列表現を指定することができます。
以下の共通の保存オプションを参照してください。
applyDecorationRecipe(name: str, central_node: hou.OpNode, insert_mode=False, parms=True, parmtemplates=True, children=True, editables=True, skip_notes=True) -> dict[str, Any]
nameで指定したデコレーションレシピを、指定したhou.OpNodeインスタンスに適用します。
name
nodeに適用するレシピの内部名。
central_node
デコレーションの適用先となる“ターゲット”hou.OpNodeインスタンス。 レシピ内の中央ノードから保存されたパラメータがこのノードに適用され、レシピのデコレーションアイテムがそのノード周辺で再生成されます。
insert_mode
指定したノードの入力と出力の既存コネクションを接続し直します。
以下の共通の適用オプションを参照してください。
saveTabToolRecipe(name: str, label: str, location: str, anchor_node: hou.Node, items: Sequence[hou.NetworkMovableItem]=None, tab_submenu="Recipes", icon="BUTTONS_recipe", comment="", generic_tags: Sequence[hou.NetworkMovableItem] = None, selected_node: hou.NetworkMovableItem = None, nodes_only=False, central_children=False, children=True, central_editables=False, editables=True, flags: bool=False, central_parms: Union[bool, Sequence[hou.ParmTuple], Sequence[str]] = True, parms=True, spareparms=True, parms_as_brief=True, default_parmvalues=False, evaluate_parmvalues=False, parmtemplates="spare_only", metadata=False, verbose=False) -> None
name
レシピの保存先であるDataアセットの内部名。
label
レシピのラベル。 このラベルは、ユーザ側でレシピを選択できるメニューで使用されます。
location
レシピアセットの保存であるアセットライブラリ(.hdaファイル)のパスを示した文字列。
別のパス指定として、既存アセットを参照するopdef:パス(例えば、opdef:/Sop/my_asset)を使用した場合、Houdiniは、その参照アセットと同じライブラリファイルに新しいレシピアセットを保存します。
特殊文字列のEmbeddedを使用した場合、アセットは現行シーンファイルの一部として保存されます。
これは、自己完結型で作業シーンファイルを共有したい場合に役立ちます。
anchor_node
レシピの一部に含めたいhou.OpNodeインスタンス。 このツールを後でネットワーク内にドロップすると、選択した位置がこのノードに適用され、レシピ内の他のアイテムがその位置を基準に配置されます。
items
ツールレシピに含めたいhou.NetworkMovableItemインスタンスのコレクション。
children
中央ノード 以外 のサブネットワークやロック解除されたアセットの内容を再帰的に保存するかどうか。
central_children
(中央ノードがサブネットワークやロック解除されたアセットの場合)中央ノードの内容を再帰的に保存するかどうか。
editables
中央ノード 以外 のアセット内のEditable Dive Targetネットワークの内容を保存するかどうか。
central_editables
中央ノード内のEditable Dive Targetネットワークの内容があれば、その内容を保存するかどうか。
parms
中央ノード 以外 のノード上のパラメータ値を保存するかどうか。
central_parms
これがTrueの場合、レシピは、(default_parmvalues引数とspareparms引数に応じて)非デフォルトパラメータ値またはSpareパラメータを取得します。
これがFalseの場合、レシピはどのパラメータも取得しません。
別の方法として、hou.ParmTupleインスタンスまたはhou.Parmインスタンスのリスト、または、取得するパラメータ名の文字列表現を指定することができます。
以下の共通の保存オプションを参照してください。
applyTabToolRecipe(name: str, kwargs: dict[str, Any], parms=True, parmtemplates=True, children=True, editables=True, skip_notes=True) -> dict[str, Any]
Recreates the contents of a tool recipe, as if the user had chosen the recipe from the tab menu in a network editor.
name
nodeに適用するレシピの内部名。
kwargs
ツールスクリプトを実行する時に渡される引数を含んだ辞書。 通常では、この辞書はユーザがTabメニューからツールを選択した時にHoudiniによって作成されますが、レシピをあなたのプログラムから実行させたい場合は、この辞書をあなた自身で作成しなければなりません。 この辞書には以下のキーを格納してください:
pane
ツールが実行されるhou.NetworkEditorインスタンス。
inputs
オプションのノード名シーケンス。 空っぽでない場合、これは、ユーザが出力ワイヤーを開始してTabメニューからツールを選択したり、既存のワイヤー上にツールをドロップするのを模倣します。
outputs
オプションのノード名シーケンス。 空っぽでない場合、これは、ユーザが入力ワイヤーを開始してTabメニューからツールを選択したり、既存のワイヤー上にツールをドロップするのを模倣します。
nodepositionx, nodepositiony
ツールの内容が作成されるネットワークエディタ内の位置。 これは、ユーザがツールを選択した後に位置をクリックするのを模倣します。
以下の共通の適用オプションを参照してください。
共通のレシピ保存オプション ¶
comment
レシピに関連付けるオプションのコメント文字列。
flags
これがTrueの場合、レシピはフラグの状態を取得します。
nodes_only
これがTrueの場合、レシピはノードのみを保存し、ステッキーノート、ネットワークボックス、ドットを無視します。
selected_node
(ツールレシピとデコレーションレシピ用)オプションのhou.NetworkMovableItemインスタンス。 レシピを適用した後に選択されるアイテムを指定します。
spareparms
これがTrueの場合、レシピは、ノード上のすべてのSpareパラメータを取得します。
parms_as_brief
通常では、レシピはできるだけコンパクトな形式でパラメータを保存します。
これがFalseの場合、レシピはフル構造ですべてのパラメータを保存します。
このオプションは、主にデバッグ用にあります。
default_parmvalues
通常では、parmsがTrueの時、レシピは、非デフォルト値のパラメータのみを取得します。
これがTrueの場合、レシピはデフォルト値に設定されているパラメータも取得します。
parms引数が取得するパラメータのリストだった場合、これは無視されます。
evaluate_parmvalues
これがTrueの場合、レシピは、エクスプレッションやキーフレームアニメーションを取得するのではなく、現行時間で評価されたパラメータ値(文字列内の変数展開を含む)を取得します。
parmtemplates
これが"spare_only"の場合、レシピは、Spareパラメータのパラメータテンプレートデータのみを取得するので、そのパラメータテンプレートデータのみを再生成することができます。
これが"all"の場合、レシピは、すべてのパラメータのテンプレートデータを取得します。
このオプションは、主にデバッグ用にあります。
metadata
これがTrueの場合、レシピは、ノードに関する追加情報を取得します。
verbose
通常では、レシピは、デフォルト値のオプションなど、推測できるオプションをしません。
これがTrueの場合、レシピは、すべての設定を取得します。
このオプションは、主にデバッグ用にあります。
共通のレシピ適用オプション ¶
parms
これがFalseの場合、レシピに保存されているどのパラメータデータもノードに適用されません。
parmtemplates
これがFalseの場合、どのテンプレート設定も適用されず、レシピに保存されているどのSpareパラメータも再現されません。
children
これがFalseの場合、レシピに保存されているどの子ネットワークデータも再帰的に再現されません。
editables
これがFalseの場合、レシピに保存されているどのEditable Dive Targetの内容も再現されません。
skip_notes
これがTrueの場合、レシピに保存されているどのステッキーノードも再現されません。
データ関数として ¶
dataFromParms(parms: Sequence[hou.ParmTuple], values=True, parms:Union[bool, Sequence[hou.ParmTuple], Sequence[str]] = True, default_values=False, evaluate_values=False, locked=True, brief=True, multiparm_instances=True, metadata=False, callback: Callable = None) -> dict[str, Any]
指定したhou.ParmTupleオブジェクトのリストを表現したJSONライクなデータ構造を返します。
selectedItemsAsData(nodes_only=False, children=True, editables=True, inputs=True, outputs=False, position=True, flags=True, parms=True, spareparms=True, parms_as_brief=True, default_parmvalues=False, evaluate_parmvalues=False, parmtemplates="spare_only", metadata=False, callback: Callable = None, anchor_position: hou.Vector2 = None) -> dict[str, Any]
現在選択されているネットワークアイテムを表現したJSONライクなデータ構造を返します。
itemsAsData(items: Sequence[hou.NetworkMovableItems], nodes_only=False, children=True, editables=True, inputs=True, position=True, flags=True, parms=True, anchor_position: hou.Vector2 = None) -> dict[str, Any]
指定したネットワークアイテムを表現したJSONライクなデータ構造を返します。
createItemsFromData(parent: hou.OpNode, data: dict[str, Any], external_connections=True, start_position: hou.Vector2 = None) -> dict[str, hou.NetworkMovableItem]
ネットワークノードとhou.data.itemsAsData()が返すようなJSONライクなデータ構造を与えると、そのネットワーク内にそのデータアイテムを再現します。
元々の取得アイテムの名前とそれに呼応した再現アイテムをマッピングした辞書を返します。
clusterItemsAsData(items: Sequence[hou.NetworkMovableItems], start_tags: Union[bool, Sequence[hou.NetworkMovableItems]] = True, end_tags: Union[bool, Sequence[hou.NetworkMovableItems]] = True, Union[bool, Sequence[hou.NetworkMovableItems]] = False, target_childen=False, target_editables=False, target_parms=True, action_behavior="default") -> dict[str, Any]
指定したネットワークアイテムを表現したJSONライクなデータ構造を返します。
返される辞書には、hou.data.itemsAsData()が返すようなデータ構造、指定したアイテムに関連した他の様々なプロパティがキーに含まれます。
createClusterItemsFromData(parent: hou.OpNode, data: dict[str, Any], target_node: hou.Node = None, clear_content=False, external_connections=False, create_exteriors=False) -> dict[str, Any]
ネットワークノードとhou.data.clusterItemsAsData()が返すようなJSONライクなデータ構造を与えると、そのネットワーク内にそのデータアイテムを再現します。
そのアイテムの再現方法に関する情報を含んだ辞書が返されます。
| See also |