Overview#

omni.usd.schema.omniscripting provides USD schema definitions for attaching and managing script files within USD prims. This extension defines the OmniScriptingAPI schema that enables USD prims to carry references to script files that will be evaluated when the prim is processed.

Key Components#

OmniScriptingAPI Schema#

The OmniScriptingAPI is a single-apply USD API schema that can be attached to any USD prim to associate script files with it. When applied, it adds an omni:scripting:scripts attribute that stores an array of asset paths pointing to script files. These script files are evaluated for each USD prim that has this API applied.

The schema enables developers to embed scripting capabilities directly into USD assets, allowing for dynamic behavior and customization at the prim level.

OmniScriptingSchemaTools Module#

The OmniScriptingSchemaTools module provides utility functions for managing the OmniScriptingAPI schema application:

applyOmniScriptingAPI: Applies the OmniScriptingAPI schema to a USD prim
removeOmniScriptingAPI: Removes the OmniScriptingAPI schema from a USD prim

These functions simplify the process of adding and removing scripting capabilities from USD prims programmatically.

Usage Examples#

import OmniScriptingSchemaTools

# Apply the OmniScriptingAPI to a prim
OmniScriptingSchemaTools.applyOmniScriptingAPI(prim)

# Remove the OmniScriptingAPI from a prim
OmniScriptingSchemaTools.removeOmniScriptingAPI(prim)

Relationships#

This extension depends on **omni.usd.libs** which provides the foundational USD libraries necessary for schema definition and registration. The extension loads early in the startup sequence to ensure the schema is available before other USD-dependent extensions attempt to use it.