OpenUSD Contribution Workflow Settings

Last updated 7 months ago

These settings are related to USD contribution workflow and they currently live outside of the USD addon.

It is considered to move all the USD bits into ayon-usd addon.

Settings Filter

You can set the settings filter to usd to quickly show usd settings within an addon.

Core Addon

Collect USD Layer Contributions

Setting Location: ayon+settings://core/publish/CollectUSDLayerContributions

Define available department layers and their strength ordering inside the USD contribution workflow. Also, It has Profiles to define instance attribute defaults for USD contribution in the publisher tool.

  • Department Layer Orders

    • Each item group

      • Name: Department layer name.

      • Order: Department layer order.

    • +: Add an item.

  • Profiles

    • Each profile item

      • Product types: The product types to match this profile to. When matched, the settings below would apply to the instance as default attributes.

      • Task types: The current create context task type to filter against. This allows to filter the profile to only be valid if currently creating from within that task type.

      • Contribution Enabled (default): The default state for USD Contribution being marked enabled or disabled for this profile.

      • Contribution Department Layer: The default contribution layer to apply the contribution to when matching this profile. The layer name should be in the 'Department Layer Orders' list to get a sensible order.

      • Apply as variant: The default contribution layer to apply the contribution to when matching this profile. The layer name should be in the 'Department Layer Orders' list to get a sensible order.

      • Target Product: The default destination product name to apply the contribution to when matching this profile. Usually e.g. 'usdAsset' or 'usdShot'.

    • +: Add a profile.


Default Department Layers and their expected usage:

  • Asset layers

    • model: 100

    • assembly: 150

    • groom: 175

    • look: 200

    • rig: 300

  • Shot layers

    • layout: 200

    • animation: 300

    • simulation: 400

    • fx: 500

    • lighting: 600

These values serve as typical configurations that suit common use cases. Keep in mind that we don't validate or enforce a layer to be used with a specific target product. For example, you can use animation and lighting as asset layers, even though they are typically used for building shots.

Additionally, if you want a layer that serves the same purpose for both building assets and shots, consider slightly changing the name. For example, you can create an animation layer for building assets by adding another department layer named assetAnim, while keeping the original layer named animation for building shots. This helps avoid any unexpected results due to layer order when mixing shots and assets in your scene.

Layer Order

Hover over the Order field for more details on the strength ordering:

  • Higher order means a higher strength and stacks the layer on top.

  • Opinions from a layer that is on top are stronger than those below it.

  • See the USD acronym LIVRPS for more details on USD's strength ordering.

Extract USD Asset Contribution

Setting Location: ayon+settings://core/publish/ExtractUSDAssetContribution

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

Extract USD Layer Contribution

Setting Location: ayon+settings://core/publish/ExtractUSDLayerContribution

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

Houdini Addon

Create USD Look

Settings Location: ayon+settings://houdini/create/CreateUSDLook

  • Default Products: List of default variants for each product.

Create USD

Settings Location: ayon+settings://houdini/create/CreateUSD

  • Default Products: List of default variants for each product.

Create USD render

Settings Location: ayon+settings://houdini/create/CreateUSDRender

  • Default Products: List of default variants for each product.

  • Default Renderer: Specify either the Hydra renderer plug-in nice name, like Karma CPU, or the plug-in name, e.g. BRAY_HdKarma.

Validate USD Look Assignments

Settings Location: ayon+settings://houdini/publish/ValidateUsdLookAssignments

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Validate USD Render Product Paths

Settings Location:ayon+settings://houdini/publish/ValidateUSDRenderProductPaths

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Validate USD Render Resolution

Settings Location:ayon+settings://houdini/publish/ValidateRenderResolution

Validate render resolution and pixel aspect of USD render products match the context resolution.

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Extract USD

Settings Location:ayon+settings://houdini/publish/ExtractUSD

  • Remap save layers to AYON Entity URI: Enable to use Entity's URI instead of file path.

LOP Load Asset

Settings Location: ayon+settings://houdini/load/LOPLoadAssetLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

LOP Load Shot

Settings Location: ayon+settings://houdini/load/LOPLoadShotLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

USD Sublayer Loader

Settings Location: ayon+settings://houdini/load/USDSublayerLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

USD Reference Loader

Settings Location: ayon+settings://houdini/load/USDReferenceLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

USD SOP Import Loader

Settings Location: ayon+settings://houdini/load/SopUsdImportLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

Maya Addon

Setting Explicit Plugins Loading at location ayon+settings://maya/explicit_plugins_loading has mayaUsdPlugin by default.

Create Multiverse USD

Settings Location: ayon+settings://maya/create/CreateMultiverseUsd

  • Default Products: List of default variants for each product.

Create Multiverse USD Composition

Settings Location: ayon+settings://maya/create/CreateMultiverseUsdComp

  • Default Products: List of default variants for each product.

Create Multiverse USD Override

Settings Location: ayon+settings://maya/create/CreateMultiverseUsdOver

  • Default Products: List of default variants for each product.

Maya USD Export Chaser: Filter Properties

Setting Location: ayon+settings://maya/publish/CollectMayaUsdFilterProperties

  • Default Filter: Set the default filter for USD properties to export. It uses SideFX Houdini Pattern Matching in Parameters.
    Some examples would include:

    • Only include xforms: xformOp*

    • Everything but xforms: * ^xformOp*

    • Everything but mesh point data: * ^extent ^points ^faceVertexCounts ^faceVertexIndices ^primvars*

Extract Maya USD Model

Settings Location: ayon+settings://maya/publish/ExtractMayaUsdModel

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Extract Maya USD Pointcache

Settings Location: ayon+settings://maya/publish/ExtractMayaUsdPointcache

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Extract Maya USD Animation

Settings Location: ayon+settings://maya/publish/ExtractMayaUsdAnim

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.

Maya Load USD to Maya Proxy Loader

Settings Location: ayon+settings://maya/load/MayaUsdLoader

  • Use AYON Entity URI: Enable to use Entity's URI instead of file path.

Multiverse USD Loader

Settings Location: ayon+settings://maya/load/MultiverseUsdLoader

  • Enable: The default state of the plugin.

Multiverse USD Override Loader

Settings Location: ayon+settings://maya/load/MultiverseUsdOverLoader

  • Enable: The default state of the plugin.

Blender Addon

Extract Model USD

Setting Location: ayon+settings://blender/publish/ExtractModelUSD

  • Enable: The default state of the plugin.

  • Optional: Allows the user to toggle this setting in the publisher UI.

  • Active: The default value of the toggle in the publisher UI.