Debugging composition with LIVERPS: Quick Reference — Composition (NVIDIA-Certified Professional: OpenUSD Development)

Debugging Composition with LIVERPS: Quick Reference

LIVERPS is an essential tool for debugging composition in OpenUSD pipelines, enabling developers to inspect and analyze the layered structure of USD files and their composition arcs effectively.

Key Concepts

• Composition Arcs: Mechanisms by which USD layers combine to form a composed scene graph.
• LAYER: A single USD file that can be composed with others.
• PRIM: The fundamental scene graph node in USD.
• REFERENCE, OVERRIDE, SUBLAYERS, SPECIALIZE: Types of composition arcs affecting how layers and prims combine.

LIVERPS Overview

• Purpose: Visualize and debug the composition stack for a given prim or attribute.
• Functionality: Displays the layers involved, their order, and how opinions from each layer contribute to the final composed scene.
• Use Case: Identify conflicts, overrides, or missing data in complex composition scenarios.

Using LIVERPS for Debugging

1. Load the USD Stage: Open the USD stage in a tool supporting LIVERPS (e.g., usdview).
2. Select the Prim: Choose the prim whose composition you want to inspect.
3. Invoke LIVERPS: Use the LIVERPS command or interface to generate a composition report.
4. Analyze the Output: Review the list of layers and arcs contributing to the prim’s final state.
5. Identify Issues: Look for unexpected overrides, missing references, or incorrect sublayers.

Common LIVERPS Output Elements

• Layer Stack: Ordered list of layers from strongest to weakest opinions.
• Composition Arc Types: Indications of how layers are connected (e.g., references, inherits).
• Opinion Sources: Which layer provides the final value for each attribute.
• Errors and Warnings: Notes on invalid or conflicting arcs.

Best Practices

• Use LIVERPS early in debugging to understand the composition structure.
• Correlate LIVERPS output with scene behavior to pinpoint issues.
• Combine with other USD tools for a comprehensive debugging workflow.
• Document composition arc usage to simplify future maintenance.

Worked Example

Scenario: A prim’s color attribute is not appearing as expected.

Steps:

1. Run LIVERPS on the prim to see the composition stack.
2. Observe that a reference arc overrides the color attribute from a sublayer.
3. Identify that the referenced layer has an outdated color value.
4. Update the referenced layer or adjust composition arcs accordingly.

Result: The prim’s color attribute now reflects the intended value after correcting the composition.

More in this topic

Composition — NVIDIA-Certified Professional: OpenUSD DevelopmentDebugging composition with LIVERPS: Common Mistakes — Composition (NVIDIA-Certified Professional: OpenUSD Development)Authoring and designing with composition arcs: Practice Questions — Composition (NVIDIA-Certified Professional: OpenUSD Development)Authoring and designing with composition arcs: Quick Reference — Composition (NVIDIA-Certified Professional: OpenUSD Development)Debugging composition with LIVERPS — Composition (NVIDIA-Certified Professional: OpenUSD Development)Selecting appropriate composition arc types: Worked Example — Composition (NVIDIA-Certified Professional: OpenUSD Development)Debugging composition with LIVERPS: Worked Example — Composition (NVIDIA-Certified Professional: OpenUSD Development)Selecting appropriate composition arc types: Practice Questions — Composition (NVIDIA-Certified Professional: OpenUSD Development)Selecting appropriate composition arc types: Common Mistakes — Composition (NVIDIA-Certified Professional: OpenUSD Development)Selecting appropriate composition arc types — Composition (NVIDIA-Certified Professional: OpenUSD Development)Selecting appropriate composition arc types: Quick Reference — Composition (NVIDIA-Certified Professional: OpenUSD Development)Authoring and designing with composition arcs — Composition (NVIDIA-Certified Professional: OpenUSD Development)Authoring and designing with composition arcs: Worked Example — Composition (NVIDIA-Certified Professional: OpenUSD Development)Debugging composition with LIVERPS: Practice Questions — Composition (NVIDIA-Certified Professional: OpenUSD Development)Authoring and designing with composition arcs: Common Mistakes — Composition (NVIDIA-Certified Professional: OpenUSD Development)