ギャラリーエントリーとは、オペレータノードのセットアップに関するデータを含んだエンティティです。 このエントリーは、ノードのパラメータ値、追加したSpareパラメータ、チャンネルに関する情報を持ち、 サブネットノードに関しては、その子に関する情報などを持ちます。 そのため、ギャラリーエントリーとはノードテンプレートやパラメータプリセットのようなものです。 そのようなテンプレートを作成して、それを既存ノードに適用することができます。
ギャラリーエントリーは、固有に識別されていて、非固有なラベルを持っていて、通常では その適用先のノードの特定のhou.NodeType(またはいくつかのノードタイプ)と関連付いています。 ノード情報に加えて、ギャラリーエントリーは、管理可能なセットにまとめる独自のカテゴリを持つことができ、 さらに目的を区分するためのキーワードを持つことができます。 ギャラリーエントリーに関する詳細は、ギャラリーエントリーエディタを参照してください。
ギャラリーエントリーをMaterial Paletteペインに表示させるには、2つの条件が満たされていなければなりません。 1つ目の条件は、ギャラリーエントリーがSHOPノードを作成することを示すようにノードカテゴリを設定しなければなりません。 以下のようなコードを使用します:
hou.galleries.galleryEntries("entry_name")[0].setNodeTypeCategory(hou.shopNodeTypeCategory())
2つ目の条件は、SHOPが動作するレンダラーを示すように、そのエントリーに1個以上のキーワードがなければなりません。 これは、特定のレンダラーをMaterial Paletteレンダラーメニューで選択する時に、そのギャラリーエントリーを表示させるかどうかに影響します。 たとえ、そのメニューで“All”を選択しても、そのギャラリーエントリーには、そのメニューに表示させるレンダラーの1つに一致するキーワードがなければなりません。 ギャラリーエントリーをMantraレンダラーと関連付けるには、以下のことをします:
hou.galleries.galleryEntries("entry_name")[0].setKeywords(('Mantra',))
HOMでは、ギャラリーエントリーはhou.Galleryを使用して管理することができます。
メソッド ¶
allowIconRegeneration()
→ bool
このギャラリーエントリーが適切なレンダラーを使用してHoudiniにアイコンを自動的に再生成させている場合はTrueを返します。
これは、マテリアルギャラリーエントリーにのみ適用されます。
applyToNode(node)
ギャラリーエントリを指定したノードに適用します。このメソッドは、ノードのパラメータ値が、そのエントリーに保存されている値に一致するように設定します。 また、Spareパラメータとチャンネルをノードに追加することもでき、サブネットに関しては、新しい子ノードを作成することができます。
node
ギャラリーエントリーの適用先のノード。
bestNodeType()
→ NodeType or None
このギャラリーエントリーが関連付けられていて、そのエントリーを適用できるノードで一番良いノードタイプを返します。
canApplyToNode(node)
→ bool
このギャラリーエントリーを指定したノードに安全に適用できる場合はTrueを返します。
詳細は、hou.GalleryEntry.applyToNodeを参照してください。
node
そのギャラリーエントリーが適用できるかどうかテストするためのノード。
canCreateChildNode(parent)
→ bool
hou.GalleryEntry.createChildNodeが成功するならTrueを返します。
categories()
→ tuple of strings
このギャラリーエントリーが属しているカテゴリを返します。
createChildNode(parent)
→ Node
親ネットワーク内に新しいノードを作成してから、このギャラリーエントリーをその新しく作成したノードに適用します。
parent
新しくノードを作成するべきサブネットワーク。Noneの場合は、このギャラリーエントリーと関連付けられているノードタイプを使用して、暗黙的に自然な親が選択されます。
description()
→ string
ギャラリーエントリーの説明を返します。この説明とは、ギャラリーエントリーの目的を述べた短い文字列のことです。 これは、ツールチップのポップアップ表示に使用されます。
helpURL()
→ string
このギャラリーエントリーのヘルプドキュメントのURLを返します。
isHidden()
→ bool
このギャラリーエントリーがツールギャラリーメニューから非表示になっていればTrueを返します。
icon()
→ string
このギャラリーエントリーに使用したいアイコン名またはアイコンのファイルパスを返します。
keywords()
→ tuple of strings
このギャラリーエントリーを説明したキーワードを返します。
label()
→ str
ギャラリーエントリーラベルを返します。
name()
→ string
ギャラリーエントリー名を返します。
nodeTypeCategory()
→ NodeTypeCategory
このギャラリーエントリーと関連付いているノードタイプのカテゴリを返します。
nodeTypeNames()
→ tuple of strings
このギャラリーと関連付いているノードタイプの名前を返します。 そのギャラリーをそれらのタイプのノードに安全に適用することができます。
requiredHDAFile()
→ string
このギャラリーエントリーの適用を試みる前に読み込むべきHDAライブラリのファイルパスを返します。 これは、非ネイティブオペレータタイプと関連付けられているギャラリーエントリーによく使用されます。
script()
→ string
ギャラリーエントリーに記録されている情報と一致するようにノードパラメータを修正するスクリプトを返します。
setAllowIconRegeneration(allow)
このギャラリーエントリーにアイコン再生成可能フラグを設定します。
setCategories(categories)
このギャラリーエントリーが属するカテゴリを設定します。
categories
ギャラリーエントリーの設定先となるカテゴリを含んだ文字列のシーケンス。
setContentsFromNode(node)
ノードの内容(例えば、子ノード)に関する情報を保存します。 後でノードエントリーを適用した時、それらのノードが、現行の親の内容に一致するように新しい親の中で再構築されます。
node
保存すべきデータのノードの親。
setDescription(description)
ギャラリーエントリーの説明を設定します。
description
ギャラリーエントリーの目的を短く記述したテキスト。
setEqual(entry)
このギャラリーエントリーを指定したエントリーとまったく同じに設定します。ただし、名前は同じではなく変わりません。
entry
情報のコピー元であるギャラリーエントリー。
setHelpURL(helpurl)
このギャラリーエントリーのヘルプドキュメントのURLを設定します。
setHidden(hide)
ギャラリーエントリーをツールギャラリーメニューに表示するかどうかを制御する非表示フラグを設定します。
setIcon(icon)
このギャラリーエントリーに使用するアイコン名またはアイコンのファイルパスを設定します。
setKeywords(keywords)
このギャラリーエントリーを説明したキーワードを設定します。
keywords
キーワードをスペースで区切たリストを含んだ文字列。
setLabel(label)
ギャラリーエントリーラベルを設定します。
label
ラベルの文字列。
setName(name)
ギャラリーエントリー名を設定します。
name
名前の文字列。
setNodeTypeCategory(category)
このギャラリーエントリーと関連付けるノードタイプのカテゴリを設定します。
category
このギャラリーエントリを関連付けるhou.NodeTypeCategory。
setNodeTypeNames(nodetypes)
このギャラリーを関連付けるノードタイプの名前を設定します。
nodetypes
ノードタイプ名をスペースで区切ったリストを含んだ文字列。
setRequiredHDAFile(hda_file)
このギャラリーエントリーが依存するHDAライブラリのファイルパスを設定します。
hda_file
HDAライブラリファイル(OTL)のパス。
setScript(script)
ギャラリーエントリーをノードに適用する時に、そのパラメータを修正するスクリプトを設定します。
script
ノードのパラメータを設定するコマンドを含んだ文字列。
setScriptFromNode(node)
ノードパラメータを修正するスクリプトを設定します。後で、このギャラリーエントリーをノードに適用する時、 そのスクリプトは、このメソッドに渡されたノードのパラメータとまったく同じになるようにそのノードのパラメータを再構築します。
node
スクリプトの構築元となるノードオブジェクト。