Overview#

The omni.kit.property.adapter.core extension provides the foundational framework for creating property adapters that enable custom handling of USD stage data. It establishes a standardized adapter pattern for accessing and manipulating USD prims, attributes, and stages through a unified interface, while maintaining compatibility with different data sources and formats.

Concepts#

The extension is built around three core adapter types that wrap USD objects to provide consistent interfaces:

AttributeAdapter: Wraps USD attributes and relationships, providing a unified way to access property data regardless of the underlying property type
PrimAdapter: Wraps USD prims to enable custom prim handling and data access patterns
StageAdapter: Wraps USD stages to support different stage implementations and data formats while maintaining a common interface

Each adapter type serves as an abstraction layer that allows Kit property systems to work with USD data without being tightly coupled to specific USD implementations.

Key Components#

PropertyType #

The PropertyType enumeration distinguishes between ATTRIBUTE and RELATIONSHIP property types, enabling the adapter system to handle different kinds of USD properties appropriately.

Stage Adapter Registry#

The SceneDescriptionAdapterRegistry serves as the central registration system for stage adapters. It manages the lifecycle of registered adapters and provides event notifications when adapters are added or removed. The registry maintains a dictionary of adapter factory functions keyed by name, allowing multiple stage adapter implementations to coexist.

Extensibility#

The registry system allows multiple adapters to be active simultaneously, with each adapter having configurable read and write priorities to determine precedence when multiple adapters can handle the same data.