Methods ¶
__init__()
Create a LopViewportLoadMasks object with default settings. This object describes various options for controlling which primitives and layers are composed together on the stage that is visible in the viewport. This object allows for the control of the stage population mask, the loading of payload primitives, and the muting of layers from disk. The default settings populate and load all primitives and layers.
populateAll()
→ bool
Returns True if the stage mask is configured to include the entire
scene graph. If True, the explicit list of paths has no meaning.
setPopulateAll(populate_all = True)
Configures the stage mask to include the entire scene graph. This clears
the current list of paths to populate because it is not needed. If
populate_all is set to False, and populateAll is currently set to
True, this method is equivalent to calling setPopulatePaths with an
empty path list. If populateAll is already False, calling this method
with a populate_all value of False will do nothing.
Calling any method which manipulates the list of paths to populate will
automatically set this flag back to False.
isPathPopulated(path, exact_match = True)
→ bool
Return True if the specified scene graph path is explicitly named in the
list of paths to populate. If exact_match is False, this method also
returns true if any ancestor of the supplied path is in the set of
paths to populate.
populatePaths()
→ tuple
of str
Return the list of all paths which should be populated on the stage. Descendants of explicitly named primitives will also populate on the stage.
setPopulatePaths(paths)
Set the list of paths which should be populated on the stage.
addPopulatePath(path)
Adds a single path to the list of paths to populate. If the path is already in the list of paths, this method does nothing.
removePopulatePath(path)
Removes a single path from the list of paths to populate . If the path is not in the list of paths, this method does nothing.
If remove_children is set to True, all children of the primitive at
path are also removed from the set of populated paths.
isLayerMuted(identifier)
→ bool
Return True if the specified layer identifier should be ignored when
composing the stage.
muteLayers()
→ tuple
of str
Return the list of all muted layer identifiers.
setMuteLayers(identifiers)
Set the list of layer identifiers that should be muted.
addMuteLayer(identifier)
Adds a single layer identifier to the list of muted layer identifiers. If the identifier is already being muted, this method does nothing.
removeMuteLayer(identifier)
Removes a single layer identifier from the list of muted layer identifiers. If the identifier is not being muted, this method does nothing.
loadAll()
→ bool
Return True if all payloads should be loaded by default.
setLoadAll(load_all = True)
Set the flag indicating that all payloads should be loaded by default. If
load_all is set to False, and loadAll is currently set to
True, this method is equivalent to calling setLoadPaths with an
empty path list. If loadAll is already False, calling this method
with a load_all value of False will do nothing.
Calling any method which manipulates the list of paths to be loaded will
automatically set this flag back to False.
isPathLoaded(path, exact_match = True)
→ bool
Return True if the specified scene graph path is explicitly named in the
list of paths to load. If exact_match is False, this method also
returns true if any ancestor of the supplied path is in the set of
paths to load.
isAnyChildPathLoaded(path)
→ bool
Return True if the specified scene graph path or any of its children
appear in the list of paths to load.
loadPaths()
→ tuple
of str
Return a list of all scene graph branches which will load their payloads in the viewport. Descendants of explicitly named primitives will also load their payloads.
setLoadPaths(paths)
Set the list of scene graph paths which should load their payloads in the viewport.
addLoadPath(path)
Adds a single path to the list of scene graph paths which will load their payloads inthe viewport. If the path is already in the list, this method does nothing.
removeLoadPath(path, remove_children = False)
Removes a single path from the list of scene graph paths which will load their payloads in the viewport. If the path is not in the list, this method does nothing.
If remove_children is set to True, all children of the primitive at
path are also removed from the set of loaded paths.
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.