• 現在のところ、Pythonステートは、 SOP(ジオメトリ)レベルとOBJレベルでのみ利用可能です 。現在のところ、例えばダイナミクスネットワークやコンポジットネットワークなどの他のネットワークタイプで独自のViewer Stateを作成することはできません。

• 現在のところ、Viewer Stateにアイコンを指定する方法がありません。

以下の手順は、アセットを作成し、そこに最低限のステートを試せるようにコードを記述します。

1. ステートを追加できるようにアセットの作成から始めます。

   空っぽのアセットから始めたい場合は、これらの手順¹に従うことでSOPアセットを、これらの手順²に従うことでOBJアセットを作成することができます。

   1

   実験できるように"空っぽ"のSOPアセットを手軽に作成するには:

   1. オブジェクトレベルで、⇥ Tabメニューを使ってGeoオブジェクトを作成します。

   2. geo1ノードをダブルクリックして、ジオメトリネットワークの中に入ります。

   3. ⇥ Tabメニューを使ってSubnetworkノードを作成します。

   4. subnet1ノードを右クリックして、 Create Digital Asset を選択します。

   5. Operator Name をstatedemo、 Operator Label をState Demo、 Save to Library をEmbeddedに設定します。

      ライブラリの場所をEmbeddedに設定することで、アセットライブラリではなく、現行シーンファイルにアセットが保存されます。

   2

   実験できるように"空っぽ"のOBJアセットを手軽に作成するには:

   1. オブジェクトレベルで、⇥ Tabメニューを使ってSubnetworkノードを作成します。

   2. subnet1ノードを右クリックして、 Create Digital Asset を選択します。

   3. Operator Name をstatedemo、 Operator Label をState Demo、 Save to Library をEmbeddedに設定します。

      ライブラリの場所をEmbeddedに設定することで、アセットライブラリではなく、現行シーンファイルにアセットが保存されます。

2. そのアセットのType Propertiesウィンドウを開きます(アセットタイプのインスタンスを右クリックして、 Type Properties を選択します)。

3. Scripts タブをクリックします。

4. 左側のスクリプトのリスト下で、 Event Handler ポップアップメニューから"Python Module"を選択します。

   左側でそのPythonModuleスクリプトを選択すると、右側のエディタでそのモジュールの内容を編集することができます。

5. 以下の最低限のステートコードをエディタ内にペーストします。

   from __future__ import print_function
   
   
   # 最低限のステートハンドラーの実装。
   class MyState(object):
       def __init__(self, state_name, scene_viewer):
           self.state_name = state_name
           self.scene_viewer = scene_viewer
   
       # ハンドラーメソッドをここに記述します。
       def onMouseEvent(self, kwargs):
           dev = kwargs["ui_event"].device()
           print("Mouse:", dev.mouseX(), dev.mouseY(), dev.isLeftButton())
   
   
   # アセットのノードタイプの参照を取得します。
   nodetype = kwargs['type']
   # そのノードの名前とラベルをステートの名前とラベルとして使用します。
   state_name = nodetype.name() + ".pystate"
   label = nodetype.description()
   category = nodetype.category()
   # そのステートの名前とラベルとノードタイプカテゴリでViewerStateTemplateをインスタンス化します。
   template = hou.ViewerStateTemplate(state_name, label, category)
   
   # このバインドは必須です。
   template.bindFactory(MyState)
   
   # 他の任意のバインドをここに記述します...
   

   ステートクラスに機能を追加する方法の詳細は、以下のステートを実装する方法を参照してください。

   Tip

   (上記で示したように)モジュールレベルでテンプレートオブジェクトを構築し、module.templateを使ってそれを参照することができます。 しかし、関数内でテンプレートオブジェクトの作成をラップしたいのであれば、一時変数名(例えば、上記のstate_nameとlabel)がモジュールのネームスペースから漏れないようにしてください:

   # モジュールレベルでテンプレートを作成するのではなく、関数内にテンプレート作成コードをラップします。
   def createViewerStateTemplate():
       # ノードの名前とラベルをステートの名前とラベルとして使用します。
       state_name = nodetype.name() + ".pystate"
       label = nodetype.description()
       category = nodetype.category()
       # そのステートの名前とラベルとノードタイプカテゴリでViewerStateTemplateをインスタンス化します。
       template = hou.ViewerStateTemplate(state_name, label, category)
   
       # このバインドは必須です。
       template.bindFactory(MyState)
   
       # 他の任意のバインドをここに記述します。
   
       return template
   

   次にモジュールの外でmodule.createViewerStateTemplate()を使えば、そのテンプレートを参照ではなく直接取得することができます。

6. 左側のスクリプトのリスト下で、 Event Handler ポップアップメニューから"On Install"を選択します。

   左側でそのOnInstallスクリプトを選択すると、右側のエディタでそのモジュールの内容を編集することができます。

   ここでは、ステートを登録するためにOnInstallスクリプト(ノードタイプがセッションにインストールされると実行されます)を使用しました。

7. 以下のイベントスクリプトをエディタ内にペーストします:

   module = kwargs['type'].hdaModule()
   hou.ui.registerViewerState(module.template)
   

   これは、そのステートをHoudiniに登録します。

8. 次に、このステートの登録を解除するために他のアセットイベントスクリプトも追加しようと思います。

   左側のスクリプトのリスト下で、 Event Handler ポップアップメニューから"On Uninstall"を選択します。

   左側でそのOnUninstallスクリプトを選択すると、右側のエディタでそのモジュールの内容を編集することができます。

   以下のイベントスクリプトをエディタ内にペーストします:

   state_name = kwargs['type'].name() + ".pystate"
   hou.ui.unregisterViewerState(state_name)
   

   これは、そのノードタイプをセッションからアンインストールすると、Houdiniからそのステートの登録が解除されます。

   OnInstallとOnUninstallのスクリプトを使用することで、 アセットを保存することでステートの違いをテスト できるようになります。これによって、ステートが再度登録させて、私達の変更を反映させます。

9. 最後に、この新しいステートを使用するようにアセットを設定します。Type Propertiesウィンドウの Node タブをクリックします。

10. Default State フィールドにそのステート名(ウィンドウの上部に表示されている Operator Type: の隣のノードの内部名と.pystate接尾辞)を設定します。

11. Type Propertiesウィンドウの下部にある Accept をクリックします。

    アセットがロックされていた場合、Houdiniは、あなたの変更を保存できるようにそのアセットのロックを解除するのか尋ねてきます。

12. このステートをテストするために、ネットワークエディタ内でそのアセットを選択します。マウスをシーンビューア内に移動させて、Enterを押します。

    • ビューアの上部にあるツールバーは、左側にこのステートのラベルを表示します。

state_name = node_type.definition().sections()['DefaultState'].contents()

以下の手順では、複数のアセット間で"共有"可能なViewer Stateを作成します。このタイプのステート(self-installedステートという名前にします)は、Houdiniを起動した時に登録されます。

1. $HOUDINI_USER_PREF_DIR下にviewer_statesという新しいフォルダを作成します。そのフォルダの中にmystate.pyという新しいファイルを作成します。

   HOUDINIPATH /
       viewer_states /
           mystate.py
   

2. テキストエディタでmystate.pyを開き、以下の最低限のステートの実装をペーストします。

   from __future__ import print_function
   
   import hou
   
   # 最低限のステートハンドラーの実装。
   class MyState(object):
       def __init__(self, state_name, scene_viewer):
           self.state_name = state_name
           self.scene_viewer = scene_viewer
   
       # ハンドラーメソッドをここに記述します。
       def onMouseEvent(self, kwargs):
           dev = kwargs["ui_event"].device()
           print("Mouse:", dev.mouseX(), dev.mouseY(), dev.isLeftButton())
   
   # 登録エントリーポイント
   def createViewerStateTemplate():
       # 名前とラベルを選択します。
       state_name = "mystate"
       state_label = "My New State"
       category = hou.sopNodeTypeCategory()
   
       # テンプレートを作成します。
       template = hou.ViewerStateTemplate(state_name, state_label, category)
       template.bindFactory(MyState)
   
       # 他の任意のバインドをここに記述します...
   
       # 'mystate'テンプレートを返します。
       return template
   

3. ステートを追加したいアセットを探します。

   空っぽのアセットから始めたい場合は、SOPアセットに関してはこれらの手順³、OBJアセットに関してはこれらの手順⁴に従ってください。

   3

   実験できるように"空っぽ"のSOPアセットを手軽に作成するには:

   1. オブジェクトレベルで、⇥ Tabメニューを使ってGeoオブジェクトを作成します。

   2. geo1ノードをダブルクリックして、ジオメトリネットワークの中に入ります。

   3. ⇥ Tabメニューを使ってSubnetworkノードを作成します。

   4. subnet1ノードを右クリックして、 Create Digital Asset を選択します。

   5. Operator Name をstatedemo、 Operator Label をState Demo、 Save to Library をEmbeddedに設定します。

      ライブラリの場所をEmbeddedに設定することで、アセットライブラリではなく、現行シーンファイルにアセットが保存されます。

   4

   実験できるように"空っぽ"のOBJアセットを手軽に作成するには:

   1. オブジェクトレベルで、⇥ Tabメニューを使ってSubnetworkノードを作成します。

   2. subnet1ノードを右クリックして、 Create Digital Asset を選択します。

   3. Operator Name をstatedemo、 Operator Label をState Demo、 Save to Library をEmbeddedに設定します。

      ライブラリの場所をEmbeddedに設定することで、アセットライブラリではなく、現行シーンファイルにアセットが保存されます。

4. アセットのType Propertiesウィンドウを開きます(アセットタイプのインスタンスを右クリックして、 Type Properties を開きます)。

5. Node タブをクリックします。

6. Default State フィールドにステート名を設定します(例えば上記のコードでは、これはmystateです)。

7. Type Propertiesウィンドウの下部にある Accept をクリックします。

   アセットがロックされていた場合、Houdiniは、あなたの変更を保存できるようにそのアセットのロックを解除するのか尋ねてきます。

8. このステートをテストするために、ネットワークエディタ内でそのアセットを選択します。マウスをシーンビューア内に移動させて、Enterを押します。

   • ビューアの上部にあるツールバーは、左側にこのステートのラベルを表示します。

Houdiniは起動時にcreateViewerStateTemplateをコールして、そのステートテンプレートにアクセスして、それを登録します。省略すると、Houdiniは単にそのステートの登録をスキップします。

ステートクラスに機能性を追加する方法の詳細は、以下のステートを実装する方法を参照してください。

イベントハンドラーは、単一引数、色々な便利アイテムを含んだ辞書を使ってコールします。 この辞書には、典型的には(必ずとは限りません)以下のアイテムが含まれています:

以下のテーブルには、ステートクラスを定義可能なイベントハンドラーを載せています。

補足メモ:

• Houdiniは、ツールがアクティブになった時にonEnter(ステートが既存ノードに対して動作する場合) または onGenerate(ステートが新しいノードを作成する場合)の どちらか をコールします。両方をコールすることはありません。onEnterに渡される辞書にはnodeアイテムが含まれており、既存ノードをhou.Nodeオブジェクトとしてアクセスすることができます。詳細は、ノードの編集を参照してください。

• Houdiniは、ステートを開始する時にマウスポインタがビューア上になくてもonEnter/onGenerateをコールします。マウスポインタ周辺に何かの視覚的な表示を行ないたいのであれば、それらを表示できるようにonMouseEventコールを待ってください。

• ステートを"中断"している間は、UIイベントは受信されません。

• onInterruptコールの後にそれに呼応するonResumeが必ず実行されるようにすることはできません。ステートを中断している間にユーザーがステートを終了すると、onResumeコールではなくonExitが受信されます。

• ユーザーがステートのコンテキストメニューを開いた場合、マウスポインタをそのメニュー上に動かすとonInterruptが受信され、そのメニューから出るとonResumeコールが受信されます。

• ステートが現行で中断された際にHoudiniがバックグラウンドにあれば、マウスポインタがビューア上にあったとしても、ユーザーから何かの入力(例えば、マウスの移動)がない限りは、ステートはonResumeコールを受信しません。

詳細は、UIイベントの制御を参照してください。

これらのメソッドに渡される辞書には、以下の追加アイテムが含まれています:

ステートにセレクターをバインドしていると、Houdiniは以下のメソッドをコールします。詳細は、選択の制御を参照してください。

ステートにハンドルをバインドしていると、Houdiniは以下のメソッドをコールします。詳細は、Pythonステートハンドルを参照してください。

ディスク上に定義されたステートに関しては、そのディスク上のファイルを変更したら、hou.ui.reloadViewerState()を使うことで、Houdiniにそのステートを再読込するように伝えることができます。

最も基本的だけどデバッグで役立つのは、スクリプトを実行した時に変数の内容などの情報をプリントすることです。 Houdiniは、このタイプの情報を表示するのにいくつかの方法を用意しています。

• スクリプト内でPythonのprint関数を使用することで、情報をプリントすることができます。

  • printを使用する主なメリットは、(現在のPythonコールスタックのような)複数行のテキストを含むたくさんの情報を出力することができ、それを後にスクロールして読むことができることです。

  • この出力は、Houdiniの起動方法やウィンドウの開き方に応じて、コンソールウィンドウ、HoudiniのPythonシェルウィンドウ、Houdiniを起動させた時のシェルに表示させることができます。

  Tip

  printをステートメントではなく関数として使用することに慣れてしまっているのあれば、from __future__ import printを使用すると良いでしょう。 この関数は、使いやすくて多機能です。

  from __future__ import print
  import traceback
  
  class MyState(object):
      def __init__(self, state_name, scene_viewer):
          self.state_name = state_name
          self.scene_viewer = scene_viewer
  
      def onMouseEvent(self, kwargs):
          # マウス位置をプリントします。
          ui_event = kwargs["ui_event"]
          device = ui_event.device()
          print("Mouse position x=", device.mouseX(), "y=", device.mouseY())
  
          # 現在のPythonコールスタックをプリントします。
          traceback.print_stack()
  

• hou.SceneViewer.setPromptMessage()とhou.SceneViewer.clearPromptMessage()の関数は、メインのHoudiniウィンドウの下部のスタータスラインにユーザー操作を促すことができます。これらの関数を"応用"することで、デバッグ情報を表示させることができます。

  • このメソッドのメリットは、Houdiniを操作する際にウィンドウの正面中心に情報を表示できることです。

  • このデメリットは、ステータスラインは一度に一行でしか情報を表示できないので、変更があると前のメッセージが消えてしまうことです。

  class MyState(object):
      def __init__(self, state_name, scene_viewer):
          self.state_name = state_name
          self.scene_viewer = scene_viewer
  
      def onMouseEvent(self, kwargs):
          # ステータスラインにマウス位置を表示します。
          ui_event = kwargs["ui_event"]
          device = ui_event.device()
          message = "Mouse x=%d y=%d" % (device.mouseX(), device.mouseY())
          self.scene_viewer.setPromptMessage(message)
  

• hou.ui.displayMessage()関数は、メッセージウィンドウをポップアップして、ユーザーがOKかCancelをクリックするのを待ちます。

  • これは、デバッグするのにいくつかメリットがあります。その1つは、待機中にスクリプトが一時停止されるので、非常に簡単に変更内容を調べることができます。また、クリックされたボタンに応じていくつかのフィードバックをスクリプトに渡すことができます。もう1つは、この関数はキーワード引数を持っているので、デフォルトで非表示になっている"詳細"ブロックを追加して展開することができます。これは、例えば現在のPythonコールスタックを表示するのに役立ちます。

  • おそらくループでこの関数を使用したくないことでしょう。というのも、複数のメッセージウィンドウを閉じるのに一々クリックしなければならないので面倒なことになります。

  import traceback
  
  import hou
  
  
  class MyState(object):
      def __init__(self, state_name, scene_viewer):
          self.state_name = state_name
          self.scene_viewer = scene_viewer
  
      def onMouseEvent(self, kwargs):
          ui_event = kwargs["ui_event"]
          device = ui_event.device()
          # クリックするとメッセージのみが表示されます。
          if device.isLeftButton():
              message = "Mouse x=%d y=%d" % (device.mouseX(), device.mouseY())
  
              # スクリプト内のこの時点でのコールスタックを取得し、それをメッセージの"詳細"として追加できるように文字列の書式に変換します。
              details = "".join(traceback.format_stack())
  
              # メッセージを表示して、ユーザーがメッセージウィンドウのボタンをクリックするのを待ちます。
              clicked = hou.ui.displayMessage(
                  message, buttons=("OK", "Error"),
                  details_label="Current call stack",
                  details=details
              )
  
              # ユーザーが"Error"ボタンをクリックすると、エラーを引き起こします。
              if clicked == 1:
                  raise Exception("Don't blame me!")