メソッド ¶
__init__()
デフォルト設定のLopViewportLoadMasksオブジェクトを作成します。 このオブジェクトは、ビューポート内に表示されるステージ上で構成したいプリミティブとレイヤーを制御するための色々なオプションが入っています。 このオブジェクトは、ステージポピュレーションマスク、ペイロードプリミティブの読み込み、ディスクのレイヤーのミュートを制御することができます。 デフォルトの設定では、すべてのプリミティブとレイヤーをPopulate(収集)して読み込みます。
populateAll()
→ bool
ステージマスクがシーングラフ全体を含むように設定されていればTrueを返します。
Trueの場合、明示的なパスのリストは何も意味しません。
setPopulateAll(populate_all = True)
ステージマスクがシーングラフ全体を含むように設定します。
現在の収集用パスリストは不要になるため、これはそのリストをクリアします。
populate_allをFalseに設定し、populateAllが現在Trueに設定されていた場合、
このメソッドは、空っぽのパスリストを使ってsetPopulatePathsをコールすることと同じです。
populateAllが既にFalseに設定されていた場合、populate_allをFalseに設定してこのメソッドをコールしても何も処理されません。
収集用パスリストを制御する何かしらのメソッドをコールすると、このフラグが自動的にFalseに戻されます。
isPathPopulated(path, exact_match = True)
→ bool
指定したシーングラフのパスが、収集用パスリストに明示的に指定されていれば、Trueを返します。
exact_matchがFalseの場合、このメソッドは、指定したパスの親が収集用パスリストに入っていてもTrueを返します。
populatePaths()
→ tuple
of str
ステージ上に収集されるすべてのパスのリストを返します。 明示的に指定された名前のプリミティブの子もステージ上に収集されます。
setPopulatePaths(paths)
ステージ上に収集したいパスのリストを設定します。
addPopulatePath(path)
ここで指定した単一パスを収集用パスリストに追加します。 このパスが既にパスリストに入っている場合は、このメソッドは何もしません。
removePopulatePath(path)
ここで指定した単一パスを収集用パスリストから除外します。 このパスがそのパスリストに入っていない場合は、このメソッドは何もしません。
remove_childrenをTrueに設定すると、pathにあるプリミティブのすべての子も収集用パスリストから除外されます。
isLayerMuted(identifier)
→ bool
指定したレイヤーIDがステージの構成で無視されている場合はTrueを返します。
muteLayers()
→ tuple
of str
ミュートされているすべてのレイヤーIDのリストを返します。
setMuteLayers(identifiers)
ミュートしたいレイヤーIDのリストを設定します。
addMuteLayer(identifier)
ここで指定した単一レイヤーIDをミュートレイヤーIDのリストに追加します。 このIDが既にミュートされている場合は、このメソッドは何もしません。
removeMuteLayer(identifier)
ここで指定した単一レイヤーIDをミュートレイヤーIDのリストから除外します。 このIDがミュートされていない場合は、このメソッドは何もしません。
loadAll()
→ bool
デフォルトですべてのペイロードが読み込まれている場合はTrueを返します。
setLoadAll(load_all = True)
デフォルトですべてのペイロードが読み込まれるようにフラグを設定します。
load_allをFalseに設定し、loadAllが現在Trueに設定されていた場合、
このメソッドは、空っぽのパスリストを使ってsetLoadPathsをコールすることと同じです。
loadAllが既にFalseに設定されていた場合、load_allをFalseに設定してこのメソッドをコールしても何も処理されません。
読み込むパスのリストを制御する何かしらのメソッドをコールすると、このフラグが自動的にFalseに戻されます。
isPathLoaded(path, exact_match = True)
→ bool
指定したシーングラフパスが読み込みパスのリストで明示的に指定されている場合はTrueを返します。
exact_matchがFalseの場合、このメソッドは、指定したパスの親が読み込みパスのセットに入っていてもTrueを返します。
isAnyChildPathLoaded(path)
→ bool
指定したシーングラフパスまたはその子のどれかが読み込みパスのリスト内にある場合はTrueを返します。
loadPaths()
→ tuple
of str
ペイロードをビューポートに読み込むシーングラフブランチすべてのリストを返します。 明示的に指定された名前のプリミティブの子もペイロードを読み込みます。
setLoadPaths(paths)
ペイロードをビューポートに読み込むシーングラフパスのリストを設定します。
addLoadPath(path)
ここで指定した単一パスを、ペイロードをビューポートに読み込むシーングラフパスのリストに追加します。 このパスが既にそのリストにある場合は、このメソッドは何もしません。
removeLoadPath(path, remove_children = False)
ここで指定した単一パスを、ペイロードをビューポートに読み込むシーングラフパスのリストから除外します。 このパスがそのリストにない場合は、このメソッドは何もしません。
remove_childrenをTrueに設定すると、pathにあるプリミティブのすべての子も読み込みパスリストから除外されます。
setVariantSelectionFallbacks(fallbacks)
このロードマスクオブジェクトで表現されたバリアント選択フォールバックのマップを設定します。
このfallbacksパラメータには、文字列を文字列のタプルやリストにマップした辞書を指定してください。
これは、variantSelectionFallbacksメソッドまたはpxr.Usd.Stage.GetGlobalVariantFallbacksが返すのと同じデータフォーマットです。
variantSelectionFallbacks()
→ dict
of str
to tuple
or str
バリアント選択フォールバックを返します。
これは、バリアントセット名を、その指定したバリアントセットを持っているものの、そのバリアントセットに明示的な選択がされていないプリミティブで使用されるバリアント選択文字列のリストにマップした辞書です。
これは、pxr.Usd.Stage.GetGlobalVariantFallbacksメソッドで必要とされるのと同じフォーマットです。
dumps()
→ str
このオブジェクトの完全な表現をJSON形式の文字列として出力します。
この文字列は、loadsメソッドを使用してリロードすることができます。
このメソッドを使用することで、このオブジェクトをファイルにシリアライズすることができます。
loads(masks_str)
masks_strパラメータで指定されたJSON文字列(dumpsメソッドから出力された文字列)からこのオブジェクトを収集します。
このメソッドを使用することで、ディスク上のファイルからこのオブジェクトをロードすることができます。