• コードが実行されたかどうかをチェックする必要がある場合、一番簡単な方法は、hou.ui.displayMessageをコールすることです:

  import hou
  hou.ui.displayMessage("I ran! I ran so far away!")
  

  これを使用することで、変数の値も表示することができます。例えば、イベントハンドラーでkwargsグローバル変数の内容を調べるには:

  import hou
  hou.ui.displayMessage(repr(kwargs))
  

• ディスク上のモジュールにコードを置いて、それをハンドラースクリプトからコールすることで、そのコードをハンドラー間で共有することができます。例えば、ハンドラースクリプトは共通の関数にkwargsを渡すことができます:

  import companyutils
  
  companyutils.on_created(kwargs)
  

• Houdiniには、非常に膨大で強力(なのに冗長な)APIセットが用意されています。APIリファレンスで利用可能なAPIをブラウズすることで、何がスクリプトで可能なのか調べることができます。

• 一般的には、Houdiniは、HOUDINI_PATH/scripts/下でディスク上の“スクリプト”(通常はコールバックスクリプト)を探すのに対し、インポートされるモジュールはHOUDINI_PATH/scripts/python/またはHOUDINI_PATH/pythonX.Ylibsに置きます。

Houdiniは、Houdiniパスで指定されたディレクトリで以下のディレクトリ/ファイルを探します。

Houdiniは、保存の前と後でスクリプトを実行することができます。 これは、保存の度にアセット管理とソースコントロールのツールを更新するのに役立ちます。

• HOUDINI_PATH/scripts/beforescenesave.pyが存在すれば、Houdiniはシーンファイルを保存する前にそれを実行します。

• HOUDINI_PATH/scripts/afterscenesave.pyが存在すれば、Houdiniはシーンを保存した後にそれを実行します。

これらのスクリプトは、kwargsグローバル辞書に含まれているコンテキストで実行されます。この辞書には以下の項目が含まれています:

以下のコードは、ファイルを保存した時にgitにコミットされるようにそのファイルを自動的に“ステージ”します:

# afterscenesave.py
import subprocess

# 保存に成功していて、それが自動保存でなかった場合にのみコマンドを実行します。
if kwargs["success"] and not kwargs["autosave"]:
    # gitコマンドにシーンファイルのパスを渡します。
    subprocess.call("git", "add", kwargs["file"])

シーンファイルが変更された時にHoudiniがコールするコールバック関数を登録することができます。 Houdiniは、この関数を1個の引数を使ってコールします。この引数は、発生したイベントのタイプを表現したhou.hipFileEventTypeオブジェクトです。

このスクリプトは、特定のイベントに限定されているわけでなく、どのイベントからでもコールされ、そのイベントがあなたの興味のあるイベントなのかどうかを確認するには、そのイベントタイプをチェックする必要があります。 いくつかのイベントに反応するコードを共有させたいことが多いので、これは通常ではシーンイベントで非常に役立ちます。

このスクリプトにhou.hipFileモジュール内の関数を使用することで、現在のシーンファイルに関する情報を取得することができます。 各ファイル操作(New file, Open file, Import file, Save)には、それに相当する“Before”と“After”のイベントタイプがあるので、その操作の変更前と変更後でのシーンファイルの値を読み込むことができます。

例えば、新しいシーンファイルが読み込まれる度に何かのコードを実行するには:

def scene_was_loaded(event_type):
    if event_type == hou.hipFileEventType.AfterLoad:
        print("The user loaded", hou.hipFile.path())

Pythonパラメータエクスプレッション参照。

Houdiniは、シーンファイルに関連するPythonモジュールを保持します。 これは、 Window ▸ Python Source Editor を使って編集することができます。 これにより、シーンファイルに固有の関数, クラス, オブジェクトを保存するのに便利な場所が与えられ、自動的にそれらが保存されて、シーンファイルと一緒にロードされます。

シーンファイルがロードされた場合(または、ソースコードを編集する場合)、モジュールのソースコードが評価され、他のPythonコードで、モジュールをhou.sessionとして使用できるようになります。

例えば、Python Source Editor内にlog_deletion()関数を記述しておけば、以下のようにアセット削除コールバックからその関数をコールすることができます:

hou.session.log_deletion()

hou.appendSessionModuleSource()関数を使用して、プログラムでhou.sessionソースコードを修正することができます。 ソースコードは、シーンファイルに保存されます。

各デジタルアセットタイプには、シーンファイルのhou.sessionモジュールに似たPythonモジュールがあります。 このモジュールを使用して、アセットタイプに固有の関数, クラス, オブジェクトを保存することができます。

モジュールのソースコードは、(Type Propertiesウィンドウの Extra Files タブにある)PythonModuleという名前のアセットのセクションに保存されます。 このセクションは手動で作成することができます。または、 Scripts タブで“Python Module”イベントハンドラーを作成すると、Houdiniは、このセクションを自動的に作成します。

HDAモジュールのコードでは、以下のコードを使用することで、HDAのノードタイプの参照を取得することができます:

nodetype = kwargs["type"]

(NodeTypeオブジェクトがある場合は)hou.NodeType.hdaModuleメソッドにより、または(Nodeオブジェクトがある場合は)hou.OpNode.hdaModuleメソッドにより、モジュールにアクセスすることができます。 例えば、myassetオブジェクトタイプで、myfunc関数をコールするには:

hou.nodeType(hou.objNodeTypeCategory(), "myasset").hdaModule().my_function()

アセットの定義内にあるノードのPythonエクスプレッションは、相対参照によりPythonModuleにアクセスすることができます。 例えば、アセットの定義のサブネットワークにあるノードのPythonパラメータエクスプレッションは、hou.node("..").hdaModule().foo()を使用することができます。

アセット内に多くのPythonコードがあり、複数のモジュール内へ整理したい場合、他のHDAセクションを作成して、これらのモジュールを保存することができます。 例えば、Pythonコードを含むFooModuleセクションを作成することができます。 次に、メインのPythonModuleセクションで、以下のコードを使用して、FooModuleのコンテンツをfooとしてインポートします:

import toolutils
foo = toolutils.createModuleFromSection('bar', kwargs['type'], 'FooModule')

print("Hello world!")

print "Hello world!"

Houdiniは、Pythonのパスに$HOUDINI_PATH/pythonX.Xlibsディレクトリを自動的に追加します。 これは、これらのディレクトリ内にあるパッケージやモジュールをPythonコードにインポートすることができるという意味です。

他の場所のパッケージやモジュールをpythonで使用できるようにするには、$PYTHONPATH環境変数を使用するか、Pythonでsys.pathリストを修正します。

例えば、$HOUDINI_USER_PREF_DIR/pythonX.Ylibs/mystuff.pyのモジュールは、以下のコードを使用してインポートします:

import mystuff

mystuff.my_function()

スクリプトを1行に維持したいのであれば(例えば、パラメータエクスプレッションやコールバック)、Pythonの__import__ビルトイン関数を使用することで、そのモジュールを取得して即座にそのアトリビュートにアクセスすることができます:

__import__("mystuff").my_function()

Pythonで、デジタルアセットイベントハンドラーを書き込むことができます。 Type Properties Windowの Scripts ページでイベントハンドラー(例えば、“On Created”)を作成後、必ず Edit as を“Python”に設定してください。

イベントスクリプトは、kwargsというグローバル辞書変数のイベントパラメータにアクセスすることができます。 例えば、hou.OpNodeオブジェクトをイベントに関与させるには、kwargs["node"]を使用します。

Houdiniがファイル名を必要とする場所に埋め込まれたスクリプトを参照する方法に関しては、埋め込みファイルを参照する方法を参照してください。

on_created_body = """
from my_studio import register_stats
register_stats.createdSpecialNode()
"""

# アセット定義の参照を取得します。
hdadef = hou.nodeType("mystudio::Sop/flamingo::2.0").definition()
# アセット上にイベントハンドラーセクションを作成します。
hdadef.addSection('OnCreated', on_created_body)
# そのセクションに"IsPython"オプションを設定します。
hdadef.setExtraFileOption("OnCreated/IsPython", True)

個々のノードインスタンス に対してイベントハンドラーをセットアップすることができます。 アセットのどのインスタンス に対してもイベントが発生した時にトリガーされるアセットイベントとは異なり、 これらのハンドラーは、それらをセットアップした 特定のノード に対してイベントが発生した時にのみ実行されます。

ノードに対してイベントハンドラーをセットアップする方法は、hou.OpNode.addEventCallbackを参照してください。 反応させることができるイベントのタイプは、hou.nodeEventTypeを参照してください。

アセットライブラリ を変更するハンドラーをセットアップすることができます。例えば、アセットの作成や削除、または、アセットライブラリのインストールやアンインストールの時です。

アセットライブラリのイベントハンドラーをセットアップする方法は、hou.hda.addEventCallbackを参照してください。 反応させることができるイベントのタイプは、hou.hdaEventTypeを参照してください。

ユーザがシェルフツールをクリックした時に実行するスクリプトをPythonで記述します。詳細は、ツールスクリプトを記述する方法を参照してください。

ノード上のパラメータ値が変更された時にコールされるPythonスクリプトを記述することができます。

デフォルトのコールバック言語が HScriptであれば、それを Pythonに変更することを忘れないでください 。

イベントスクリプトは、kwargsというグローバル辞書変数のイベントパラメータにアクセスすることができます。 例えば、パラメータを含むhou.OpNodeオブジェクトを取得するには、kwargs["node"]を使用し、パラメータのhou.Parmオブジェクトを取得するには、kwargs["parm"]を使用します。

hou.pwd().hm().my_callback(kwargs, hou.pwd())

以下の表は、パラメータコールバックに対するkwargs辞書のコンテンツを一覧にしたものです。

Pythonを使用して、ダイナミックパラメータのメニューを生成することができます。

Pythonメニュースクリプトが1行しか含まれていない場合、Houdiniは、そのスクリプトをPythonエクスプレッションとして評価します。 複数行の場合は、Houdniはそれを関数本体として評価し、returnを使って、そのリストを返さなければなりません。 この挙動は、Pythonパラメータのエクスプレッションに対するものと同じです。

このスクリプトは、平坦な文字列のリストを返さなければなりません。つまり、偶数の項目がトークンで、奇数の項目がラベルです。例:

["1", "Light", "50", "Medium", "100", "Heavy"]

pairs = [("1", "Light"), ("50", "Medium"), ("100", "Heavy")]

return [item for sublist in pairs for item in sublist]
# -> ["1", "Light", "50", "Medium", "100", "Heavy"]

例えば、PythonによりObjectレベルのデジタルアセットのメニューを生成するには:

result = []
for tool in hou.shelves.tools().values():
    node_type_name = tool.toolMenuOpType(hou.paneTabType.NetworkEditor)
    if (node_type_name.startswith("Object/") and
            'Digital Assets' in tool.toolMenuLocations()):
        result.append(tool.name())
        result.append(tool.label())
return result

アセットでは、アセットのPythonModuleセクションでメニューを関数に生成するコード(例えば、generate_menu関数)を置くことができ、 hou.pwd().hdaModule().generate_menu()のメニュースクリプトでその関数をコールすることができます。

メニュースクリプトは、kwargsグローバル辞書変数のコールパラメータにアクセスすることができます。 例えば、そのパラメータを含んだhou.OpNodeオブジェクトを取得するにはkwargs["node"]を使用し、そのパラメータのhou.Parmオブジェクトを取得するにはkwargs["parm"]を使用します。

以下のテーブルには、パラメータコールバックのkwargs辞書の内容を載せています:

“ボタンストリップ(ボタンの帯)”と“アイコンストリップ(アイコンの帯)”のパラメータを(アセット上またはSpareパラメータとして)作成することができます。 これらのパラメータを使って、クリック可能なアクションボタンの帯、または、相互に排他的に選択可能なオプションの帯、個々にオン/オフ可能な独立したオプションの帯を用意することができます。

• ストリップ(帯)パラメータを作成する時、そのパラメータを“Normal”(相互に排他的: 同時にどちらかのアイテムしか選択できません)または“Toggle”(各アイテムを個々に有効または無効にすることができます)に設定します。

• “Normal”ストリップの値を読むのは簡単です。hou.Parm.evalは、選択したアイテムのインデックス(0から始まります)を返します。

  そのインデックスをメニュー内にセットアップした各アイテムに該当するトークンに変換するには、そのパラメータテンプレートからトークンのリストを取得し、そのリストにインデックスを指定します:

  def get_selected_token(parm):
      # 現在選択されているアイテムを読み込みます。
      selected = parm.eval()
  
      # パラメータテンプレートからメニュートークンのリストを取得します。
      tokens = parm.parmTemplate().menuItems()
  
      # 選択したアイテムに該当するトークンが返されます。
      return tokens[selected]
  
  # パラメータコールバックスクリプトで、以下のように記述します...
  token = get_selected_token(kwargs["parm"])
  

• “Toggle”ストリップの値を読むと、 ビットフィールド が返されます。これは、各ビットがそのストリップ内のボタンのオン/オフ状態を2進数で表現した数値です。

  あなたがプログラミングに精通していないようであれば、おそらく非常に難しく聞こえますが、あなたが必要とするすべてのものは、以下のようにユーティリティ関数として用意しているので、ビットフィールドを使いやすい形式に変換することができます。

  # numberのn番目の位置の"ビット"が"オン"なのかどうかをテストする一般的な形式は、
  # 以下のとおりです:
  # number & (1 << n)
  
  def strip_to_tokens(parm):
      # ボタンストリップ/アイコンストリップのパラメータインスタンスの参照を受け取り、
      # オンになっているボタンに相当するトークンのリストを返します。
  
      bitfield = parm.eval()
      tokens = parm.parmTemplate().menuItems()
      return [token for n, token in enumerate(tokens) if bitfield & (1 << n)]
  
  def is_n_selected(bitfield, n):
      # bitfieldのn番目の位置(0から始まります)が"オン"ならTrueを返します。
  
      return bitfield & (1 << n)
  
  def bitfield_to_list(bitfield, size=32):
      # bitfieldを受け取り、そのbitfieldの各位置が"オン"なのか"オフ"なのかを示した
      # ブール(TrueまたはFalse)のリストを返します。
      # ("size"は、ストリップ内のボタンの数です。)
  
      return [bitfield & (1 << n) for n in range(size)]
  

• “toggle”ストリップの値をエクスプレッションで扱うのは非常に難しいです。何かしらの理由で、Toggleストリップの設定がエクスプレッションを駆動させる必要がある場合、その回避策は、そのストリップに、ストリップの設定に基づいて非表示パラメータに単純な値を設定するコールバックスクリプトを渡すことです。次に、ストリップの代わりに、そのエクスプレッション内でその非表示パラメータを参照します。

• アクションアイテムのツールバーのように動作するボタンストリップ/アイコンストリップを作成するには、“Toggle”ストリップを作成して、そのストリップに、オンになったアイテムを読み込んで、それに基づいて何かのアクションを実行し、 直ぐにそのオプションを再度オフにする コールバックスクリプトを渡すことです。

  例:

  import math
  
  # アクションボタンのように動作するボタンを作成するボタンストリップコールバックスクリプト。
  # このスクリプトは、メニュータイプが"Toggle"に設定されていることを前提にしています。
  
  # オンになったボタンを読み込みます。
  parm = kwargs["parm"]
  bitfield = parm.eval()
  # ビットフィールド内の1項目だけを選択してください。ビットフィールドの基底が2の対数は、
  # 選択したボタンのインデックスが得られます。
  selected_index = int(math.log(bitfield, 2))
  
  # クリックしたボタンに基づいて、ここで何かをします。
  
  # 選択したボタンをクリアします。
  # そのパラメータのビットフィールド値をゼロに設定すると、すべてのボタンがオフになります。
  parm.set(0)
  

Pythonを使用することで、ユーザがボタンをクリックした時にkey-valueパラメータに対して新しいキーと値のペアを生成することができます。 このスクリプトは、(例えば、hou.ui.selectFromListまたはhou.ui.selectFromTreeを使って)ユーザがプリセットを選択するインターフェースを表現することができます。 これは、(key, value)タプルを返さなければなりません。

フィールド内の値が1行なら、それはPythonエクスプレッションとして評価されます。 2行以上の場合、関数ボディとして扱われるので、最後にreturnステートメントを使って値を返す必要があります。 これは、他のパラメータコールバックと同じです。

• このスクリプトは、非文字列の戻り値をタプルで返すことができます。Houdiniは、その戻り値を文字列に変換します。

• このスクリプトは、kwargsグローバル辞書変数を含んだ環境で実行します。kwargs["node"]には、ノードのhou.OpNodeが含まれます。kwargs["parm"]には、キーと値のパラメータのhou.Parm参照が含まれます。

• ユーザが選択をキャンセルすると、このスクリプトは、空っぽの文字列を("", "")タプルで返します。

• アセットのPythonモジュール内のコールバックを制御するための関数を定義することを推奨します。

  例えば、アセットのPythonモジュールに以下の関数を記述することができます:

  def choose_env_variable():
      """
      ユーザに環境変数名を選択させて、key-valueパラメータに名前と値を返します。
      """
  
      # OSから環境変数辞書を取得します。
      import os
      names = os.environ.keys()
      # Houdini UI関数を使って、ユーザにリストから選択するように促します。
      results = hou.ui.selectFromList(names)
      if not results:
          # ユーザが何も選択しませんでした。
          return ("", "")
      # アイテムを1個だけ選択するようにします。ユーザが複数のアイテムを選択したら
      # 1番目のアイテムを使用します。
      chosen_index = results[0]
      # hou.ui.selectFromList()は、選択したアイテムの番号を返します。
      # その番号を名前に変換します。
      chosen_name = names[chosen_index]
      # 変数名のタプルとその変数の値を返します。
      return (chosen_name, os.environ[chosen_name])
  

  次に、これを Chooser callback フィールドに使用してコールします:

  kwargs["node"].hdaModule().choose_env_variable()
  

  コールバック関数にノード/パラメータの参照が必要な場合、それらをその関数に渡すことができます:

  kwargs["node"].hm().choose_env_variable(kwargs["node"], kwargs["parm"])
  

• コールバック関数は、インタラクティブにユーザに何かを選択させるようにする必要が ない ことに注意してください。現在の条件に基づいてkey-valueペアを追加するボタンを持たせることができます。

  例えば、これを Chooser callback フィールドに記述します:

  (hou.frame(), hou.time())
  

  ユーザがボタンをクリックすると、このPythonエクスプレッションは、現在のフレーム番号と現在の時間を含んだタプルを評価します。

ユーザが作業している最中に“バックグラウンドで”実行されるPythonコードをセットアップすることができます。

• hou.ui.addEventLoopCallbackを使用することで、そのUIがビジーでない時にHoudiniがコールする関数をセットアップすることができます。

  このコールバック関数は、 高い頻度 (1秒あたり20回程度)でコールされます。この関数は、UIを遅くさせないように実行速度を非常に速くしてください。

• Qt QTimerオブジェクトを使用することで、今後実行されるコードをスケジューリングすることができます。特定の間隔であるコードを実行させたいのであれば、そのコード自体に他のQTimerをセットアップすることができます。

• hou.findFile()を使用して、Houdiniのパスでファイル名を検索することができます。

• アセット内に埋め込まれたファイルから内容を読み込むには、hou.HDADefinition.sectionsを使ってHDASectionオブジェクトのセクション名の辞書を取得してから、hou.HDASection.contentsを使ってそのセクションの内容を取得します。

  my_assetオブジェクトに埋め込まれたexampleファイルの内容を読み込む例:

  objects = hou.nodeTypeCategories()["Object"]
  my_asset = objects.nodeTypes()["my_asset"]
  my_asset_def = my_asset.definition()
  section = my_asset_def.sections()["example"]
  contents = section.contents()
  

  ショートカットとしてopdef:パスを使用することで、アセットセクションがまるでファイルであるかのようにそれらのセクションを読み込むことができます:

  content = hou.readFile("opdef:Object/my_asset?example")
  

• hou.sessionからグローバルスコープのPython変数にアクセスするには、__main__をインポートします。例えば、xがグローバルスコープの変数であれば、その変数に__main__.xとしてアクセスすることができます。

  この方法を使用して、パラメータエクスプレッション, HDA Pythonモジュール, Pythonボタンコールバック, シェルフスクリプトなどからPythonのグローバル変数にアクセスすることができます。