On this page |
hapi
パッケージには、Houdini Engine C APIをPythonでラップしたクラスと関数が含まれています。
Houdini Engineとは、Houdiniデジタルアセットをホストアプリケーションの内部で直接使用できるようにするAPIです。 これによって、アーティストは自分が最も快適に作業できる環境下でHoudiniのパワーを直接活用することができます。
技術的な観点では、Houdini Engineはバイナリ互換のために設計されたC APIです。 コンパイラの選択やバージョンが違っても、Houdini Engineをホストアプリケーションに統合することができます。 例えば、Houdini EngineはネイティブのC++アプリケーションだけでなくC#やPythonなど両方で管理された環境に統合することができます。
最後にC++ HDKを比較すると、Houdini Engineは学習が簡単になるように平坦で小さなAPIになっています。
Tip
エンジンのインテグレーションを作成する場合、HARSの代わりにインタラクティブHoudiniのライブセッションに接続する方が非常に便利です。 これはHoudini Engine SessionSyncを使用して行なうことができます。
Tip
Houdini Engine C APIドキュメントは、Python APIを使用する時でも、同じ概念と関数が当てはまるので役に立ちます。
はじめよう ¶
To... | Do this |
---|---|
セッションを作成する |
セッションはHARS実行可能ファイル(完全にヘッドレスのHoudini)のインスタンスです。 HARSを自動的に起動してそれに接続することができます。 import hapi options = hapi.ThriftServerOptions() process_id = hapi.startThriftSocketServer(options, 9090) session = hapi.createThriftSocketSession('localhost', 9090) |
セッションに接続する |
セッションはHARS実行可能ファイル(完全にヘッドレスのHoudini)のインスタンスです。
SessionSyncをアクティブにして実行中されているHoudiniインスタンスをセッションにすることも可能です。
名前付きパイプ(Named Pipe:例えば、 import hapi session = hapi.createThriftSocketSession('localhost', 9090) cook_options = hapi.CookOptions() hapi.initialize(session, cook_options) |
HDAを読み込む |
HDAファイルがサーバーにアクセス可能であれば、hapi.loadAssetLibraryFromFileを使ってそのHDAを読み込むことができます。 HDAファイルがクライアントにしかアクセスできないのであれば、hapi.loadAssetLibraryFromMemoryを使ってそのHDAをバイトとして送信することができます。 # myhda.hdaを送信できるようにするために、そのHDAをメモリに読み込みます。 hda_bytes = open('/tmp/myhda.hda', 'rb').read() lib_id = hapi.loadAssetLibraryFromMemory(session, hda_bytes, len(hda_bytes), True) |
ノードを作成する |
# `MyType`というSOPタイプを定義したアセットが読み込まれていると仮定します。 node_id = hapi.createNode(session, -1, 'Sop/MyType') # その新しいノードのhapi.NodeInfoを取得します。 node_info = hapi.getNodeInfo(session, node_id) # 文字列を取得するために2つの手順を踏みます。 str_len = hapi.getStringBufLength(session, node_info.nameSH) node_name = hapi.getString(session, node_info.nameSH, str_len) print('Created {}'.format(node_name)) |
シーンデータをファイルに保存する。 |
シーンの問題をデバッグする時にそのシーンのhipファイルをユーザが保存できれば非常に便利です。 hapi.saveHIPFile(session, '/tmp/debug.hip') hapi.saveGeoToFile(session, node_id, '/tmp/debugGeo.bgeo.sc') |
次のステップ ¶
APIリファレンス ¶
Animation ¶
-
露出されたノードのパラメータにアニメーションカーブを設定します。
-
露出されたノードにT,R,S値を設定するための特別な便利関数。
Assets ¶
-
hapi.getAssetDefinitionParmCounts
アセットライブラリに含まれているアセットパラメータの数、パラメータのint/float/stringの数、選択した値の数を取得します。
-
hapi.getAssetDefinitionParmInfos
指定したアセットライブラリ内の指定したアセットのパラメータ情報でhapi.ParmInfo構造体の配列を埋めます。
-
hapi.getAssetDefinitionParmValues
指定したアセットライブラリ内の指定したアセットのパラメータのint/float/string値と選択した値でパラメータの配列を埋めます。
-
ノードからasset_info構造体を埋めます。
-
読み込まれているアセットライブラリのファイルパスのHAPI_StringHandleを取得します。
-
Houdiniに読み込まれているHDAのHAPI_AssetLibraryIdを取得します。
-
アセットライブラリに含まれているアセットの数を取得します。
-
アセットライブラリに含まれているアセットの名前を取得します。
-
hapi.getLoadedAssetLibraryCount
Houdiniに読み込まれているHDAの数を取得します。
-
.otlファイルからHoudiniアセットライブラリ(OTL)を読み込みます。
-
hapi.loadAssetLibraryFromMemory
メモリからHoudiniアセットライブラリ(OTL)を読み込みます。
Attributes ¶
-
名前で指定されたアトリビュートからアトリビュート情報の構造体を取得します。
-
アトリビュートオーナーを指定してアトリビュート名のリストを取得します。
Caching ¶
-
現在アクティブなキャッシュの数を取得します。
-
現在アクティブなキャッシュの名前を取得します。
-
現行Houdiniコンテキスト内のメモリキャッシュ別に特定のプロパティを検査することができます。
-
指定した書式でジオメトリの現行状態をメモリにキャッシュ化し、そのサイズを返します。
-
ファイルからジオメトリを読み込んで、その内容をSOPノードに格納します。
-
メモリからジオメトリを読み込んで、その内容をSOPノードに格納します。
-
指定したファイルを読み込んで、以前に保存されたノードとそのすべての内容を生成します。
-
ジオメトリをファイルに保存します。
-
キャッシュ化されたジオメトリをメモリのバッファに保存します。
-
ノードとそのすべての内容をファイルに保存します。
-
現行Houdiniコンテキスト内の別々のメモリキャッシュの特定のプロパティを変更することができます。
classes ¶
-
hapi.getAssetInfoが返すHDAに関するメタデータ。
-
アトリビュートを表現したメタデータ。
-
ボックスパートのデータ。
-
Houdiniのコンポジットコンテキスト用の構成オプション。
-
ノードがクックされる方法に影響を与えるオプション。
-
カーブメッシュに関連付けられているメタデータ(同じタイプのカーブの数)を示します。
-
SOPノードのメタデータ。
-
ハンドルパラメータとアセットパラメータをマッピングしたバインド情報が含まれています。
-
ハンドルのタイプ(translate, rotate, scale, softxformなど)や現行ハンドルがバインドされているパラメータの数などのハンドル情報が含まれています。
-
hapi.getSupportedImageFileFormatsで使用される画像フォーマットを示します。
-
hapi.getImageInfoやhapi.setImageInfoで使用される画像のデータ。
-
hapi.InputCurveInfoクラス。
-
単一キーフレームのデータ。
-
hapi.MaterialInfoクラス。
-
Houdiniノードのメタデータ。
-
OBJノードのメタデータ。
-
PDGイベント関連のデータ。
-
PDGワークアイテムの情報。
-
PDG出力ファイルに関するデータ。
-
PDG File Resultのデータ。
-
コンボボックス/選択パラメータのメタデータ。
-
名前、ラベル、タイプ、サイズなどのパラメータ情報が含まれています。
-
ジオメトリパートを表現したメタデータ。
-
セッションを調べます。
-
Houdiniと他のアプリケーション間の一般的なSessionSync状態を同期化するための情報が含まれています。
-
球パートのデータ。
-
HARCから起動されるThriftサーバーを設定するオプション。
-
hapi.setTimelineOptionsで使用されるグローバルタイムラインのデータ。
-
クォータニオン回転によるトランスフォーム。
-
オイラー回転によるトランスフォーム。
-
Houdiniと他のアプリケーション間でビューポートを同期化するための情報が含まれています。
-
これは、ボリュームプリミティブを表現していますが、実際のボクセル値は含まれていません。ボクセル値はタイル基準で取得することができます。
-
hapi.VolumeTileInfoはボリュームの3次サブ配列を表現します。
-
ボリュームの視覚的設定を示します。
Curves ¶
-
パート内の各カーブの頂点数を取得します。
-
カーブに関するメタデータ(カーブのタイプ、階数、周期性を含む)を取得します。
-
このパート内のカーブのノットを取得します。
-
カーブの階数が可変する場合にパート内の各カーブの階数を取得します。
-
パート内の各カーブの頂点数を設定します。
-
カーブメッシュにメタデータ(カーブのタイプ、階数、周期性を含む)を設定します。
-
このパート内のカーブのノットを設定します。
-
カーブの階数を可変させる場合、パート内の各カーブの階数を設定します。
Environment ¶
-
バージョン番号など特定の環境整数を取得します。
-
サーバープロセスから環境変数を整数として取得します。
-
サーバープロセスから環境変数を文字列として取得します。
-
サーバー環境のプロセス内に存在する環境変数の数を取得します。
-
サーバーのプロセス内のすべての環境変数のリストを取得します。
-
使用中の現行ライセンスタイプなど特定のセッション特有の環境整数を取得します。
-
サーバープロセス用の整数型の環境変数を設定します。
-
サーバープロセス用の文字列型の環境変数を設定します。
functions ¶
-
グローバルのコンポジターオプションを取得します。
-
グローバルのコンポジターオプションを設定します。
Geometry ¶
-
ジオメトリパート(これがボックスなら)のボックス情報を取得します。
-
(ジオメトリパートが球の場合に)ジオメトリパート上の球情報を取得します。
GeometryGetters ¶
-
hapi.getAttributeDictionaryArrayData
配列アトリビュートの辞書データを取得します。
-
hapi.getAttributeDictionaryData
アトリビュートの辞書データを取得します。
-
hapi.getAttributeFloat64ArrayData
配列アトリビュートの64ビット浮動小数点データを取得します。
-
64ビットアトリビュート浮動小数点データを取得します。
-
hapi.getAttributeFloatArrayData
配列アトリビュートの浮動小数点データを取得します。
-
アトリビュートの浮動小数点データを取得します。
-
hapi.getAttributeInt16ArrayData
配列アトリビュートの16ビット整数データを取得します。
-
アトリビュートの16ビット整数データを取得します。
-
hapi.getAttributeInt64ArrayData
配列アトリビュートの64ビット整数データを取得します。
-
アトリビュートの64ビット整数データを取得します。
-
hapi.getAttributeInt8ArrayData
配列アトリビュートの8ビット整数データを取得します。
-
アトリビュートの8ビット整数データを取得します。
-
配列アトリビュートの整数データを取得します。
-
アトリビュートの整数データを取得します。
-
hapi.getAttributeStringArrayData
配列アトリビュートの文字列データを取得します。
-
アトリビュートの文字列データを取得します。
-
hapi.getAttributeUInt8ArrayData
配列アトリビュートの符号なし8ビット整数データを取得します。
-
アトリビュートの符号なし8ビット整数データを取得します。
-
Objectノード内のディスプレイジオメトリ(SOP)ノードを取得します。
-
ジオメトリパーツ上のエッジグループに属しているエッジの数を取得します。
-
フェースの配列を取得します。その配列内のn番目の整数は、n番目のフェースが所有している頂点数です。
-
SOPノード上のジオメトリ情報の構造体(::HAPI_GeoInfo)を取得します。
-
hapi.getGroupCountOnPackedInstancePart
指定したパックインスタンスパートのグループ数を取得します。
-
グループメンバーシップを取得します。
-
hapi.getGroupMembershipOnPackedInstancePart
パックインスタンスパートのグループメンバーシップを取得します。
-
ジオメトリ全体のグループ名を取得します。
-
hapi.getGroupNamesOnPackedInstancePart
パックインスタンスパートのグループ名を取得します。
-
このインスタンサーパートがインスタンス化しているパートIDを取得します。
-
hapi.getInstancerPartTransforms
hapi.getInstancedPartIdsから取得したインスタンス化されるパートをインスタンス化する際のインスタンサーパートのトランスフォームのリストを取得します。
-
ObjectノードやSOPノード内のメインのジオメトリ出力の数を取得するヘルパーメソッド。
-
ノードのメインジオメトリ出力のジオメトリ情報構造体(::HAPI_GeoInfo)を取得します。
-
特定のパート情報の構造体を取得します。
-
頂点ポイントを含んだ配列(この配列内のi番目の要素がi番目の頂点に関連付けられているポイントインデックス)を取得します。
GeometrySetters ¶
-
アトリビュートを追加します。
-
指定したタイプと名前のグループを入力ジオメトリに追加します。
-
クックエンジンの現行入力ジオメトリを確定します。
-
入力ジオメトリからアトリビュートを削除します。
-
指定したタイプと名前のグループを入力ジオメトリから削除します。
-
このジオメトリに確定されたすべての変更を削除します。
-
hapi.setAttributeDictionaryArrayData
アトリビュート辞書配列データを設定します。
-
hapi.setAttributeDictionaryData
アトリビュート辞書データを設定します。
-
64ビット浮動小数点アトリビュートデータを設定します。
-
hapi.setAttributeFloat64UniqueData
複数アトリビュート64ビット浮動小数点データに同じ固有の値を設定します。
-
浮動小数点アトリビュートデータを設定します。
-
hapi.setAttributeFloatUniqueData
複数アトリビュート浮動小数点データに同じ固有の値を設定します。
-
hapi.setAttributeIndexedStringData
インデックスでアトリビュート文字列データを設定します。
-
16ビットアトリビュート整数データを設定します。
-
hapi.setAttributeInt16UniqueData
複数アトリビュート16ビット整数データに同じ固有の値を設定します。
-
64ビット整数アトリビュートデータを設定します。
-
hapi.setAttributeInt64UniqueData
複数アトリビュート64ビット整数データに同じ固有の値を設定します。
-
8ビットアトリビュート整数データを設定します。
-
hapi.setAttributeInt8UniqueData
複数アトリビュート8ビット整数データに同じ固有の値を設定します。
-
整数アトリビュートデータを設定します。
-
hapi.setAttributeIntUniqueData
複数アトリビュート整数データに同じ固有の値を設定します。
-
hapi.setAttributeStringArrayData
アトリビュート文字列配列データを設定します。
-
文字列アトリビュートデータを設定します。
-
hapi.setAttributeStringUniqueData
複数アトリビュート文字列データに同じ固有の値を設定します。
-
hapi.setAttributeUInt8ArrayData
符号なし8ビット整数配列アトリビュートデータを設定します。
-
符号なし8ビットアトリビュート整数データを設定します。
-
hapi.setAttributeUInt8UniqueData
複数アトリビュート符号なし8ビット整数データに同じ固有の値を設定します。
-
フェースの配列(この配列内のn番目の整数はn番目のフェースが持っている頂点の数です)を設定します。
-
グループメンバーシップを設定します。
-
メインのパート情報の構造体(::HAPI_PartInfo)を設定します。
-
頂点ポイントを含んだ配列(この配列内のi番目の要素がi番目の頂点に関連付けられているポイントインデックス)を設定します。
HeightFields ¶
-
Height Field入力に必須のノード階層を作成します。
-
hapi.createHeightfieldInputVolumeNode
Height Fieldに使用可能なボリューム入力ノードを作成します。
HipFiles ¶
-
.hipファイルを読み込んだ結果として作成されたノードの数を取得します。
-
HAPI_HIPFileIdで指定されたHIPファイルを読み込んだ結果として作成されたノードのHAPI_NodeIdの配列を取得します。
-
メインのHoudiniシーンに.hipファイルを読み込みます。
-
メインのHoudiniシーンに.hipファイルを読み込みます。
-
現行Houdiniシーンの.hipファイルを保存します。
InputCurves ¶
-
カーブ入力ジオメトリSOPを具体的に作成するためのヘルパー。
-
入力カーブに関するメタデータ(カーブのタイプ、階数、カーブが閉じているのか反転しているのかなど)を取得します。
-
入力カーブにメタデータ(カーブのタイプ、階数、カーブが閉じているのか反転しているのかなどのプロパティ)を設定します。
-
入力カーブの位置を設定し、カーブの有効性チェックを実行し、必要に応じてカーブ設定を調整し、
-
hapi.setInputCurvePositionsRotationsScales
入力カーブの位置を設定し、カーブの有効性チェックを実行し、必要に応じてカーブ設定を調整します。
Materials ¶
-
レンダリングした画像をファイルに抽出します。
-
レンダリングした画像をメモリに抽出します。
-
この画像の保存先となるファイル名を取得します。
-
解像度やデフォルトファイルフォーマットなどのレンダリングされた画像に関する情報を取得します。
-
抽出した画像バッファを割り当て先のバッファに埋めます。
-
レンダリングされた画像の画像平面の数を取得します。
-
レンダリングされた画像から画像平面の名前を取得します。
-
マテリアル情報を取得します。
-
hapi.getMaterialNodeIdsOnFaces
フェース/プリミティブ単位でマテリアルIDsを取得します。
-
hapi.getSupportedImageFileFormatCount
対応しているテクスチャファイルフォーマットの数を取得します。
-
hapi.getSupportedImageFileFormats
対応している画像ファイルフォーマットのリスト(フォーマットの名前、説明、認識される拡張子のリスト)を取得します。
-
後工程用にCOPから単一テクスチャを画像に書き出します。
-
後工程用に単一テクスチャのみを画像に書き出します。
-
解像度やファイルフォーマットなどの画像情報を設定します。
Nodes ¶
-
指定したフィルターに基づいて子ノードのリストを作成します。
-
2つノード間を接続します。
-
このノード上でクックを開始します。
-
ジオメトリ入力を受け取ることができる単純なジオメトリSOPノードを作成します。
-
ノードネットワーク内にノードを作成します。
-
ノードネットワークからノードを削除します。
-
ノード入力を接続解除します。
-
ノードの出力インデックスでのすべての出力を接続解除します。
-
以前のhapi.composeChildNodeListコールから構成された子ノードIDのリストを取得します。
-
特定のネットワークタイプ(例えば、OBJ)のルートノードを取得します。
-
指定したパスのノードのIDを取得します。
-
hapi.NodeInfo構造体を埋めます。
-
ノードの入力の名前を取得します。
-
ノードの出力の名前を取得します。
-
Houdiniノードネットワークの絶対パスまたは他のノードを基準とした相対パスでノードパスを取得します。
-
SOPネットワーク内の出力ノードのノードIDを取得します。
-
指定したノード(指定があれば子ノードを含む)の合計のクック回数を取得します。
-
ノードのインスタンスが実際にまだHoudiniシーン内に存在しているかどうか確認します。
-
他のノードの入力に接続されているノードを照会します。
-
hapi.queryNodeOutputConnectedCount
指定したノードの出力インデックスに現在接続されているノードの数を取得します。
-
hapi.queryNodeOutputConnectedNodes
指定したノードの出力インデックスに現在接続されているノードのIDsを取得します。
-
作成したノードの名前を変更します。
-
指定したノードのディスプレイフラグを設定します。
Objects ¶
-
指定した親ノードIDに基づいて子オブジェクトノードのリストを作成します。
-
hapi.ObjectInfo構造体の配列を埋めます。
-
hapi.getComposedObjectTransforms
hapi.Transform構造体の配列を埋めます。
-
hapi.getInstanceTransformsOnPart
指定したパートのこのインスタンサーオブジェクトのインスタンス毎のトランスフォームでhapi.Transform構造体の配列を埋めます。
-
Instance OBJノードによってインスタンス化されているオブジェクトのノードIDを取得します。
-
OBJノードのオブジェクト情報を取得します。
-
OBJノードのトランスフォームを取得します。
-
個々のオブジェクトのトランスフォームを設定します。
Parms ¶
-
指定したノード上の特定のハンドルのバインドに関する情報でhapi.HandleBindingInfo構造体の配列を埋めます。
-
ノード上に露出されたすべてのユーザ操作ハンドルに関する情報でhapi.HandleInfo構造体の配列を埋めます。
-
アセットインスタンスノードからのパラメータ情報でhapi.ParmInfo構造体の配列を埋めます。
-
アセットインスタンスノードからパラメータ選択リスト情報でhapi.ParmChoiceInfo構造体の配列を埋めます。
-
パラメータ名で整数または浮動小数点の単一パラメータエクスプレッションを取得します。
-
パラメータ上のパスで指定されたファイルを抽出します。
-
パラメータ名で浮動小数点の単一パラメータ値を取得します。
-
浮動小数点パラメータ値の配列を埋めます。
-
どのパラメータAPIもHAPI_ParmIdが必要ですが、操作したいパラメータの名前が分かっているなら、この関数を使用することで、指定した名前からHAPI_ParmIdを取得することができます。
-
パラメータIDで指定されたパラメータのパラメータ情報を取得します。
-
パラメータ名で指定されたパラメータのパラメータ情報を取得します。
-
パラメータ名で指定された単一整数パラメータ値を取得します。
-
整数パラメータ値の配列を埋めます。
-
Op Pathパラメータから単一パラメータのノードID値を取得します。
-
パラメータ名で指定された単一文字列パラメータ値を取得します。
-
文字列パラメータハンドルの配列を埋めます。
-
パラメータ上の指定したインデックスのタグ名を取得します。
-
パラメータ上の指定したタグ名のタグ値を取得します。
-
指定したタグ名(固有な名前が理想)を持つ最初のパラメータを取得します。
-
マルチパラメータのインスタンスをinstance_positionの前に挿入します。
-
パラメータがエクスプレッションを持っているかどうかを確認します。
-
パラメータが特定のタグを持っているかどうかを確認します。
-
instance_positionで指定されたマルチパラメータのインスタンスを削除します。
-
エクスプレッション文字列を削除し、そのパラメータの値をそのエクスプレッションの現行値で残します。
-
パラメータ名で指定された単一パラメータをデフォルトに戻します。
-
パラメータ名で指定されたパラメータのすべてのインスタンスをデフォルトに戻します。
-
エクスプレッション文字列を設定(プッシュ)します。
-
パラメータ名で指定された単一浮動小数点パラメータの値を設定します。
-
浮動小数点パラメータ値の配列を設定(プッシュ)します。
-
パラメータ名で指定された単一整数パラメータの値を設定します。
-
整数パラメータ値の配列を設定(プッシュ)します。
-
Op PathパラメータのノードIDパラメータ値を設定します。
-
文字列値を設定(プッシュ)します。
PDG ¶
-
PDGクックオペレーションをキャンセルします。
-
保留中のワークアイテムを確定します。
-
PDGのクックオペレーションを開始します。
-
PDGのクック処理を開始します。これは非同期にすることができます。
-
指定したノードから新しい保留ワークアイテムを作成します。
-
指定したノードをDirty(変更あり)にします。
-
指定したノード上で利用可能なワークアイテムの数を取得します。
-
収集されたPDGイベントを返します。
-
指定したTOPノードのPDGグラフコンテキストを取得します。
-
PDGグラフコンテキストの名前とそのIDの配列を返します。
-
見つかったPDGグラフコンテキストの総数を返します。
-
PDGグラフの状態を取得します。
-
ワークアイテムアトリビュートのサイズを取得します。
-
hapi.getWorkItemFloatAttribute
ワークアイテムアトリビュートから浮動小数点データを取得します。
-
IDで指定されたワークアイテムの情報を取得します。
-
ワークアイテムアトリビュートから整数データを取得します。
-
ワークアイテム出力ファイルの情報を取得します。
-
hapi.getWorkItemStringAttribute
ワークアイテムアトリビュートから文字列IDを取得します。
-
指定したノードのワークアイテムIDsのリストを取得します。
-
ワークアイテムデータメンバーの長さを取得します。
-
ワークアイテムメンバーから浮動小数点データを取得します。
-
ワークアイテムメンバーから整数データを取得します。
-
ワークアイテム結果の情報を取得します。
-
ワークアイテムメンバーから文字列IDsを取得します。
-
PDGクック操作を中止します。
-
hapi.setWorkItemFloatAttribute
指定したノードの中断PDGワークアイテムアトリビュートに浮動小数点データを追加します。
-
指定したノードの中断PDGワークアイテムアトリビュートに整数データを追加します。
-
hapi.setWorkItemStringAttribute
指定したノードの中断PDGワークアイテムアトリビュートに文字列データを追加します。
-
指定したノードの保留PDGワークアイテムデータメンバーに浮動小数点データを追加します。
-
指定したノードの保留PDGワークアイテムデータメンバーに整数データを追加します。
-
指定したノードの保留PDGワークアイテムデータメンバーに文字列データを追加します。
Presets ¶
-
指定したアセット用のプリセットを生成します。
-
すべてのパラメータ値の現行状態からプリセットの塊を生成し、それをキャッシュ化して、そのサイズ(単位はバイト)を返します。
-
指定したプリセットを特定のアセットに設定します。
Sessions ¶
-
新しく実装したDLLをカスタムセッションスロットのどれかにバインドします。
-
メモリをクリーンアップします。
-
セッションを閉じます。
-
インプロセスで新しいセッションを作成します。
-
hapi.createThriftNamedPipeSession
Windowsの名前付きパイプ(Named Pipe)またはUNIXのドメインソケットをトランスポートとして使用してThrift RPCセッションを作成します。
-
hapi.createThriftSocketSession
TCPソケットをトランスポートとして使用してThrift RPCセッションを作成します。
-
アセットマネージャを作成し、環境変数をセットアップして、メインのHoudiniシーンを初期化します。
-
ランタイムが既にhapi.initializeを使用して初期化されているかどうかを確認します。
-
hapi.Session.idで指定されたセッションがhapi.Session.typeで指定された実装で開かれた有効なセッションなのかどうかを確認します。
-
In-Processセッションを使用している場合、ホストのプロセスがきちんとシャットダウンできるようにするために必ずこのメソッドをコールしなければなりません。
-
hapi.startThriftNamedPipeServer
Windowsの名前付きパイプ(Named Pipe)またはUnixのドメインソケットでクライアントにサービスを提供するThrift RPCサーバープロセスをローカルホスト上で起動し、そのサービスを開始するのを待機します。
-
TCPソケットでクライアントにサービスを提供するThrift RPCサーバープロセスをローカルホスト上で起動し、そのサービスを開始するのを待機します。
SessionSync ¶
-
HoudiniとHoudini Engineインテグレーション間でSessionSync状態を同期化するためのを取得します。
-
SessionSyncでビューポートを同期化するための情報を取得します。
-
SessionSyncモードを有効または無効にします。
-
HoudiniとHoudini Engineインテグレーション間でSessionSync状態を同期化するためのhapi.SessionSyncInfoを設定します。
-
SessionSyncでビューポートを同期化するためのhapi.Viewport情報を設定します。
Status ¶
-
ノードのエラーコードから特定のエラーを再帰的にチェックします。
-
接続エラーをクリアします。
-
指定したノードのクック結果文字列(エラーと警告)を生成します。
-
hapi.getComposedNodeCookResult
単一ノードのクック結果文字列メッセージを返します。
-
接続エラーメッセージを返します。
-
接続エラーメッセージが格納された文字列バッファの長さを返します。
-
現行セッションで既にクックされたノードの現在の数を取得します。
-
現行セッションでクックする必要のあるノードの総数を取得します。
-
Type Propertiesで設定されているメッセージノードの数を取得します。
-
Type Propertiesで設定されているメッセージノードのIDを取得します。
-
コール中に作成されたクック結果文字列を返します。
-
指定したノードのクック結果文字列(エラーと警告)の長さを取得します。
-
特定のステータスタイプのステータスコードを取得します。
-
ステータスの文字列メッセージを返します。
-
ステータスの文字列メッセージが格納された文字列バッファの長さを返します。
-
クックまたはロードの操作を中断します。
Strings ¶
-
指定した文字列ハンドルの値を取得します。
-
指定した文字列ハンドルの値を取得します。
-
指定した文字列ハンドルをNull区切りしたすべての値を格納するのに必要なバッファの長さを取得します。
-
指定したハンドルの文字列長を取得します。
-
指定した文字列をサーバーから削除し、そのハンドルを無効化します。
-
指定した文字列を文字列テーブルに追加して、そのハンドルを返します。
Time ¶
-
シーンのグローバル時間を取得します。
-
現行グローバルタイムラインオプションを取得します。
-
Houdiniセッションがデータをクックして取得する際にHoudiniの現行時間を使用するかどうかを返します。
-
アセットのシミュレーションキャッシュをリセットします。
-
シーンのグローバル時間を設定します。
-
グローバルタイムラインオプションを設定します。
-
Houdiniセッションがデータをクックして取得する際にHoudiniの現行時間を使用するかどうかを設定します。
types ¶
-
hapi.attributeOwner列挙型。
-
hapi.attributeTypeInfo列挙型。
-
メモリキャッシュを調べます。
-
hapi.choiceListType列挙型。
-
hapi.curveOrders列挙型。
-
hapi.curveType列挙型。
-
hapi.getEnvIntで使用して、現在リンクされているHAPI実装に関する基本情報を取得します。
-
hapi.errorCode列挙型。
-
hapi.geoType列挙型。
-
hapi.groupType列挙型。
-
Height Fieldのサンプリングのタイプ。
-
hapi.imageDataFormat列挙型。
-
hapi.imagePacking列挙型。
-
hapi.inputCurveMethodの列挙。
-
hapi.inputCurveParameterization
hapi.inputCurveParameterizationの列挙。
-
hapi.inputType列挙型。
-
hapi.license列挙型。
-
ノードリストの構成をフィルタリングする際に使用されるフラグ。
-
hapi.nodeType列挙型。
-
hapi.packedPrimInstancingMode列挙型。
-
パラメータのデータタイプを示します。
-
hapi.partType列挙型。
-
PDG関数で使用します。
-
PDG関数で使用します。
-
PDG関数で使用します。
-
hapi.permissions列挙型。
-
hapi.presetType列挙型。
-
hapi.rampType列挙型。
-
hapi.result列挙型。
-
hapi.rstOrder列挙型。
-
この列挙型をhapi.getSessionEnvIntで使用することで、セッション固有の基本的な情報を取得することができます。
-
hapi.sessionType列挙型。
-
hapi.state列挙型。
-
hapi.statusType列挙型。
-
hapi.statusVerbosity列挙型。
-
hapi.storageType列挙型。
-
hapi.transformComponent列挙型。
-
hapi.volumeType列挙型。
-
hapi.volumeVisualType列挙型。
-
hapi.xyzOrder列挙型。
Utility ¶
-
4×4行列をTRS形式に変換します。
-
4×4行列をTRS形式に変換します。
-
hapi.TransformEuler構造体で表現されたトランスフォームを色々なトランスフォーム順と回転順に変換します。
-
hapi.convertTransformEulerToMatrix
hapi.TransformEulerを4×4トランスフォーム行列に変換します。
-
hapi.convertTransformQuatToMatrix
hapi.Transformを4×4トランスフォーム行列に変換します。
-
hapi.pythonThreadInterpreterLock
Pythonインタープリタのロックを確保または解放します。
Volumes ¶
-
8×8×8区画のボリュームに基づいてそのボリュームをループします。
-
地形ボリュームのHeight Fieldデータを平坦な浮動小数点高さの2D配列として取得します。
-
8×8×8区画のボリュームに基づいてそのボリュームをループします。
-
ボリュームの境界値を取得します。
-
ボリュームプリミティブに関するメタデータ(トランスフォーム、位置、スケール、テーパー、解像度を含む)を取得します。
-
タイルが示すボクセルの浮動小数点値を取得します。
-
タイルが示すボクセルの整数値を取得します。
-
ボリュームのビジュアライゼーション用メタデータを取得します。
-
指定したインデックスにおけるボクセルの浮動小数点値を取得します。
-
指定したインデックスにおけるボクセルの整数値を取得します。
-
平坦な浮動小数点の2D配列の値で地形ボリュームのHeight Fieldデータを設定します。
-
ジオメトリ入力のジオメトリのボリューム情報を設定します。
-
浮動小数点タイルの値を設定します: このタイルは8×8×8区画のボリュームです。
-
整数タイルの値を設定します: このタイルは8×8×8区画のボリュームです。
-
ボリューム内に浮動小数点ボクセルの値を設定します。
-
ボリューム内に整数ボクセルの値を設定します。