| Inheritance |
ParmTemplatesは、デジタルアセット定義のパラメータインターフェース内のパラメータを記述する時や
個々のノードのパラメータレイアウト(Spareパラメータを含む)を記述する時によく使用します。
ParmTemplateは、それが保持するパラメータとデータのタイプを記述しますが、パラメータの現行値を保存しません。
hou.ParmTupleオブジェクト内のhou.Parmオブジェクトのみが実際にパラメータ値を保存します。
hou.ParmTupleをParmTemplateのインスタンスとして考えることができます。
例えば、ジオメトリオブジェクトの"t" parmタプルは、hou.FloatParmTemplateで記述することができます。
つまり、そのタプルは、"Transform"のラベル、hou.parmData.Floatのデータタイプ、3コンポーネント、
hou.parmNamingScheme.XYZWの命名スキームなどを持ちます。
各ジオメトリオブジェクトノードは、このParmTemplateを使用した"t"という名前のhou.ParmTupleを持ちます。
ParmTemplateオブジェクトが単なるデータコンテナで、それらのオブジェクトはHoudini内のオブジェクトと何も関係性がないことに注意してください。 例えば、hou.OpNodeオブジェクトは直接Houdini内のノードに相当し、 そのノードの名前をHoudiniで変更すると、hou.Node.nameはその新しい名前を返します。 一方で、ParmTemplatesは有効な関係性を持ちません。 Spareパラメータまたはアセット定義パラメータに基づいてParmTemplateを作成すると、単にその情報をParmTemplateオブジェクトにコピーし、 オブジェクトを修正しても、Spareパラメータ/アセットパラメータに影響を与えません。
ParmTemplateオブジェクトは常にこのクラスのサブクラスのインスタンスなので、このクラスのインスタンスを直接構築することが できないことに注意してください。
デジタルアセットのパラメータを制御するには、hou.HDADefinition.parmTemplateGroupを使用して アセットの現行ParmTemplatesセットをhou.ParmTemplateGroupに取得することができます。 そして、パラメータをそのグループに追加して、そのグループの中のパラメータを置換するといった修正をして、 hou.HDADefinition.setParmTemplateGroupを使って、そのグループをアセット定義に保存することができます。 同様に、ノードのパラメータレイアウトは、hou.OpNode.parmTemplateGroupとhou.OpNode.setParmTemplateGroupを使って変更することができます。
値の許容範囲、パラメータペインでユーザに表示させるラベル、パラメータのポップアップヘルプなどのパラメータに関する情報を検索するために、 hou.ParmTupleにそのParmTemplateを求めることもできます。
メソッド ¶
clone()
→ hou.ParmTemplate
このparmテンプレートのコピーを返します。
このメソッドは、ParmTemplateサブクラスのインスタンスに対してコールすることができ、そのサブクラスのインスタンスが適切に返されます。
name()
→ string
parmテンプレートの内部名を返します。 これは、このparmテンプレートから作成されたhou.ParmTupleオブジェクトが持つ名前です。
マルチパラメータブロック内のhou.ParmTemplateオブジェクトの名前の最後には“#”が付きます。 この“#”は、hou.ParmTupleオブジェクトがインスタンス化された際にそのマルチパラメータインスタンス番号に置換されます。
このParmTemplateから基づいたParmTuples内のhou.Parmオブジェクトの名前は、この名前、このparmテンプレート内のコンポーネントの数、命名スキームで決定されます。 詳細は、namingSchemeメソッドを参照してください。
setName(name)
このparmテンプレートの内部名を変更します。 ParmTemplatesは単にデータを保存するだけなので、その名前変更は、このparmテンプレートを後でHoudiniでのパラメータレイアウトの修正に使用しない限りは、 何の効果もないことに注意してください。
マルチパラメータブロック内のパラメータの名前の最後には必ず“#”が付いてなければなりません。 この“#”はマルチパラメータのインスタンス番号に置換されます。
label()
→ string
パラメータペインで表示されるパラメータタプルの名前を返します。
setLabel(label)
パラメータペインで表示されるラベルの名前を変更します。
type()
→ hou.parmTemplateType列挙値
このパラメータのタイプを識別する列挙値を返します。
ParmTemplateオブジェクトは常にこのクラスのサブクラスのインスタンスであることを覚えておいてください。 以下のテーブルは、hou.parmTemplateType列挙値とParmTemplateサブクラス間のマップを示しています:
Enumerated Value
ParmTemplate Subclass
dataType()
→ hou.parmData列挙値
このParmTemplateに相当するhou.ParmTupleインスタンス内のhou.Parmインスタンスに保存されたデータタイプを返します。
例えば、このparmタプルが3つのコンポーネントを持つhou.FloatParmTemplateと仮定します。 それに相当するhou.ParmTupleは、その中に3つのhou.Parmオブジェクトを持ち、各オブジェクトが浮動小数点値を保存します。 このサンプルでは、このメソッドがhou.parmData.Floatを返します。
numComponents()
→ int
このParmTemplateのhou.ParmTupleインスタンス内に保存された値の数を返します。
例えば、このparmテンプレートが3つのコンポーネントを持っていれば、パラメータペインでは3つのパラメータフィールドが表示され、 このparmテンプレートから基づいたhou.ParmTuple内に3つのhou.Parmオブジェクトができます。
setNumComponents(num_components)
→ int
このParmTemplateのhou.ParmTupleインスタンス内に保存される値の数を設定します。
いくつかのParmTemplateサブクラスは1コンポーネントだけをサポートしているので、 このメソッドを1以外の値でコールすると、hou.OperationFailed例外を引き起こします。 また、コンポーネントの数を変更すると、いくつかのParmTemplateサブクラスではデフォルト値のタプルのサイズが自動的に変わります。
namingScheme()
→ hou.parmNamingScheme列挙値
このParmTemplateのparmタプル内のパラメータの命名に使用された命名スキームを返します。
例えば、命名スキームがhou.parmNamingScheme.XYZWで、そのparmテンプレートの名前が
"foo"で、3つのコンポーネントを持っていれば、それらのパラメータの名前は、"foox", "fooy", "fooz"になります。
一方で、命名スキームがhou.parmNamingScheme.Base1だった場合は、それらのパラメータの名前は、
"foo1", "foo2", "foo3"になります。
parmテンプレートが1個のコンポーネントしか持っていない時は、そのparm名はparmタプル名と同じです。
詳細は、hou.parmNamingSchemeを参照してください。
setNamingScheme(naming_scheme)
このParmTemplateのparmタプル内のパラメータの命名に使用する命名スキームを、hou.parmNamingScheme列挙値に設定します。
詳細は、namingSchemeメソッドを参照してください。
look()
→ hou.parmLook列挙値
パラメータペイン内のこのパラメータのルックを返します。例えば、3つのfloatのタプルは、3DベクトルまたはRGBカラーとして表示することができます。
詳細は、hou.parmLookを参照してください。
setLook(look)
このパラメータのルックをhou.parmLook列挙値に設定します。
詳細は、lookメソッドを参照してください。
help()
→ str
パラメータペイン内のパラメータラベル上にカーソルを置いた時にHoudiniが表示するヘルプを返します。
setHelp(help)
パラメータペイン内のパラメータラベル上にカーソルを置いた時にHoudiniが表示するヘルプを設定します。
isHidden()
→ bool
このパラメータをパラメータペイン内で非表示にされているかどうか返します。
hide(on)
このパラメータをパラメータペイン内で可視または不可視としてマークします。
非表示パラメータは今でも存在し、それを評価したり、チャンネル参照などもできることに注意してください。 非表示パラメータは単にパラメータペインで表示されないだけです。
isLabelHidden()
→ bool
このパラメータのラベルがパラメータペイン内で非表示にされているかどうか返します。
hideLabel(on)
このパラメータのラベルをパラメータペイン内で非表示または表示します。
joinsWithNext()
→ bool
このパラメータがパラメータペイン内で次のパラメータと同じ行に表示されているかどうか返します。
joinWithNext()
→ bool
このメソッドは廃止され、代わりにjoinsWithNextメソッドを使用してください。
setJoinWithNext(on)
このパラメータがパラメータペイン内で次のパラメータと同じ行に表示させるかどうか設定します。
disableWhen()
→ str
このメソッドは廃止され、代わりにconditionalsメソッドを使用してください。
setDisableWhen(disable_when)
このメソッドは廃止され、代わりにsetConditionalメソッドを使用してください。
conditionals()
→ dict
of hou.parmCondType enum value to string
現在このパラメータに影響を与えている条件のセットを返します。
この文字列に対する詳細は、Operator Type PropertiesウィンドウのヘルプのConditionalsセクションを参照してください。
setConditional(type, conditional)
このパラメータに対して指定したhou.parmCondTypeタイプの条件文字列を設定します。 この文字列は、他のパラメータが変わった時のこのパラメータの表示の挙動に関するルールを構成します。
この文字列に対する詳細は、Operator Type PropertiesウィンドウのヘルプのConditionalsセクションを参照してください。
tags() -> dict of string to string
parmテンプレートに保存された追加データの辞書を返します。
Houdiniは、この辞書を使用して、任意のデータをparmテンプレートに追加します。 この辞書内のキーは、ParmTemplateタイプとその使い方に応じて変わります。
scriptCallback()
→ str
このパラメータが変わった時にHoudiniが実行するスクリプトの内容を返します。 このスクリプトは、押しているボタンに反応するためのhou.ButtonParmTemplateオブジェクトで一番よく使用します。
Houdiniはtag辞書を使用してスクリプトコールバックの情報を保存します。
setScriptCallback(script_callback)
コールバックスプリプトを指定した文字列に設定します。このスクリプトは、パラメータの変化に反応して実行されます。
詳細は、scriptCallbackメソッドを参照してください。
scriptCallbackLanguage()
→ hou.scriptLanguage列挙値
このパラメータが変わった時にHoudiniが実行するスクリプトの言語を返します。
Houdiniはtag辞書を使用して、スクリプトコールバック情報を保存します。
scriptCallbackメソッドも参照してください。
setScriptCallbackLanguage(script_callback_language)
スクリプトコールバック言語をhou.scriptLanguage列挙値に設定します。
詳細は、scriptCallbackLanguageメソッドを参照してください。
setTags(tags)
このparmテンプレートに保存される追加データの辞書を設定します。
詳細は、tagsメソッドを参照してください。
asCode(function_name=None, variable_name=None)
→ str
パラメータテンプレートの再作成を実行するPythonステートメントを含んだ文字列を返します。
この文字列を実行するには、Pythonのcompile,execfileの関数またはexecステートメントを使用します。
function_name
function_nameを指定すると、その返されたコードは、指定した名前のPython関数を作成します。 function_nameは英数字とアンダースコアだけで構成されたゼロ長ではない文字列でなければなりません。 無効な文字は内部的にアンダースコアに変換されます。
この関数は、新しく作成されたパラメータテンプレートオブジェクトの参照を返します。
variable_name
結果のコードの割り当て先となるPython変数の名前。
Noneの場合、Houdiniは"hou_parm_template"という名前の変数を使用します。
以下は、出力をファイルに保存して、それをHoudiniに読み込むサンプルです:
# ターゲットパラメータテンプレートの参照を取得します。 node = hou.node("/obj/geo1") parm_template = node.parm("tx").parmTemplate() # asCodeを実行し、その出力スクリプトをファイルに書き出します。 code = parm_template.asCode() source_file = open("create_parm_template.py", "w") source_file.write(code) source_file.close() # スクリプトを実行します。新しいパラメータテンプレートは、'hou_parm_template'変数に保存されます。 execfile("create_parm_template.py") # 保存されたパラメータテンプレートを使用して、Spareパラメータをノードに追加します。 node.addSpareParmTuple(hou_parm_template)
以下は、出力をファイル内の関数に保存して、それをHoudiniからコールするサンプルです:
# ターゲットパラメータテンプレートの参照を取得します。 node = hou.node("/obj/geo1") parm_template = node.parm("tx").parmTemplate() # asCodeを実行して、その関数定義をファイルに書き出します。 code = parm_template.asCode(function_name="createParmTemplate") source_file = open("parmtemplatelib.py", "w") source_file.write(code) source_file.close() # 関数定義をコールします。 import parmtemplatelib hou_parm_template = parmtemplatelib.createParmTemplate() # 保存されたパラメータテンプレートを使用して、Spareパラメータをノードに追加します。 node.addSpareParmTuple(hou_parm_template)