以下の手順は、Python ビューアハンドル を埋め込むためのSOPアセットの作成方法について説明しています。

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

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

3. ⇥ TabメニューからSubnetworkノードを作成します。

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

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

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

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

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

8. Interactive|Handle Script タブをクリックします。

9. ハンドルコードを生成するために New… ボタンをクリックします。

10. Samples 項目で Rotate を選択して、 Accept をクリックします。

11. Apply ボタンをクリックして、その新しいハンドルを登録します。

このHandle Scriptエディターには、ジオメトリを軸回転させることができるPythonハンドルのコードが表示されているはずです。 この新しいハンドルは、Viewer Handle Browserペインのツリー内のHandle Demoノード下にリストされているはずです。

この新しいハンドルをテストするには、そのハンドルとバインドさせるビューアステートを作成する必要があります。

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

2. ステートコードを生成するために New… ボタンをクリックします。

3. Name フィールドには、 ステートの名前 としてstate_rotate_demoと入力します。

4. Samples 項目で Static Handle を選択して、 Accept をクリックします。

5. 以下の行を

   HANDLE_TYPENAME = "unknown"

   以下の内容に置換します。

   HANDLE_TYPENAME = "handle_demo"

6. 以下の行を

   template.bindHandleStatic( HANDLE_TYPENAME, HANDLE_NAME, [] )

   以下の内容に置換します。

   template.bindHandleStatic( HANDLE_TYPENAME, HANDLE_NAME, [("ry","ry")] )

7. アセット内にryという名前のfloatパラメータを追加します。

8. Accept をクリックします。

この新しいstate_rotate_demoステートは、Viewer State Browserペインのツリー内にリストされているはずです。 このstate_rotate_demoノードを展開すると、その新しいhandle_demoエントリが見つかります。

それでは、geo1オブジェクト内にBox SOPを作成してディスプレイフラグを有効にし、そのBoxボックスのRotate Yフィールドにch("../subnet1/ry")を追加してください。

ネットワークエディタ内でHandle demoアセットノードを選択します。マウスをシーンビューア内に移動させてEnterを押します。すると、ハンドルが緑色のリングで表示され、そのリングをドラッグすると、ボックスが回転します。

以下の手順では、Houdini起動時に自動的に登録されるPythonハンドルモジュールの作成方法について説明しています。 This example is valid for all Python handle contexts; however, some samples provided by the Code Generator may not be available in the COP Python handle context, such as the gadget sample shown below.

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

2. ブラウザのツールバーのリストメニューからSopカテゴリを選択します。

3. File ▸ New Handle… メニューでViewer Handle Code Generatorを開きます。

4. ハンドルの名前 として Name フィールドにhandle_demoと入力します。

5. Samples オプションでGadgetを選択して、 Accept をクリックします。

サンプルコードを含んだ新しいPythonハンドルファイルが$HOUDINI_USER_PREF_DIR/viewer_handles/handle_demo.pyとして保存され、Viewer Handle BrowserツリーにHandle demoとしてリストされているはずです。

Gadgetサンプルが生成するコード:

import hou
import resourceutils as ru
import viewerhandle.utils as hu

#使用方法: 何も処理をせずハンドルガジェットを描画するだけの単純なハンドル。

GADGET_PIVOT = "pivot"
SCALE = 250.0

class Handle(object):

    def __init__(self, **kwargs):
        self.__dict__.update(kwargs)

        # ハンドルのトランスフォーム操作をサポートするユーティリティクラス。
        self.xform_aid = hu.TransformAid(self,kwargs)

        # ここでは、ガジェットをクラスアトリビュートとして保存します。
        # ガジェットはself.handle_gadgets attributeを介していつでも利用可能なので、これは任意です。
        color_options = ru.ColorOptions(self.scene_viewer)
        self.pivot = self.handle_gadgets[GADGET_PIVOT]
        self.pivot.setParams({"draw_color":color_options.colorFromName("HandlePivotColor")})

        # ピボットガジェットにBoxジオメトリを割り当てます。
        sops = hou.sopNodeTypeCategory()
        verb = sops.nodeVerb("box")
        verb.setParms({"type":1, "scale":0.1, "divrate":(2,2,2)})
        pivot = hou.Geometry()
        verb.execute(pivot, [])
        self.pivot.setGeometry(pivot)
        self.pivot.show(True)

    def onDraw( self, kwargs ):
        draw_handle = kwargs["draw_handle"]

        # ピボットガジェットを描画します。
        self.pivot.draw(draw_handle)

    def onDrawSetup(self, kwargs):
        """ 描画、ピック、ロケート(マウス下の検索)の操作をする前にコールされます。"""

        # カメラ位置に関係なくスケール係数でピボットガジェットをスケールします。
        origin = hou.Vector3()
        scale = self.handle_context.scaleFactor(origin)*SCALE
        scales = [scale]*3

        xform = self.xform_aid.updateTransform(s=scales)
        self.pivot.setTransform(xform)

def createViewerHandleTemplate():
    """ 登録するビューアハンドルテンプレートを作成して返すための必須エントリポイント。"""

    handle_type = "handle_demo"
    handle_label = "Handle demo"
    handle_cat = [hou.sopNodeTypeCategory()]

    template = hou.ViewerHandleTemplate(handle_type, handle_label, handle_cat)
    template.bindFactory(Handle)
    template.bindIcon("MISC_python")

    # Drawable Gadgetをハンドルにバインドします。
    # このガジェットは、基本的にはビューポート内でインタラクティブに操作可能なハンドルコンポーネントを定義する際に使用されるGeometry Drawablesです。
    #
    # このガジェットは、マウス下の位置の特定やピックといった一般的なハンドル操作を実行する際にHoudiniで使用されます。
    #
    # ガジェットインスタンスは、Houdiniで生成され、このデータメンバーを介してHandleオブジェクトで利用可能にします:
    # self.handle_gadgets: 名前でキーを設定可能なガジェットの辞書。
    template.bindGadget( hou.drawableGeometryType.Face, GADGET_PIVOT )

    return template

このハンドルをテストするために、以下の手順に従います:

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

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

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

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

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

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

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

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

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

9. New… ボタンをクリックすると、Viewer State Code Generatorダイアログが開きます。

10. Samples オプションで Static Handle を選択して Accept をクリックします。

11. その新しいステートソースコードの中の HANDLE_TYPENAME に“handle_demo”に設定して Accept をクリックします。

12. state handle demoノードを選択して、ビューア内でEnterキーを押します。

これでPythonハンドルデモがアクティブになり、原点にピボットガジェットが表示されているはずです。

3D Python handles provide 3D manipulation capabilities and operate within the Scene Viewer. They can be defined in contexts such as SOP, LOP, and OBJ nodes.

def __init__(self, **kwargs)
    self.__dict__.update(kwargs)
    ...

def onActivate(self, kwargs):
    self.log("Handle parameters", self.handle_parms)

2D Python handles are designed to operate within the Compositing Viewer and the Scene Viewer.

def __init__(self, **kwargs):
    self.__dict__.update(kwargs)

def onActivate(self, kwargs):
    self.log("Handle parameters", self.handle_parms)

Pythonハンドルイベントに反応できるようにいくつかのハンドルがサポートされています。 これらのイベントハンドラーのほとんどは、そのイベント関連の特定の値を含んだ単一辞書引数(kwargs)を使ってコールされます。

すべてのハンドラーに共通するkwargsエントリを以下に載せています:

This table lists all event handlers along with specific kwargs entries if any.

Houdiniは、ハンドルやノードパラメータが変更された時に自動的にUndoスタック上にアイテムを生成します。 とはいえ、独自にUndo対応が必要な場合、hou.undosモジュールとhou.SceneViewerのUndoメソッドを使用することで、 Undo可能なオペレーションをUndoスタック上に1個のエントリにまとめることができます。 詳細は、ステートのUndo対応を参照してください。

Houdiniには、Pythonハンドルの実装に役立つ様々なユーティリティクラスが用意されています。 例えば、ColorOptionsやhou.SceneViewer.hudInfoといったユーティリティは、Houdiniの標準と整合性が合うように設計されており、 これらのユーティリティティを使用することを強く推奨します。 これらのユーティリティの使い方のサンプルは、Pythonハンドルのデモを参照してください。

• viewerhandle.utils.TransformAid:

  TransformAidは、Pythonハンドルのトランスフォーム操作を制御します。 updateTransformやtoScreenといったメソッドは、ビューポートがワールド空間に設定された時にハンドルのオブジェクトトランスフォームを補完します。

  Note

  While TransformAid is primarily designed for 3D Python handles and some of its methods might seem applicable to 2D handles, it is recommended to use drawable2d.Dragger2D for handling 2D-specific operations within 2D Python handles instead.

• viewerhandle.utils.DebugAid:

  Pythonハンドルのデバッグに役立つユーティリティクラス。

• resourceutils.ColorOptions:

  Houdiniカラーオプションにアクセスできるユーティリティクラス。 詳細は、Gadget Drawablesを参照してください。

• resourceutils.DisplayGroup:

  このクラスは、Drawablesをビューポート内にグループとして表示することができます。 例えば、HoudiniトランスフォームモードキーのYと同様に循環形式でハンドルガジェットのグループの表示を切り替えたい場合にこれが役立ちます。

• drawable2d.Dragger2D:

  A utility class for interactive mouse-based manipulation of hou.Drawable2D objects in 2D image space. This is primarily used in COP Python handles or states, where user interaction occurs within a normalized model space ranging from [-1, -1] to [1, 1].

• drawable2d.Drawable2DGroup:

  This class covers the drawable grouping functionality for hou.Drawable2D objects.

• resourceutils.CursorLabel:

  Use this class to display a text label that follows the cursor’s movement. This can be useful for both 2D and 3D Python handles to provide contextual information. Refer to the move_tool_demo and cop_state_drawable_demo handle examples for detailed usage.

• resourceutils.DebugMenu:

  Pythonハンドルコンテキストメニューにデバッグメニューエントリを作成する際にHoudiniで使用されます。 実際にViewer Handle Code Generatorは、これを使用してハンドルのコンテキストメニューを作成しています。

viewer_handle_intro.hipシーンでは、Pythonハンドルの実装について紹介されており、そのシーンからPythonハンドルの基本機能を学ぶことができます。

move_tool_demo.hipシーンでは、ジオメトリを移動/回転/スケールさせるPythonハンドルのもっと完璧で複雑な実装のサンプルが用意されています。

The cop_viewer_handle_demo.hip scene offers an introduction to creating Python handles specifically for COPs. By exploring this example, you will learn the fundamental features and implementation techniques for COP Python handles.

ユーティリティクラスのviewerhandle.utils.DebugAidには、Pythonハンドルのデバッグサポートが用意されています。 このユーティリティは、Pythonハンドルブラウザでメッセージをログに出すのに便利ですが、さらにPythonハンドルブラウザで現在利用可能なすべてのログ機能をメソッドとして用意しています:

• アクティブなPythonハンドルを検査します。

• コンソールにマーカーを追加します。

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

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

• 実行中のPythonハンドルをリロードします。

import traceback
from viewerhandle.utils import DebugAid

class Handle(object):
    def __init__(self, **kwargs):
        self.__dict__.update(kwargs)
        self.dbg = DebugAid(self)

    def onEnter(self, kwargs):
        # ハンドルを検査します。
        self.dbg.marker()
        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()))

HoudiniからPythonハンドルモジュールをリロードできれば、Pythonハンドルの開発サイクルが向上します。 Pythonハンドルをリロードする方法がいくつか用意されています:

• ソースコードがHoudiniのViewer Handle Editorで開かれていれば、Acceptボタンをクリックします。

• Viewer Handle BrowserペインのFileメニューまたはブラウザツリー内からReloadコンテキストメニューを選択します。

• hou.ui.reloadViewerHandle

• viewerhandle.utils.DebugAid.reload

• ハンドルがHDAに埋め込まれている場合は、Python Handleエディタからリロードします。

Pythonハンドルにデバッグ機能を追加する別の方法は、デバッグコンテキストメニューを使用することです。 Viewer Handle Code Generatorには、以下のViewer Handle Browserデバッグ機能にアクセス可能なデバッグメニューを生成するオプションが備わっています:

• Logging

  コンソールのロギングを有効または無効にします。 有効にすると、self.logまたはDebugAidユーティリティによってログに出されたメッセージがコンソールに送信されます。

• Clear

  ロギングコンソールをクリアします。

• Inspect

  大元のPythonハンドルの内容をコンソールにダンプします。

• Trace

  デバッグトレースを有効または無効にします。有効にすると、アクティブなPythonハンドルのトレースのログがコンソールに出されます。

• Marker

  メッセージを区別できるようにマーカーをコンソールに追加します。

生成されるコードには、サブメニューとしてデバッグメニューが追加されます。 このデバッグメニューを平坦なメニューとして追加したいのであれば、以下のようにcreateViewerHandleTemplate内のコードを修正します:

menu = hou.ViewerStateMenu(handle_type + "_menu", handle_label)
...

# これを ...
menu.addMenu(hu.createDebugMenu(handle_type))

# ... このコードに置換します。
hu.addDebugEntriesToMenu(handle_type, menu)

...