レシピの一部としてスクリプトを実行することができます。 たいていの場合、レシピでキャプチャされたパラメータ値を適用したり、キャプチャされたノードを生成したりするだけで十分です。 しかし、その生成された値やノードを現在の状態に合うように変更したい場合もあります。例えば:

• シミュレーションされる炎のレシピを配置する時に、現在のビューポートに合わせてボリューム光源をオン/オフする必要がある場合。

• レシピでカメラを作成する時、現行ビューポートに合わせる必要がある場合

プリスクリプトとポストスクリプトを使用することで、レシピの適用前または適用後にPythonを実行することができます。

レシピは、内部ではdata.recipe.jsonに格納されている宣言的なデータモデルに基づいてキャプチャデータを格納します。 このセクションには、そのレシピに関連する他のプロパティも格納されます。

既存のノードからレシピを作成するスクリプトを書くには、以下のHOM関数を使用します:

• hou.data.saveParmPresetRecipe

• hou.data.saveNodePresetRecipe

• hou.data.saveDecorationRecipe

• hou.data.saveToolRecipe

ネットワーク内にレシピを適用するスクリプトを書くには、以下のHOM関数を使用します:

• hou.data.applyParmPresetRecipe

• hou.data.applyNodePresetRecipe

• hou.data.applyDecorationRecipe

• hou.data.applyToolRecipe

Parameter Presetレシピを作成する場合、または、Recipe Builderを使用する場合、レシピ適用前に実行されるプリスクリプト用パラメータとレシピ適用後に実行されるポストスクリプト用パラメータを使用することができます。

レシピは、内部では、プリスクリプトをpre-script.recipe.pyセクションに、ポストスクリプトをpost-script.recipe.pyセクションに格納します。

この使用例は、ツールレシピでノードセットを作成したいものの、それらのノードのうち1つのノードにプリセットレシピを適用したい場合の例です。

ノードに正しい値を適用した状態でツールレシピを保存することもできますが、プリセットレシピに依存するツールレシピをリセットすることなくそのプリセットレシピを変更できる柔軟性が欲しい場合があります。 これを行なうには、ツールレシピを適用してから、作成されたノードの1つを検索して、そのノードにプリセットを適用するようなツールまたはRecipe Builderのスクリプトを作成することで可能です。

hou.data.applyToolRecipe("first_recipe")
node = kwargs["items"]["foobar"]
hou.data.applyNodePresetRecipe("second_recipe", node)

この使用例は、ノードに対して利用可能なレシピをOrdered Menu(プリセットメニュー)に表示し、そのメニューから項目を選択する度にレシピを呼び出す方法の例です。

1. ノードに対して複数のNode PresetまたはParameter Presetを作成します。 Recipe Builderを使用した場合、 Submenu パラメータを使用することで、レシピをカテゴリに分けることができます。

2. Edit Parameter Interfaceウィンドウを開いて、プリセットメニューとして設定したい Ordered Memu パラメータをクリックします。

3. Menu タブで Use Menu トグルをオンにして、 Menu Script タブに以下のコードを入力します。 このコードは、サブメニューをMaterialsに設定して作成されたレシピに基づいて、プリセットメニューの項目を構築します。 submenuが空っぽの文字列の場合、そのメニューにはそのノードで利用可能なすべてのプリセットが表示されます。

   import recipeutils as ru
   return ru.buildPresetMenu(kwargs,
                               submenu='Materials')
   

4. Parameter タブで、 Callback Script に以下のコードを設定します。 これによって、このプリセットメニューから項目を選択する度にレシピが呼び出されます。

   import recipeutils as ru; ru.setPresetMenu(kwargs)
   

プリセットが選択された時にデフォルト状態に戻るプリセットメニューを設定するには、上記の手順に従い、コードを以下のように変更します:

• 各プリセットレシピのポストスクリプトとして以下のコードを入力します。 presetmenuはプリセットメニューパラメータの名前です。 これによって、 Recipeメニューからプリセットを呼び出した時にも、プリセットパラメータが変更されます。

  kwargs['node'].parm('presetmenu').set(0)
  

• Edit Parameter Interface ウィンドウ内のプリセットパラメータに対して、 Menu Script タブに以下のコードを入力します:

  import recipeutils as ru
  return ru.buildPresetMenu(kwargs,
                          submenu='Materials',
                          revert=True,
                          revert_token='materials',
                          revert_label='Materials')
  

• Callback Script パラメータには、以下のコードを入力します:

  import recipeutils as ru; ru.setPresetMenu(kwargs, revert=True)
  

この使用例は、作成されたデコレータノードを特定の方法で接続する複雑な挙動の例です。 このレシピは、アンカーノードの入力にマージノードが接続されるようにして、新しく作成されるすべてのデコレーションがそのマージノードに接続されるようにします。

1. LOPネットワーク内にRecipe Builderノードを作成します。

2. そのサブネットワークの中に入って、2個のNullノードを追加します。

3. それらの新しいNullノードを接続して、それぞれ名前をstart1、end1に変更します。

   Note

   end1を既存のnull1ノードに接続しないでください。

4. Recipe Builderノードに戻って、以下の設定を行ないます:

   • Recipe Category を Decoration に設定します。

   • Internal Name をdecoration_mergerに設定します。

   • Label をDecoration Mergerに設定します。

5. Scripts タブで、 Before Data Applied を有効にして、以下のコードを入力します:

   # 作成後のノードの再配置を強制的に無効にします。
   kwargs['avoid_overlap'] = False)
   

6. Scripts タブで、 After Data Applied を有効にして、以下のコードを入力します:

   from recipeutils import pprint
   
   # まず最初にターゲットノードを取得します。
   target_node = kwargs['central_node']
   
   merge_node = None
   
   # ターゲットノードに入力がなかった場合、マージノードを作成します。
   if len(target_node.inputs()) == 0:
       # 命令的なPython関数ではなく、データを使用してマージノードを作成します。
       merge_node_name = 'wire_nodes_into_here'
       result = hou.data.createItemsFromData(target_node.parent(), {
           merge_node_name : {
               "type": "merge",
               "position": [target_node.position().x(), target_node.position().y() + 1.0], # offset merge node upwards
               "outputs": [
                   {
                       "to": target_node.name(),
                       "to_index": 0,
                       "from_index": 0,
                   }
               ]
           }
       })
       # 作成されたノードから実際のhou.Nodeオブジェクトを取得します。
       # このキーは、データ内のノード名です。
       merge_node = result[merge_node_name]
   else: # ターゲットノードに入力があった場合、1番目の入力からノードを取得します。
       # 場合によっては、ここでそのノードがマージノードかどうかをチェックしたいかもしれませんが、この例ではその手順をスキップします。
       merge_node = target_node.inputs()[0]
   
   # pprint(kwargs['items'])
   # 同様に、チェーン内の末端ノードを取得します。その末端ノードはデータ内では'end1'として記録されているので、それをキーとして使用します。
   end_node = kwargs['items']['end1']
   
   if merge_node: # この時点で、有効なマージノードが取得できているはずです。
       # データ関数を使用して入力コネクションを作成します。
       # 既存のコネクションを取得して、それをデータに追加します。
       input_data = merge_node.inputsAsData()
   
       input_data.append({
           "from": end_node.name(), # これによって、確実に正しい名前が取得されます。
           "from_index": 0,
           "to_index": len(input_data),
       })
   
       # コネクションを作成します。
       merge_node.setInputsFromData(input_data)
   

7. Recipe タブで、 Save Recipe をクリックします。

8. LOPネットワーク内にNullノードを追加して、 Decoration Merger レシピを複数回呼び出します。すると、以下の結果が得られます:

   

• 生成されたレシピデータ構造を読みやすい形式で出力するには、以下のスクリプトを使用します。

  import recipeutils as ru
  

• recipeutilsモジュールを使用すると、利用可能なNode Presetなどのレシピ情報をプリントすることができます。例:

  import recipeutils as ru
  
  names = ru.recipeNames(ru.RecipeCategory.nodePreset,
                          nodetype_categories=hou.sopNodeTypeCategory(),
                          include_label=True, pad=True)
  
  ru.pprint(names)
  

  また、name_patternオプションを指定することで、レシピの内部名に基づいてレシピをフィルタリングすることができます。