Universal Scene Description (OpenUSD) Code Samples

This is an index of code samples or snippets for Universal Scene Description (OpenUSD). The code samples are indexed by topics and each code sample is titled by the task that it is used for. Where applicable, we include code samples using Kit OpenUSD wrappers for developing within Omniverse apart from the original USD API. New USD developers will find this useful for finding the appropriate API used to accomplish a task and using the OpenUSD Python API reference or OpenUSD C++ API reference to learn more about the API. Experienced developers can use this index for quick code lookups.

Want to contribute to the USD Code Samples?

All the code samples are open-source with a permissive license. You can contribute new code samples for new tasks or improve existing code samples. Visit the OpenUSD Code Samples GitHub Repository to learn more and contribute.

Contribute

Cameras

• Create an Orthographic Camera
• Create a Perspective Camera

Data Types

• Convert Between VtArray and Numpy Array

Hierarchy & Traversal

• Find a Prim by Name
• Find All the Prims of a Given Type
• Get the Child of a Prim

Inherits

• Add an Inherit

Layers

• Add a SubLayer

Materials

• Create an MDL Material
• Create a UsdPreviewSurface Material

Paths

• Concatenate a Prim Path
• Concatenate a Property Name with a Prim Path
• Get the Parent Path for a Prim Path

Prims

• Check if a Prim Exists
• Get the Currently Selected Prims
• Get a Prim
• Select a Prim by Prim Path

Properties

• Add a Relationship Target
• Check if a Property Exists
• Create an Attribute
• Create a Relationship
• Get the Value of an Attribute
• Get the Targets of a Relationship
• Set the Value of an Attribute

References & Payloads

• Add a Payload
• Add a Reference
• Create a Payload
• Create a Reference

Specializes

• Add a Specialize

Stage

• Get the Current Stage
• Set the Default Prim on a Stage
• Set the Stage Linear Units
• Set the Stage Up Axis

Transforms

• Compute the Bounding Box for a Prim
• Get the Local Space Transforms for a Prim
• Get the World Space Transforms for a Prim

Variant Sets

• Author Data for a Particular Variant
• Create a Variant Set
• Select a Variant for a Variant Set

Visibility

• Show or Hide a Prim