| Inheritance |
|
メソッド ¶
__init__(name, label, menu_items, menu_labels=(), default_value=0, icon_names=(), item_generator_script='', item_generator_script_language=None, disable_when=None, menu_type=hou.menuType.Normal, is_hidden=False, is_label_hidden=False, join_with_next=False, help=None, script_callback=None, script_callback_language=hou.scriptLanguage.Hscript, tags={}, default_expression="", default_expression_language=hou.scriptLanguage.Hscript, store_default_value_as_string=False, menu_use_token=False, is_button_strip=False, strip_uses_icons=False)
name
詳細は、hou.ParmTemplate.nameを参照してください。
label
詳細は、hou.ParmTemplate.labelを参照してください。
default_value
詳細は、defaultValueメソッドを参照してください。
icon_names
詳細は、iconNamesメソッドを参照してください。
このパラメータが空っぽのタプルの場合は、メニューにアイコンが含まれません。
item_generator_script
See the itemGeneratorScriptメソッドを参照してください。
item_generator_script_language
詳細は、itemGeneratorScriptLanguageメソッドを参照してください。
このパラメータがNoneの場合は、デフォルトがhou.scriptLanguage.Pythonです。
disable_when
詳細は、hou.ParmTemplate.disableWhenを参照してください。
join_with_next
詳細は、hou.ParmTemplate.joinsWithNextを参照してください。
help
詳細は、hou.ParmTemplate.helpを参照してください。
script_callback
詳細は、hou.ParmTemplate.scriptCallbackを参照してください。
script_callback_language
詳細は、hou.ParmTemplate.scriptCallbackLanguageを参照してください。
default_expression
詳細は、defaultExpressionメソッドを参照してください。
default_expression_language
詳細は、defaultExpressionLanguageメソッドを参照してください。
store_default_value_as_string
Trueに設定すると、このテンプレートは、ダイアログスクリプトのデフォルトのインデックスとHoudini内部の他のパラメータフォーマットの代わりに、選択したデフォルトの文字列を格納します。
strip_uses_icons
詳細は、hou.ParmTemplate.isIconStripを参照してください。
MenuParmTemplatesは1個のコンポーネントしか持てないことに注意してください。
setMenuItems(menu_items)
内部メニュー名を、指定した文字列シーケンスに設定します。
詳細は、menuItemsメソッドを参照してください。
新しいメニューアイテムの数が古いメニューアイテムの数よりも少ない場合、それらのメニューラベルは減らされ、そのデフォルト値が範囲外なら変更されます。
setMenuLabels(menu_labels)
UIに表示されるメニューラベルを、指定した文字列シーケンスに設定します。
メニューラベルの数がメニューアイテムの数よりも少ない場合、Houdiniは、その足りないラベルに対して内部メニューアイテム名を使用します。 ラベルの数がメニューアイテムの数よりも多い場合、Houdiniは、その余分なラベルを破棄します。
メニューアイテムとメニューラベルの両方を変更したいのであれば、まず最初にメニューアイテムを変更してください。
defaultValue()
→ int
デフォルトメニューアイテムのインデックスを返します。
defaultValueAsStringメソッドも参照してください。
setDefaultValue(default_value)
デフォルトメニューアイテムのインデックスを設定します。
Note
このインデックスがメニューアイテムエントリーの範囲外の場合は、そのインデックスが調整されます。 メニューをスクリプトから駆動させた場合、つまり、itemGeneratorScriptに空っぽでない値を設定した場合、 このデフォルト値は調整されません。
defaultExpression()
→ string
評価時にデフォルトメニューアイテムのインデックスを返すエクスプレッションを返します。
デフォルトエクスプレッションはデフォルト値よりも優先度が高いです。 デフォルトエクスプレッションが設定されていない場合(つまり、空っぽの文字列)、代わりにデフォルト値が使われます。
デフォルトエクスプレッションの意味を解釈するには、デフォルトのエクスプレッション言語が必要であることに注意してください。
setDefaultExpression(default_expression)
評価時にデフォルトメニューアイテムのインデックスを返すデフォルトエクスプレッションを設定します。
default_expressionが空っぽの文字列の場合は、デフォルトエクスプレッションが未設定になります。
defaultExpressionLanguage()
→ hou.scriptLanguage
デフォルトのエクスプレッション言語を返します。
このデフォルトのエクスプレッション言語は、デフォルトエクスプレッションが設定されている場合にのみ適用されます。 デフォルトエクスプレッションが設定されていない場合は、エクスプレッション言語はhou.scriptLanguage.Hscriptに設定されます。
setDefaultExpressionLanguage(default_expression_language)
デフォルトのエクスプレッション言語を設定します。
詳細は、defaultExpressionLanguageメソッドを参照してください。
defaultValueAsString()
→ str
デフォルトメニューアイテムの内部名を返します。
このメソッドは、以下のように実装されています:
def defaultValueAsString(self): return self.menuItems()[self.defaultValue()]
iconNames()
→ tuple
of str
メニューアイテムに相当するアイコンのタプルを返します。 アイコンがなければ、空っぽの文字列のタプルを返します。
setIconNames(icon_names)
アイコン名を、指定した文字列シーケンスに設定します。
itemGeneratorScript()
→ str
メニューアイテムの生成に使用されるスクリプトを返し、そのようなスクリプトがなければ空っぽの文字列を返します。
アイテムを生成するスクリプト言語がhou.scriptLanguage.Pythonであれば、 このスクリプトは、単一行のPythonエクスプレッションかPython関数のマルチラインボディのどちらかです。
setItemGeneratorScript(item_generator_script)
メニューアイテムの生成に使用するスクリプトを設定します。
詳細は、itemGeneratorScriptメソッドを参照してください。
itemGeneratorScriptLanguage()
→ hou.scriptLanguage列挙値
メニューアイテムを生成するスクリプト用のプログラミング言語を返します。
setItemGeneratorScriptLanguage(language)
メニューアイテムの生成に使用されるスクリプト言語を、hou.scriptLanguage列挙値に設定します。
詳細は、itemGeneratorScriptLanguageメソッドを参照してください。
setMenuType(menu_type)
メニューのタイプをhou.menuType列挙値に設定します。
詳細は、menuTypeメソッドを参照してください。
setMenuUseToken(on)
インデックスの代わりにトークン値をパラメータに設定します。
menuUseTokenメソッドも参照してください。
setAsMenu()
パラメータをデフォルトのメニュードロップダウンに戻します。
setAsButtonStrip, setAsIconStripのメソッドも参照してください。
isMenu()
→ bool
パラメータがドロップダウンメニューウィジェットを使用するように設定されているかどうかを返します。
setAsButtonStrip()
パラメータがButton Stripウィジェットを使用するように設定します。
setAsMenu, setAsIconStripのメソッドも参照してください。
isButtonStrip()
→ bool
パラメータがButton Stripウィジェットを使用するように設定されているかどうかを返します。
setAsIconStrip()
パラメータがIcon Stripウィジェットを使用するように設定します。
setAsMenu, setAsButtonStripのメソッドも参照してください。
isIconStrip()
→ bool
パラメータがIcon Stripウィジェットを使用するように設定されているかどうかを返します。
Methods from hou.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)