メソッド ¶
__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)
Sets the map of variant selection fallbacks described by this load masks
object. The fallbacks parameter should be a dictionary that maps strings
to tuples or lists of strings, this is the same data format returned by the
variantSelectionFallbacks or pxr.Usd.Stage.GetGlobalVariantFallbacks
method.
variantSelectionFallbacks()
→ dict
of str
to tuple
or str
Return the variant selection fallbacks which is a dictionary mapping
variant set names to a list of variant selection strings that are used
for primitives with the specified variant set but no explicit selection
made on that variant set. This is the same format expected by the
pxr.Usd.Stage.GetGlobalVariantFallbacks method.
dumps()
→ str
Outputs a complete description of this object as a string in JSON format.
This string can then be reloaded using the loads method. This method
can be used to serialize this object to a file.
loads(masks_str)
Populates this object from the JSON string in the masks_str parameter,
as output by the dumps method. This method can be used to load this
object from a file on disk.