関数
createParmsForProperty(source, primpath, propertyname, parametername,
prepend_control_parm, prefix_xform_parms) -> [Hom:hou.ParmTemplateGroup]
USDステージ上のプロパティを指定すると、このメソッドは、そのUSDプロパティを制御する
Edit Properties LOPノード上に配置可能なパラメータを表現したhou.ParmTemplateGroupオブジェクトを返します。
source
hou.LopNodeオブジェクトまたは文字列のどちらかを指定します。 hou.LopNodeオブジェクトの場合、そのLOPノードが所有しているUSDステージからプロパティが抽出されます。 文字列の場合、その指定したパスのディスク上のUSDファイルが読み込まれ、そこからプロパティが抽出されます。
primpath
プロパティが存在しているUSD Primのパス。
propertyname
作成されるパラメータのUSDプロパティの名前。
parametername
生成するパラメータの名前。 この値には文字列またはNoneを指定することができます。 Noneの場合、パラメータ名はプロパティ名に一致します。 このパラメータ名は、Edit Propertiesノードで編集されるプロパティ名を決定するので、 このパラメータの値を設定すると、パラメータの生成に使用されたプロパティとは異なるプロパティが編集されます。
prepend_control_parm
返されるパラメータテンプレートグループに、プロパティ値を設定/無視またはEdit Propertiesノードで対応している他の標準アクションのどれかを選択するためのメニューを含めたいのであればTrueに設定します。
prefix_xform_parms
指定したプロパティがトランスフォームプロパティの場合、このメソッドは、別々に移動パラメータ、回転パラメータ、スケールパラメータ、そしてトランスフォームマトリックスの生成で合成される他のパラメータを生成します。
このオプションをFalseに設定すると、それらの追加パラメータは、t、s、rのように標準のHoudiniトランスフォームパラメータ名を使用します。
Trueに設定すると、それらのパラメータ名の頭にプロパティ名が付きます。つまり、それらのパラメータ名はEdit Propertiesノード上の他のトランスフォームパラメータと干渉しません。
defaultNewPrimPath()
→ str
primpathパラメータがデフォルトの/$OSになっている新しいLOPノードでデフォルトで使用されるUSD Primパスを返します。
setDefaultNewPrimPath(path)
primpathパラメータがデフォルトの/$OSになっている新しいLOPノードでデフォルトで使用されるUSD Primパスを設定します。
これは、新しいUSD Primの作成で使用されるパラメータを特定します。
このデフォルトを制御することができることで、Primパスをスタジオ標準命名規則に準拠させるのが簡単になります。
defaultCollectionsPrimPath()
→ str
新しいコレクションの作成時にデフォルトロケーションとして使用されるUSD Primパスを返します。
設定されていなければ、そのデフォルト値は/collectionsです。
setDefaultCollectionsPrimPath(path)
新しいコレクションの作成時にデフォルトロケーションとして使用されるUSD Primパスを設定します。 このデフォルトを制御することができることで、Primパスをスタジオ全体の標準命名規則に準拠させるのが簡単になります。
defaultLightsPrimPath()
→ str
新しいライトの作成時にデフォルトロケーションとして使用されるUSD Primパスを返します。
設定されていなければ、そのデフォルト値は/lightsです。
setDefaultLightsPrimPath(path)
新しいライトの作成時にデフォルトロケーションとして使用されるUSD Primパスを設定します。 このデフォルトを制御することができることで、Primパスをスタジオ全体の標準命名規則に準拠させるのが簡単になります。
defaultTransformSuffix()
→ str
トランスフォームアトリビュート名のデフォルトの接尾辞として使用される文字列を返します。
setDefaultTransformSuffix(suffix)
トランスフォームアトリビュート名のデフォルトの接尾辞として使用される文字列を設定します。
USDトランスフォームは常にxformOp:で始まり、続いてトランスフォームタイプ(translate, rotate, transform)、そしてオプションでトランスフォームを表現した接尾辞が付きます。
この文字列は、この接尾辞を指定できる状況でHoudiniが使用するデフォルト値で、
LOPsで編集されたUSDレイヤーをスタジオ全体の標準命名規則に準拠させるのに役立ちます。
showResolvedPaths()
→ bool
解決済みレイヤーファイルパスを表示するオプションが有効になっていればTrueを返します。
setShowResolvedPaths(show_resolved_paths)
レイヤーファイルパスを表示するパネルがそのレイヤー上に設定されているそのままのパスを表示するのか、または、USD Path Resolverを介させた後のパスを表示するのかを制御するためのオプションを設定します。 解決済みパスは、通常ではディスク上のファイルのフルパスです。 一方で解決前のパスは、相対パス、検索パス、カスタムResolverで指定したパスフォーマットのどれかです。
panesFollowCurrentNode()
→ bool
Scene Graph TreeペインやScene Graph DetailsペインなどのLOPペインがネットワークエディタで選択された現行ノードに追従するようになっていればTrueを返します。
setPanesFollowCurrentNode(follow_current_node)
Scene Graph TreeペインやScene Graph DetailsペインなどのLOPペインがネットワークエディタで選択された現行ノードに追従するように設定します。 Falseに設定すると、代わりにこれらのペインは、ディスプレイフラグが設定されたLOPノードの情報を表示します。
useSimplifiedLinkerUi()
→ bool
Light LinkerペインやMaterial LinkerペインなどのLOPリンクエディタペインが軽量バージョンのインターフェースを使用していればTrueを返します。
setUseSimplifiedLinkerUi(use_simplified_linker_ui)
Light LinkerペインやMaterial LinkerペインなどのLOPリンクエディタが軽量バージョンのユーザーインターフェースを使用するように設定します。 軽量バージョンのユーザーインターフェースは、膨大な数のリンクルールを扱う時に処理が速くなります。 Falseに設定すると、代わりにこれらのペインは、より多機能でより情報が多い(しかし遅い)インターフェースを表示します。
autoSetAssetResolverContext()
→ bool
Sublayer LOPやReference LOPがディスクから読み込まれた1番目のUSDレイヤーを、USDステージに渡されるResolverコンテキストアセットパスとして使用してそのAsset Resolverコンテキストを自動的に定義するようになっていればTrueを返します。
setAutoSetAssetResolverContext(auto_set_context)
Sublayer LOPやReference LOPがディスクから読み込まれた1番目のUSDレイヤーを、USDステージに渡されるResolverコンテキストアセットパスとして使用してそのAsset Resolverコンテキストを自動的に定義するようする場合はTrueの値を渡します。 このResolverコンテキストは、特定のステージのコンテキスト内でレイヤーファイルを開く時に正しいファイルが見つけられるようにUSD Asset Resolverで使用されます。 たいていの場合、このResolverコンテキストは、ステージの"ルート"レイヤーを見ることで決めることができます。 LOPsの場合では、Sublayer LOPやReference LOPで読み込まれた1番目のレイヤーがその"ルート"レイヤーに一番近いものです。 このプリファレンスは、このワークフローの実装を簡単にします。 別の方法では、Configure Stage LOPをLOPネットワーク内の1番目のノードとして使用して、明示的にResolverコンテキストアセットパスを設定する必要があります。 同様に、このオプションは、Sublayer LOPまたはReference LOPがノードチェーンの1番目のノードだった場合にそれらのLOPにのみ影響します。
updateRendererInBackground()
→ bool
LOPビューポートがバックグラウンドで更新タスクを実行するように設定されていればTrueを返します。
setUpdateRendererInBackground(update_in_background)
LOPビューポートがバックグラウンドで更新タスクを実行するようにさせる場合はTrueの値を渡します。 これによってインタラクティブ性が良くなりますが、ビューポート表示が現行クックされているLOPステージと一時的に同期しません。
loadPayloadsByDefault()
→ bool
ビューポート内ですべてのペイロードを読み込むオプションを有効にして新しいLOPネットワークが作成されるようになっていればTrueを返します。
setLoadPayloadsByDefault(load_payloads)
ビューポート内ですべてのペイロードを読み込むオプションを有効にして新しいLOPネットワークが作成されるようにする場合はTrueの値を渡します。 新しいLOPネットワークに対してビューポート内でのペイロードの読み込みを無効にする場合はFalseの値を渡します。 既存のLOPネットワークは、このメソッドから何も影響を受けません。 このプリファレンスのデフォルト値はTrueです。
defaultMetersPerUnit()
→ float
この値を明示的に設定していないUSDレイヤーに保存されるユニットメートルあたりのデフォルトのメートルを返します。 0の値は、Houdiniの"Unit Length"オプションを使用してそれと等価のユニット値あたりのメートルが生成されることを意味します。
setDefaultMetersPerUnit(meters_per_unit)
この値を明示的に設定していないUSDレイヤーに保存されるユニットメートルあたりのデフォルトのメートルを設定します。 0の値は、Houdiniの"Unit Length"オプションを使用してそれと等価のユニット値あたりのメートルが生成されることを意味します。
defaultUpAxis()
→ str
この値を明示的に設定していないUSDレイヤーに保存されるデフォルトのUp軸の値を返します。 空っぽの文字列は、USD Up軸の代替値(pxr.UsdGeom.GetFallbackUpAxis)が使用されることを意味します。
setDefaultUpAxis(up_axis)
この値を明示的に設定していないUSDレイヤーに保存されるデフォルトのUp軸の値を設定します。
空っぽの文字列は、USD Up軸の代替値(pxr.UsdGeom.GetFallbackUpAxis)が使用されることを意味します。
他に対応している値は、YとZです。
それ以外の他の値を設定すると、hou.ValueError例外が引き起こされます。
reloadLayer(layer_path, recursive = False)
このメソッドは、指定したレイヤーパスに対してUSD Reloadメソッドをコールします。
さらに、Houdiniのリロードの内部データ構造更新します。
Houdiniでリロードを実行する時は、このメソッドをpxr.Sdf.Layer.Reloadまたは同様のメソッドの代わりに使用してください。
recursive パラメータをTrueに設定すると、Houdiniは、指定したレイヤーで参照されている他のレイヤーを再帰的に検索して、それらのレイヤーもリロードします。
shaderTranslatorID(node)
→ int
指定したノードのシェーダトランスレータのIDを返します。 このIDはHoudiniセッションに固有の値で、セッション間で変わります。
shaderRenderContextName(node, node_output_name)
→ str
指定したノードと出力のレンダーコンテキスト名を返します。 この名前は、USD Material Prim出力名で使用され、接続されたシェーダを指定したレンダラーに関連付けます。
node
返すレンダーコンテキスト名のシェーダノード。
node_output_name
レンダーコンテキスト名を返す出力名。 ノードは複数の出力を持つことができ、それぞれの出力が異なるレンダラーに対応しています。
translateShader(node, node_output_name, material_prim_path, container_prim_path)
→ str
新しいシェーダPrimを作成し、そのシェーダPrim出力のパスを返します。
node
USDシェーダPrimに変換するシェーダノード。
node_output_name
変換するシェーダを表現したノード出力(ノードがマテリアルの場合)、または、他のUSDシェーダPrimの入力として必要な出力値。
material_prim_path
USDシェーダを含んだマテリアルPrimのUSDパス。
container_prim_path
USDシェーダが直接編集される親Primのパス(例えば、NodeGraphまたはMaterial)。
availableRendererInfo()
→ list of dict
登録されているレンダラープラグインのメタデータを含んだ辞書のリストを返します。
availableRendererLabels()
→ tuple of str
登録されているレンダラープラグインの表示ラベルを含んだタプルを返します。
availableRendererNames()
→ tuple of str
登録されているレンダラープラグインの内部名を含んだタプルを返します。
outputProcessors()
→ tuple
of tuple
of str
レジストリ内の各出力プロセッサプラグインの内部名とユーザーから見えるラベルを含んだタプルを返します。
出力プロセッサに関する情報は、
USD ROPを参照してください。
outputProcessorParms(name)
→ hou.ParmTemplateGroup
nameパラメータに合致した内部名を持つ出力プロセッサを設定する際に使用可能なパラメータを返します。
出力プロセッサに関する情報は、USD ROPを参照してください。
usdVersionInfo()
→ dict
od str
to str
Houdiniに搭載されているUSDライブラリに関する情報を含んだ辞書を返します。
usdversion
文字列に変換されたUSDリリース番号。
USDリリース番号はYY.MMの形式になっています。
YYとMMは、リリースされたその年と月です。
packageurl
USDライブラリのビルド元のGitリポジトリのURL。
packagerevision
USDライブラリのビルドに使用された特定のブランチのGitコミットハッシュコード。
packageurlとpackagerevisionの値は、Houdiniに同梱されているUSDライブラリが独自のUSDビルドに置換されている場合には、空っぽの文字列を返します。