bool initialize(float now, string camera, dict options={})

指定したビューイングカメラを使ってSOHOを初期化します。 カメラが見つからなければ、この初期化は失敗します。 シーン内のすべてのオブジェクトはクリアされます。 このコールの後は、2つのオブジェクト(Outputドライバとカメラ)が残っているはずです。

カメラのパスには、Houdiniのカメラのパスを指定してください。 オプションで、カメラのパスのリストを指定することができます。 このカメラ(またはカメラのリスト)は、objlist:camera内部SOHOステートのシードに使用されます。

ビューポートメニューからレンダリングすると、この関数はカメラオブジェクトがなくても成功します。 この理由は、ビューポートは実際のHoudiniオブジェクトを使わなくてもパラメータ値を用意することができるからです。 この場合には、カメラの名前は“view-camera”になります。 このプロセスに関する詳細は、$HH/soho/overridesを参照してください。

初期化の後は、addCandidates()を使用することで、Houdiniオブジェクトをシーンに追加/削除することができます。 すべてのオブジェクトを追加した時に、lockCandidates()をコールします。

典型的なプロセスのコールは以下のとおりです:

if sohoglue.initialize(now, camera):
    sohoglue.addCandidates(now, ...)
    sohoglue.addCandidates(now, ...)
    sohoglue.addCandidates(now, ...)
    sohoglue.lockCandidates(now)

addCandidates(), lockCandidates()

bool addCandidates(float now, string geometry="", string lights="", string fog="", bool do_culling = True, bool do_removal = False)

この関数は、SOHOで表現されたオブジェクトのリストからHoudiniオブジェクトを追加/削除します。 DOP Objects、インスタンス化、他のレンダリング機能すべてが処理されます。

パターンがHoudiniオブジェクト(SOHOオブジェクトではなく)を参照します。

lockCandidates()関数がコールされるまで、オブジェクトはSOHOからは見えません。

initialize(), lockCandidates()

bool lockCandidates(float now)

addCandidates()を使用してHoudiniオブジェクトをシーンに追加した後に、 lockCandidates()は、それらのオブジェクトをSOHOから見えるようにします。

initialize(), addCandidates()

bool finalize()

(Outputドライバ以外の)シーンの内容をクリアします。

<file> getFile(int descriptor)

Outputドライバが、パイプとエラーのストリーム用に、ファイルオブジェクトを作成します。 このメソッドは、それらのファイルオブジェクトにアクセスするために使用します。 通常では、これは、以下のように扱います:

import sys
sys.stdout = soho.getFile(1)
sys.stderr = soho.getFile(2)

上記のように処理したかどうかに関わらず、Pythonコードの実行が終わると、SOHOは、sysのファイルオブジェクトを返します。

object = newIterator(selection, now, object, pattern, category_expr)

オブジェクトの選択を反復させるためのオブジェクトを作成します。

category_exprとpatternのパラメータは、オブジェクトカテゴリキーワードや名前パターンに基づいた選択のフィルタリングを上書きすることができます。

category_exprとpatternのパラメータがない時は、デフォルトのオブジェクトのコントロールパラメータを使用して、選択をフィルタリングします。 例えば、オブジェクトの“lightmask”と“lightcategories”のパラメータは、 “objlist:lightmask”選択に使用します。

この関数の戻りコードをnextIteratorに使用することができます。

nextIterator()

handle = nextIterator(iterator)

SOHOイテレータオブジェクトから次のオブジェクトを返します。

newIterator()

list evaluate(list parameters, float now, int handle)

この関数は、パラメータのリストを評価して、その評価されたパラメータのリストを返します。 これにはリストまたは辞書のどちらかを指定することができます。 戻り値は、渡されたオブジェクトと同じタイプです。

dict decodeParmId(parm.ParmId)

パラメータが評価された時に、SOHOは、Houdiniノードがパラメータを評価した時の情報をそのパラメータにタグ付けすることができます。 この情報は、評価されたパラメータのParmIdアトリビュートに保存されます。

decodeParmId()関数は、この情報を復元して、評価に使用されたHoudiniパラメータに関する情報を含んだ辞書を返します。

void addBundleDependency(string bundle_name)

ノードバンドルをIPRレンダーに対して書き出す時、起動しているHoudiniセッション内のそのバンドルの変更を追跡する必要があります。 この関数は、指定したバンドルの変更を追跡し、そのバンドルの内容が変わった際にIPR更新を送信するようにHoudiniに伝えます。

bool storeObjectData(int handle, string token, object data)

このメソッドは、任意の名前のデータをオブジェクトと一緒に保存することができます。 getObjectData()を使用することで、後でそのデータを取得することができます。

トークン文字列は、後でデータを取得できるように、まったく固有な識別子にしてください。

getObjectData(), clearObjectData()

object getObjectData(int handle, string token)

この関数は、storeObjectData()によってオブジェクトと一緒に保存されたデータを取得します。 データが保存されていない場合は、この関数はNoneを返します。

storeObjectData(), clearObjectData()

bool clearObjectData(int handle)

この関数は、オブジェクトと一緒に保存されたすべてのローカルデータをクリアします。 これは、シーンをfinalized()した時に自動的に実行されます。

storeObjectData(), getObjectData()

bool addDependency(int handle, int dependency)

この関数は、シーン内のあるオブジェクトから他のオブジェクトへのIPR依存関係を追加します。 依存されているオブジェクトに変更が加えられた時、それに依存したオブジェクトに対して更新がトリガーされます。

string,string processShaderString(string shader, dict options)

シェーダがSOPまたはジオメトリから参照されている時、そのシェーダは、.hipファイル内で定義されているシェーダ、テクスチャマップ、他のファイルを参照することができます。

このコマンドは、シェーダ文字列を処理し、可能であれば、VOPネットワークをコンパイルしたり、COPネットワークを評価して、そのレンダーに対してデータを準備します。

レンダー形式(initialize()を参照)に基づいて、COPとVOPのネットワークが評価されて、そのレンダースクリプトに適切なデータを生成します。

この関数は、2つの文字列のタプルを返します。

void pushOverrides(dict overrides)

シェーダのパラメータとプロパティを評価する時、オーバーライド値のセットを指定することができます。 それらのオーバーライド値は、名前/値のペアになっており、その名前はHoudiniパラメータです。 オーバーライドは、SOHOオブジェクトレベルで自動的に処理されます。 とはいえ、これは(それらのオーバーライドをアトリビュートとして保存している)ジオメトリオブジェクトに対しての場合ではありません。 このメソッドは、評価に対して任意のオーバーライドをプッシュすることができます。 popOverrides()を使用して値をポップすることは非常に重要です。と言っても、これはSOHOモジュールのPropertyOverrideクラスでハンドルされますが。

popOverrides

void popOverrides()

pushOverrides()でプッシュされたオーバーライドをポップします。

pushOverrides()

bool indent([int bump=0, [string text="", [string comment='#', [string closecomment='']]]])

SOHOライブラリは、スクリプトの見た目を良くするために内部的にインデントを維持します。

indent()関数のすべての引数はオプションであり、デフォルト値は上記のとおりです。

このコードは、Pythonコードと等価です:

def indent(bump, text, comment):
    bump *= 4
    if bump < 0:
        theIndent += bump
    print "%*s" % (theIndent, "")
    if text:
        if text:
            print "%s" % text,
        if comment:
            if bump < 0:
                print "\t%s } %s\n" % (comment, closecomment)
            else
                print "\t%s { %s\n" % (comment, closecomment)
    if bump > 0:
        theIndent += bump

bool printArray(string open, list array, string close, [bool protect=True])

これは、値の配列を大括弧でプリントするための便利関数です。 浮動小数点の引数に関しては、この関数はSOHOライブラリで定義された精度を使用します。 文字列引数は、引用符で囲まれます(protectフラグが設定されている場合)。

配列は、openとcloseで指定したテキストで囲まれます。 例えば、Pythonコードでは以下のとおりです:

printArray("{", [1,2,"string value",4], "}\n")

これは、{1, 2, “string value”, 4}を出力します。

arrayToString()

string arrayToString(string open, list array, string close, [bool protect=True])

これは、大括弧で囲まれた配列値を文字列値に変換するための便利関数です。 浮動小数点の引数に関しては、この関数はSOHOライブラリで定義された精度を使用します。 文字列引数は、引用符で囲まれます(protectフラグが設定されている場合)。

配列は、openとcloseで指定したテキストで囲まれます。 例えば、Pythonコードでは以下のとおりです:

printArray("{", [1,2,"string value",4], "}\n")

これは、'{1, 2, “string value”, 4}'の文字列を出力します。

printArray()

int gCreate(string sop_path, float now)

このメソッドは、指定した時間の指定したSOPパスのジオメトリのハンドルを作成します。 このメソッドは、sohogモジュールで使用することで、Houdini内のジオメトリにアクセスすることができます。 このメソッドは、廃止されました。代わりにgCreate2を使用してください。

(int,string) gCreat2e(string sop_path, float now)

このメソッドは、指定した時間の指定したSOPパスのジオメトリのハンドルを作成します。 このメソッドは、sohogモジュールで使用することで、Houdini内のジオメトリにアクセスすることができます。 このメソッドは、そのハンドルと、そのハンドルが無効であればエラーメッセージをタプルで返します。

bool gDelete(int ghandle)

gCreate()によってアクセスしたジオメトリの参照を削除します。

sohog module, gPartition(), gCreate()

dict_object gPartition(int ghandle, string style, object data)

この関数は、ghandleで指定したジオメトリをstyleに応じて複数のジオメトリに分割します。

sohog module, gAttribute(), gValue()

int gAttribute(int ghandle, string scope, string name)

ジオメトリエンティティのアトリビュートにアクセスするためのハンドルを調べます。

sohog module, gValue(), gVertex()

object gValue(int ghandle, int ahandle, object element)

gAttribute()で一度ハンドルを作成してしまえば、ジオメトリエンティティに関連した値を調べることができます。 (gCreate()で生成した)ジオメトリハンドルと(gCreate()で生成した)アトリビュートハンドルをgValue()に渡してコールすれば、 グローバル値またはポイント、プリミティブ、頂点、アトリビュートに関連した値を調べることができます。 アトリビュートのスコープに応じて、elementを以下のどれかに指定してください:

geo:global - 無視されます。

geo:attrib - 照会するアトリビュートハンドル。

geo:prim - プリミティブ番号を意味した整数。

geo:point - ポイント番号を意味した整数。

geo:vertex - 整数タプル(2エントリー)。1番目のエントリーはプリミティブ番号、2番目のエントリーはそのプリミティブの頂点番号を意味しています。

gVertexメソッドは、単に頂点を評価するのに若干効率が良いです。

すべての値は、値のリストとして返されます。

sohog module, gAttribute(), gVertex()

object gVertex(int ghandle, int ahandle, int prim, int vertex)

gAttribute()で一度ハンドルを作成してしまえば、プリミティブの頂点に関連した値を調べることができます。 (gCreate()で生成した)ジオメトリハンドルと(gCreate()で生成した)アトリビュートハンドル、プリミティブ番号と頂点番号をこの関数に渡すと、 そのアトリビュートの値を取得することができます。

この関数を成功させるには、gAttribute()を“geo:vertex”のスコープでコールしなければなりません。

すべての値は、値のリストとして返されます。

sohog module, gAttribute(), gValue()

bool gSaveAll(int ghandle, string filename, dict options)

ghandleが参照しているジオメトリが、指定したファイルに保存されます。

保存する時、標準のHoudiniジオメトリ保存コードを調べます。つまり、Houdiniでサポートされているフォーマットを使用することができます。

このoptionsは、大元のジオメトリ保存に渡されます(保存オプションの詳細は、GA_SaveMap.hのHDKヘッダを参照)。

int gTesselate(dict options)

コールしたジオメトリをポリゴンに変換して、その新しくテセレートされたジオメトリのハンドルを返します。 追加オプションによりメタボールを変換するためのセカンダリメソッドがあります。 それは、明示的にtess:metastyleオプションを指定することで有効になります。詳細は、以下を参照してください。

オプションを指定しなかった場合は、デフォルトが使用されます。つまり、テセレータはU,Vとトリムカーブに対して1.0のLODを使用し、メタボールに対して何も変換しません。

message(severity, text)

出力ドライバのエラーリストにテキストを追加します。severityには以下の整数を指定します:

0 = 情報(メッセージ)としてテキストを追加。

1 = 警告としてテキストを追加。

2 = エラーとしてテキストを追加。

makeDirs(directory_path)

パーミッションが0777(誰でも読み/書き可)のディレクトリを再帰的に作成します。

これは、os.makedirs()メソッドと同様ですが、Houdiniパスを知っていて、ファイルシステムの拡張がされています。

gRelease(sop_path)

ジオメトリで使用されているけれども、ジオメトリが直接所有していない共有メモリなどのデータすべてを解放します。

sohoRixFlush(string marker, bool sync, string flushmode)

起動しているRenderManレンダラーを、指定したストリームマーカーに転送します。

• marker - これは、Riストリームに挿入された識別子文字列です。

• sync - これは、Flushが完了するまでコールを待たせるならTrue、そうでないならFalseです。

• flushmode - 転送中に('suspendrendering'に対して)レンダリングを停止させるのか('finishrendering'に対して)通常通りに処理させるのかどうかを示した文字列値。

sohoRixGetProgress()

現在のRenderManレンダリングの作業の進捗具合を返します。