Multiverse

# Overrides

# CreateTransformOverride

def CreateTransformOverride(nodeName, primPath):
    """Adds a transform override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to add a transform override.
        primPath: A `str` representing the path of the USD primitive for which
            to add a transform override.

    Returns:
        A `str` containing the name of the created locator node driving the
        transform override.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# RemoveTransformOverride

def RemoveTransformOverride(nodeName, primPath):
    """Removes the transform override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove the transform override.
        primPath: A `str` representing the path of the USD primitive for which
            to remove the transform override.
    """
1
2
3
4
5
6
7
8
9

# HasTransformOverride

def HasTransformOverride(nodeName, primPath):
    """Checks if transform overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a transform override is set for the given primitive, 'False'
        otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# GetTransformOverride

def GetTransformOverride(nodeName, primPath):
    """Returns the name of the locator bound to the transform override, if any.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to return the transform override.
        primPath: A `str` representing the path of the USD primitive for which
            to return the transform override.

    Returns:
        The name of the locator node used to control the transform override for
        the given node and path. `None` if no transform override is assigned.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# AddMaterialOverride

def AddMaterialOverride(nodeName, primPath, source):
    """Adds a material override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to add a material override.
        primPath: A `str` representing the path of the USD primitive for which
            to add a material override.
        source: A `MaterialSourceBase` sub-class representing the material to
            be assigned to the primitive as override.
            If `source` is a string, its values will be interpreted as a
            `MaterialSourceShadingGroup` for back-compatibility.

    Raises:
        TypeError: If `source` is not a sub-class of `MaterialSourceBase`.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# AddNullMaterialOverride

def AddNullMaterialOverride(nodeName, primPath):
    """Adds an override that will remove any existing material assignment.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove existing material assignments.
        primPath: A `str` representing the path of the USD primitive for which
            to remove existing material assignments.
    """
1
2
3
4
5
6
7
8
9

# RemoveMaterialOverride

def RemoveMaterialOverride(nodeName, primPath):
    """Removes the material override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove the material override.
        primPath: A `str` representing the path of the USD primitive for which
            to remove the material override.
    """
1
2
3
4
5
6
7
8
9

# HasMaterialOverride

def HasMaterialOverride(nodeName, primPath):
    """Checks if material overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a material override is set for the given primitive, 'False'
        otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# GetMaterialOverride

def GetMaterialOverride(nodeName, primPath):
    """Returns the name of the shading group set as material override, if any.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to return the material override.
        primPath: A `str` representing the path of the USD primitive for which
            to return the material override.

    Returns:
        The name of the shading group node set as material override for the
        given node and path. `None` if no material override is assigned.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# SetViewportVisibility

def SetViewportVisibility(nodeName, primPath, mode):
    """Sets the viewport visibility for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to set viewport visibility.
        primPath: A `str` representing the path of the USD primitive for which
            to set viewport visibility.
        mode: A 'VisibilityMode' value representing the visibility state to be
            set.
    """
1
2
3
4
5
6
7
8
9
10
11

# SetRenderVisibility

def SetRenderVisibility(nodeName, primPath, mode):
    """Sets the render visibility for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to set render visibility.
        primPath: A `str` representing the path of the USD primitive for which
            to set render visibility.
        mode: A 'VisibilityMode' value representing the visibility state to be
            set.
    """
1
2
3
4
5
6
7
8
9
10
11

# ResetViewportVisibility

def ResetViewportVisibility(nodeName, primPath):
    """Resets the viewport visibility for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to reset the viewport visibility.
        primPath: A `str` representing the path of the USD primitive for which
            to reset the viewport visibility.
    """
1
2
3
4
5
6
7
8
9

# ResetRenderVisibility

def ResetRenderVisibility(nodeName, primPath):
    """Resets the render visibility for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to reset the render visibility.
        primPath: A `str` representing the path of the USD primitive for which
            to reset the render visibility.
    """
1
2
3
4
5
6
7
8
9

# HasViewportVisibilityOverride

def HasViewportVisibilityOverride(nodeName, primPath):
    """Checks if visibility overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a viewport visibility override is set for the given
        primitive, 'False' otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# HasRenderVisibilityOverride

def HasRenderVisibilityOverride(nodeName, primPath):
    """Checks if visibility overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a render visibility override is set for the given primitive,
        'False' otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# GetVariantSetsData

def GetVariantSetsData(nodeName, primPath):
    """Returns variant sets information for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to get variant sets information.
        primPath: A 'str' representing the path of the USD primitive for which
            to get variant sets information.

    Returns:
        A 'dict' where keys are 'str' representing the variant names and values
        are pairs of 'str', 'list' of 'str' where the first element represents
        the default value for the variant and the second element represents the
        list of available variant values.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# SetVariantSetsOverride

def SetVariantSetsOverride(nodeName, primPath, variantName, variantValue):
    """Sets a variant sets override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to add a variant set override.
        primPath: A `str` representing the path of the USD primitive for which
            to add a variant set override.
        variantName: A `str` representing the name of the variant set to
            assign.
        variantValue: A `str` representing the new value to be assigned to the
            variant set.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# ResetVariantOverride

def ResetVariantOverride(nodeName, primPath, variantName):
    """Resets overrides for the given primitive and variant set.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to reset a variant set.
        primPath: A `str` representing the path of the USD primitive for which
            to reset a variant set.
        variantName: A `str` representing the name of the variant set to
            reset.
    """
1
2
3
4
5
6
7
8
9
10
11

# ResetAllVariantsOverride

def ResetAllVariantsOverride(nodeName, primPath):
    """Resets all the variant set overrides for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to reset all the variant sets.
        primPath: A `str` representing the path of the USD primitive for which
            to reset all the variant sets.
    """
1
2
3
4
5
6
7
8
9

# HasVariantsOverride

def HasVariantsOverride(nodeName, primPath):
    """Checks if variants overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a variants set override is set for the given primitive,
        'False' otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# AddAttributeSetOverride

def AddAttributeSetOverride(nodeName, primPath, setNodeName):
    """Adds an attribute set override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to add a attribute set override.
        primPath: A `str` representing the path of the USD primitive for which
            to add a attribute set override.
        setNodeName: A `str` representing the name of the set  node to assign
            to the primitive.
    """
1
2
3
4
5
6
7
8
9
10
11

# RemoveAttributeSetOverride

def RemoveAttributeSetOverride(nodeName, primPath):
    """Removes the attribute set override for the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove the attribute set override.
        primPath: A `str` representing the path of the USD primitive for which
            to remove the attribute set override.
    """
1
2
3
4
5
6
7
8
9

# HasAttributeOverride

def HasAttributeOverride(nodeName, primPath):
    """Deprecated: use HasAttributeSetOverride(nodeName, primPath) instead."""
1
2

# HasAttributeSetOverride

def HasAttributeSetOverride(nodeName, primPath):
    """Checks if attribute overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if an attribute override is set for the given primitive, 'False'
        otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# GetAttributeSetOverride

def GetAttributeSetOverride(nodeName, primPath):
    """Returns the name of the mvSet node used as attribute override, if any.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to return the attribute set override.
        primPath: A `str` representing the path of the USD primitive for which
            to return the attribute set override.

    Returns:
        The name of the mvSet node used as attribute set override for the
        given node and path. `None` if no override is assigned.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# GetMaterialNamespaceOverride

def GetMaterialNamespaceOverride(nodeName, primPath, ignoreEnable=False):
    """Returns the name of the material namespace set as override, if any.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to return the material namespace override.
        primPath: A `str` representing the path of the USD primitive for which
            to return the material namespace override.
        ignoreEnable: A `bool` indicating if the value of the material
        namespace  should be returned even if the 'enable material namespace'
        flag is set to off.

    Returns:
        The material namespace set as override for the given node and path.
        `None` if no override is assigned or if the 'enable material namespace'
        flag is set to off and `ignoreEnable` is False.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# HasOverrides

def HasOverrides(nodeName, primPath):
    """Checks if any override is set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if at least an override type is set for the given primitive,
        'False' otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# RemovePrimitiveOverrides

def RemovePrimitiveOverrides(nodeName, primPath, flags=None):
    """Removes all the requested overrides set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove all the overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to remove all the overrides.
        flags: One or more 'OverrideFlags' representing the overrides to be
            removed. If 'flags' is 'None', all the overrides will be removed.
    """
1
2
3
4
5
6
7
8
9
10
11

# RemoveNodeOverrides

def RemoveNodeOverrides(nodeName, flags=None):
    """Removes all the requested overrides set on the given node.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to remove all the overrides.
        flags: One or more 'OverrideFlags' representing the overrides to be
            removed. If 'flags' is 'None', all the overrides will be removed.
    """
1
2
3
4
5
6
7
8
9

# GetPrimitivesWithOverrides

def GetPrimitivesWithOverrides(nodeName, flags=None):
    """Returns the paths of the primitives with overrides.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to return the paths with overrides.
        flags: One or more 'OverrideFlags' representing the overrides to be
            checked. If a primitive has any of the override types specified in
            'flags', its path will be added to the returned list. If 'flags' is
            'None', all the overrides will be checked.

    Returns:
        A 'list' of `str` containing the paths of the primitives for which
        overrides are present.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# SetInstanceable

def SetInstanceable(nodeName, primPath, mode):
    """Sets the Instanceable attribute on the node. If we are setting it to
    NOT_SET or TRUE, we clear ALL overrides of ALL child nodes!!

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to set the overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to set the overrides.
    """
1
2
3
4
5
6
7
8
9
10

# ResetInstanceable

def ResetInstanceable(nodeName, primPath):
    """Resets the Instanceable attribute on the node. This clears ALL 
    overrides of ALL child nodes!!

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to set the overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to set the overrides.
    """
1
2
3
4
5
6
7
8
9
10

# HasInstanceableOverride

def HasInstanceableOverride(nodeName, primPath):
    """Checks if Instanceable overrides are set on the given primitive.

    Args:
        nodeName: A `str` representing the name of the mvUsdCompoundShape node
            for which to check for overrides.
        primPath: A `str` representing the path of the USD primitive for which
            to check for overrides.

    Returns:
        'True' if a Instanceable override is set for the given primitive,
        'False' otherwise.
    """
1
2
3
4
5
6
7
8
9
10
11
12
13

# VisibilityMode

class VisibilityMode(object):
    """Primitives visibility modes.

    Valid constants:
        INHERITED
        HIDDEN
    """
1
2
3
4
5
6
7

# OverrideFlags

class OverrideFlags(object):
    """Flags to specify the affected overrides in override-related functions.

    Valid constants:
        VIEWPORT_VISIBILITY
        RENDER_VISIBILITY
        VISIBILITY # Same as RENDER_VISIBILITY
        TRANSFORM
        ATTRIBUTES
        MATERIAL
        VARIANTS
        ACTIVE_STATE
    """
1
2
3
4
5
6
7
8
9
10
11
12
13
Last Updated: 3/23/2022, 9:12:40 AM

← Importing →