Houdini 20.5 ヘルプの使い方

カスタムサンプルの作成

On this page

概要

このページでは、カスタムヘルプサーバーを起動している時に、あなた独自のノードのサンプルファイルの作成とそれらをドキュメントに統合する方法を説明しています。

How to

サンプルファイルを作成するために:

  1. オブジェクトレベルのアセット 内にサンプルをカプセル化し、それをHDAファイルに保存します。HDAファイルには 1個のオブジェクトレベルアセット のみを格納するべきです。

    Tip

    サンプルで必要なサポートファイル(.bgeo、.picなど)をHDAファイルのセクションとして含めて、そのセクションを参照してください。

  2. wikiフォーマットを使って、サンプルの説明を記述した.txtファイルを作成し、.hdaファイルと同じ名前(拡張子を除く)にします。例えば、MyNodeExample.hdaとMyNodeExample.txtというようにします。

  3. Houdiniパス内のどこかにファイルを配置します:

    HOUDINIPATH/Help/examples/nodes/‹nodetype›/‹nodename›/

    例:

    HOUDINIPATH/
    Help/
        examples/
            nodes/
                sop/
                    mysop/
                        MyNodeExample.hda
                        MyNodeExample.txt

Wikiプロパティ

サンプルの説明を記述したテキストファイルには、ページプロパティを使用することで、サーバーがそのサンプルを検索する方法を制御することができます。

  • なにかしらの理由でテキストファイル(.txt)をサンプルファイル(.hda)と同じ名前にできない場合は、ページプロパティを使用することで、テキストファイルにサンプルファイルの場所を指すことができます:

    #examplefile: example.hda

    パスには、テキストファイルの絶対パス(/で始まるパス)または相対パスを指定することができます。

  • HOUDINIPATH/Help/examples/nodes/‹nodetype›/‹nodename›/にサンプルファイルを配置すると、サーバーは、そのサンプルをそのノードタイプと自動的に関連付けます。

    サンプルを2つ以上のノードタイプと関連付けたい場合や、なにかしらの理由で別の場所にサンプルを配置したい場合は、手動でそのサンプルと関連付けたいノードパスをスペース区切りのリストで指定することができます:

    #examplefor: /nodes/sop/MyAsset /nodes/dop/HerAsset

ローダー

ローダーマークアップを使用すれば、ヘルプページ内にサンプルファイルを読み込むためのボタンを作成することができます。

CopyAttributes

Copy SOPはジオメトリをコピーするだけでなく、それ以上のこともできます。このサンプルでは、Copy SOPを使ってテンプレートジオメトリ(またはポイント)からカラーアトリビュートをコピーしたジオメトリに転送しています。

カラー情報を追加したポリゴンの球をソースジオメトリとして使用しています。球からカラーアトリビュート(Cd)付きのポイントを抽出し、それをCopy SOPでテンプレートとして使用します。Copy SOPはカラー情報をコピーしたポリゴンの円に転送します。

個々のローダー

load_exampleブロックは、1個のHoudiniノードサンプルのローダーを表示します。

:load_example: Copy Attributes example
    #examplefile: /examples/nodes/sop/copy/CopyAttributes.otl
    #examplefor: /nodes/sop/copy

  • #exampleforプロパティを省略することができます。

  • #path:プロパティにサンプルの説明(.txt)ページを指定すると、そのタイトル、#examplefile、#exampleforを省略することができます。ヘルプシステムは、その参照したページからそれらの情報を取得します。

    :load_example:
    #path: /examples/nodes/sop/copy/CopyAttributes

  • #include: yesプロパティを追加すると、#pathで参照されているページの内容が自動的にローダーに含まれます:

    :load_example:
    #path: /examples/nodes/sop/copy/CopyAttributes
    #include: yes

    これは以下と同じです:

    :load_example:
    #path: /examples/nodes/sop/copy/CopyAttributes

    :include /examples/nodes/sop/copy/CopyAttributes:

    ヘルプシステムは、タイトルと要約がload_exampleブロックに含まれている時、それらを自動的に取り除きます。

サンプルリスト

list_examplesブロックは、検索リストブロックと同様ですが、その結果をサンプルローダーとして表示します。

:list_examples:
    #query: path:/examples/nodes/sop/*
    #groupedby: examplefor

ヘルプの使い方

基本

ノードのドキュメント化

セントラルヘルプサーバーの起動