• 現在のところ、Pythonステートは、次のコンテキストで利用可能です: SOP (ジオメトリ), OBJ , DOP , LOP のレベル。

• ハンドルをノードなしステートにバインドすることはできません。

HDA Viewerステートを作成するには、Operator Type PropertiesウィンドウのViewer State Editorタブで利用可能なコードジェネレータを使用します。

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

1. ステートを追加できるようにアセットの作成から始めます。サンプルをシンプルにするために、OBJアセットを使って始めましょう。

   Note

   空っぽのアセットから始めたい場合は、これらの手順¹に従うことでSOPアセットを、これらの手順²に従うことでOBJアセットを作成することができます。 コードジェネレータで生成されたViewerステートは、どちらのアセットタイプでも動作します。

   1

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

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

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

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

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

   5. Type Name をstatedemo、 Asset Label をState Demo、 Library Path をEmbedded in .hip Fileに設定します。

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

   6. Author 、 Branch 、 Version のチェックボックスのチェックを外します。

   2

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

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

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

   3. Type Name をstatedemo、 Asset Label をState Demo、 Library Path をEmbedded in .hip Fileに設定します。

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

   4. Author 、 Branch 、 Version のチェックボックスのチェックを外します。

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

3. Interactive|State Script タブをクリックします。

4. New… ボタンをクリックして、ステートコードを生成します。

5. onMouseEvent イベントハンドラーを選択して、 Accept をクリックします。

Viewer State Browserツリーにリストされた関数ステートがStatedemoとして表示されているはずです。

import hou
import viewerstate.utils as su

class State(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"]
        dev = ui_event.device()
        self.log("Mouse:", dev.mouseX(), dev.mouseY(), dev.isLeftButton())

        # イベントを消費するにはTrueを返さなければなりません
        return False


def createViewerStateTemplate():
    """登録するViewerステートテンプレートを作成して返すのに必須となるエントリーポイント"""

    state_typename = kwargs["type"].definition().sections()["DefaultState"].contents()
    state_label = "Statedemo"
    state_cat = hou.objNodeTypeCategory()

    template = hou.ViewerStateTemplate(state_typename, state_label, state_cat)
    template.bindFactory(State)
    template.bindIcon(kwargs["type"].icon())

    return template

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

このステートをテストするために、ネットワークエディタ内でそのアセットを選択します。マウスをシーンビューア内に移動させて、Enterを押します。 マウスを動かすと、そのマウス座標のログがViewer State Browserコンソールに記録されているはずです。

File Viewerステートを作成するには、Viewer State Browserウィンドウのコードジェネレータを使用します。

以下の手順では、複数のアセット間で“共有”可能なFile Viewerステートを作成します。 File Viewerステートは、Houdiniを起動した時に自動的に登録されます。

1. New Pane Tab Type ▸ Viewer State Browser メニューからViewer State Browserウィンドウを開きます。

2. ツールバーからObjectカテゴリを選択します。

3. File ▸ New State… メニューからViewer State Code Generatorを開きます。

4. Name フィールドで、 ステートの名前 としてstatedemoと入力します。

5. onMouseEvent イベントハンドラーを選択して、 Accept をクリックします。

この新しいFile Viewerステートを$HOUDINI_USER_PREF_DIR/viewer_states/statedemo.pyとして保存すると、Viewer State BrowserツリーでStatedemoとしてリストされます。

これで、Viewer State Browserツリーにリストされた関数ステートがStatedemoとして表示されているはずです。

import hou
import viewerstate.utils as su

class State(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"]
        dev = ui_event.device()
        self.log("Mouse:", dev.mouseX(), dev.mouseY(), dev.isLeftButton())

        # イベントを消費するにはTrueを返さなければなりません
        return False


def createViewerStateTemplate():
    """登録するViewerステートテンプレートを作成して返すのに必須となるエントリーポイント"""

    state_typename = "statedemo"
    state_label = "Statedemo"
    state_cat = hou.objNodeTypeCategory()

    template = hou.ViewerStateTemplate(state_typename, state_label, state_cat)
    template.bindFactory(State)
    template.bindIcon("MISC_python")

    return template

このステートをテストするために、ステートを追加したいアセットを探すか、これらの手順³で空っぽのSOPアセットを作成するか、これらの手順⁴でOBJアセットを作成します。サンプルをシンプルにするために、OBJアセットを作成します。

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

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

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

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

   • アセットがロックされていた場合、Houdiniは、変更を保存できるようにアセットのロックを解除するように促します。

5. このステートをテストするために、ネットワークエディタ内でそのアセットを選択します。マウスをシーンビューア内に移動させて、Enterを押します。 マウスを動かすと、そのマウス座標のログがViewer State Browserコンソールに記録されているはずです。

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

Houdiniを起動すると、ステートテンプレートにアクセスして登録を実行するためのcreateViewerStateTemplateがコールされます。 省略した場合、Houdiniは単にステート登録をスキップします。

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

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

class MyState(object):
    def __init__(self, state_name, scene_viewer):
        self.state_name = state_name
        self.scene_viewer = scene_viewer

    def onEnter( self, kwargs):
        kwargs['state_flags']['mouse_drag'] = False
        ...                

class MyState(object):
    def __init__(self, state_name, scene_viewer):
        self.state_name = state_name
        self.scene_viewer = scene_viewer

    def onMouseEvent( self, kwargs):
        kwargs['state_flags']['redraw'] = False
        if __some_redraw_test__:
            kwargs['state_flags']['redraw'] = True
        ...                

class MyState(object):
    def __init__(self, state_name, scene_viewer):
        self.state_name = state_name
        self.scene_viewer = scene_viewer

    def onEnter( self, kwargs):
        # 間接ハンドルドラッグを無効にします。
        # ビューポート内でのMMBドラッグによってハンドルパラメータが修正できなくなります。
        kwargs['state_flags']['indirect_handle_drag'] = False
        ...

class MyState(object):
    def __init__(self, state_name, scene_viewer):
        self.state_name = state_name
        self.scene_viewer = scene_viewer

    def onGenerate( self, kwargs):
        # ノード選択が行なわれても、このノードなしステートがアクティブのままになるように設定します。
        kwargs['state_flags']['exit_on_node_select'] = False
        ...                

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

トレーシングは、Pythonステートの実行中にブラウザコンソールウィンドウ内にデバッグ情報をプリントできるようにする組み込みツールです。 トレーシングはブラウザツールバーから有効にすることができ、File|DebugメニューのTrace Optionsダイアログを使用して設定することができます。 そのTrace Optionsダイアログでは、トレースしたいPythonステートハンドラーとそのハンドラーが実行された時にプリントしたいデータを選択することができます。

• ビューアステートブラウザのトレーシング機能は、Pythonステートに一行コードを追加することなくPythonステートをデバッグするのに役立ちます。

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()
        self.log("Mouse position x=", device.mouseX(), "y=", device.mouseY(), 
            severity=hou.severityType.ImportantMessage)

        # 現在のPythonコールスタックをログに記録します。
        self.log(''.join(traceback.format_stack()))

msg = "Lorem ipsum dolor sit amet."
self.log("<span style='color:#F0FF00; background:orange; font-size:50px;" \
    "font-family:arial narrow'>{}</span>".format(msg))

# 一部の文字がリッチテキスト用特殊文字として予約されています。
# そのような文字をリッチテキストに解析されずに表示させたい場合は、
# エスケープ形式を使用してそれらの文字を無効にしてください。
msg = "<< Lorem ipsum dolor sit amet. >>"
msg = msg.replace("<", "&lt;")
msg = msg.replace(">", "&gt;")
self.log("<font color='#FF00FF'><b><i><u>{}<u/><i/></b><font/>".format(msg))

ユーティリティクラスのviewerstate.utils.DebugAidには、Pythonステートのデバッグサポートが用意されています。 このユーティリティは、self.logなどのログを出す仕組みやViewerステートブラウザで現在利用可能なすべてのデバッグ機能をメソッドとして用意しています:

• アクティブなViewerステートを検査します。

• マーカーを追加します。

• デバッグトレースを有効化します。

• ロギングコンソールを有効化します。

• 実行中のViewerステートをリロードします。

PythonハンドルのDebugAidも参照してください。

import traceback
from viewerstate.utils import DebugAid

class MyState(object):
    def __init__(self, state_name, scene_viewer):
        self.state_name = state_name
        self.scene_viewer = scene_viewer
        self.dbg = DebugAid(self)

    def onEnter(self, kwargs):
        # ステートを検査します。
        self.dbg.marker()
        # このViewerステートを検査します。
        self.dbg.inspect()
        # トレースを開始します。
        self.dbg.trace()

    def onMouseEvent(self, kwargs):
        # マウス位置をログに出します。
        ui_event = kwargs["ui_event"]
        device = ui_event.device()

        self.dbg.marker()
        self.dbg.log("Mouse position x=", device.mouseX(), "y=", device.mouseY())

        # 現在のPythonコールスタックをログに出します。
        self.dbg.log(''.join(traceback.format_stack()))

最も基本的でありながら依然として役立つデバッグ形式は情報のプリントで、スクリプトが実行された時に変数の内容などをプリントすることです。

• printを使用する主な利点は、複数行のテキストブロック(例えば、現在のPythonコールスタック)を含むたくさんの情報を出力し、後でスクロールさせて読み返すことができることです。

• プリント出力を追加するには、Pythonステートコードを編集する必要があります。

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

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!")