これはシェルフ設定ファイルのトップレベルのエレメントです。このエレメント内にshelfSet、toolshelf、toolのエレメントを含めることができます。

ユーザーがグループとして読み込むことができるシェルフセットを定義します。このエレメント内にはmemberToolshelfを含めます。

任意で<readOnly/>サブエレメントを追加すれば、ユーザーがHoudiniでタブセットを編集できないようにすることができます。

(shelfSetのゼロ個以上のサブエレメント)シェルフセットの一部としてシェルフタブを指定します。

シェルフタブ上にツールを定義します。このエレメント内にはmemberToolエレメントを含めます。

任意で<readOnly/>サブエレメントを追加すれば、ユーザーがHoudiniでシェルフタブを編集できないようにすることができます。

(toolshelfのゼロ個以上のサブエレメント)シェルフタブの一部としてツールを指定します。

シェルフツールを定義します。

このエレメントには、ユーザーがツールをクリックした時に実行するスクリプトを指定するscriptサブエレメントがなければ なりません 。

任意で<readOnly/>サブエレメントを追加すれば、ユーザーがHoudiniでツールを編集できないようにすることができます。

toolエレメントのtoolMenuContextエレメント内にcontextNetTypeまたはcontextOpTypeエレメントを指定していない場合、ツールが⇥ Tabメニューに表示されません。

(toolで必須のサブエレメント) ツールをクリックした時に実行するPythonスクリプトまたはHScript。

通常では、CDATAタグをスクリプトにラップすることで、スクリプト内の<、>、&の文字が原因でXMLエラーが起きることを防止します。

<shelfDocument>
    <tool name="sample_tool" label="Sample Tool" icon="PLASMA_App">
        <script scriptType="python"><![CDATA[

        hou.ui.displayMessage("Hello world!")

        ]]></script>
    </tool>
</shelfDocument>

(toolの任意のサブエレメント) ユーザーがツールのヘルプを見る時にブラウザが表示するwikiフォーマットまたはHTMLのヘルプ。これは、helpURLタグで上書きされます。

通常では、CDATAタグをヘルプテキストにラップすることで、ヘルプ内の<、>、&の文字が原因でXMLエラーが起きることを防止します。

(toolの任意のサブエレメント) ユーザーがツールのヘルプを見る時にブラウザが読み込むURL。helpURLとhelpTextの両方が存在し、空っぽでなかった場合、HoudiniはhelpURLを使います。

(toolの任意のサブエレメント) A list of menu labels, separated by /文字で区切ったメニューラベルのリストで、ツールを⇥ Tabメニューのどのサブメニューに表示させるのか指定します。

例えば、<toolSubmenu>My Tools/Shaping</toolSubmenu>と記述して、ツールを⇥ Tabメニューの My Tools ▸ Shaping サブメニューに表示させる場合は、以下のようにします。

<shelfDocument>
    <tool name="sample_tool" label="Sample Tool" icon="PLASMA_App">
        <script scriptType="python">...</script>
        <toolSubmenu>Fee/Fi/Fo/Fum</toolSubmenu>
        <toolMenuContext name="network">
                <contextNetType>OBJ</contextNetType>
        </toolMenuContext>
    </tool>
</shelfDocument>

• ツールを⇥ Tabメニューに表示させる場合は、ツールにtoolMenuContextがなければならないことに注意してください。

• ラベルマッチングは、大文字・小文字の区別があります。

• 存在しないサブメニューは、作成されます。

(toolのゼロ個以上のサブエレメント) このツールを⇥ Tabメニューのどのコンテキストに表示するのか指定します。

(toolMenuContextのゼロ個以上のサブエレメント)このタイプのネットワークにのみツールを⇥ Tabメニューで表示します。contextNetTypeエレメントを複数指定すれば、複数のネットワークタイプにツールを表示させることができます。

このエレメントのテキストは、ネットワークタイプです。設定可能な値は、OBJ(シーンレベル)、SOP(ジオメトリネットワーク)、POP(パーティクルネットワーク)、DOP(ダイナミクスネットワーク)、CHOP、ROP(レンダーネットワーク)、SHOP(マテリアルネットワーク)、COP2(コンポジットネットワーク)、VOP、VOPNETです。

例えば、オブジェクト、ジオメトリ、パーティクルのネットワークエディタにのみ⇥ Tabメニューにツールを表示させる場合:

<toolMenuContext name="network">
    <contextNetType>OBJ</contextNetType>
    <contextNetType>SOP</contextNetType>
    <contextNetType>POP</contextNetType>
</toolMenuContext>

(toolMenuContextのゼロ個以上のサブエレメント) これをtoolMenuContextのサブエレメントとして指定する場合、このタイプのノードを作成可能なネットワークにのみ⇥ Tabメニューにツールを表示します。

このエレメントのテキストは、Object/geoまたはSop/copyのようにノード固有です。

両方とも指定した場合、contextOpTypeはcontextNetTypeを上書きします。以下のサンプルでは、ツールはジオメトリ(SOP)ネットワークの⇥ Tabメニューに表示されません。なぜなら、contextNetTypeが一致しても、contextOpTypeが一致していないからです。

<toolMenuContext name="network">
    <contextOpType>Object/my_asset</contextOpType>
    <contextNetType>OBJ</contextNetType>
    <contextNetType>SOP</contextNetType>
    <contextNetType>POP</contextNetType>
</toolMenuContext>

これを空っぽのエレメントとしてshelfSet、toolshelf、toolエレメントに追加することで、ユーザーがタブセットを編集できないようにすることができます。

<?xml version="1.0" encoding="utf-8" ?>
<shelfDocument>
    <tool name="scribble" label="Scribble">
        <readOnly/>
        <script scriptType="python">
        ...
        </script>
    </tool>
</shelfDocument>