Extension: omni.kit.property.usd-3.21.28 |
Documentation Generated: Jul 17, 2024 |
Overview
This extension provides a set of classes and functions to facilitate the creation and management of USD property widgets within Omniverse Kit. It offers tools for editing USD properties, managing selections of USD primitives, and integrating custom UI elements for property editing. The extension includes classes for representing USD property types as UI items, handling control states based on USD model attributes, and creating context menus for USD attributes. Additionally, it contains utilities for managing large selections and a placeholder attribute class for USD attributes that cannot be independently created.
Important API List
ADDITIONAL_CHANGED_PATH_EVENT_TYPE: An event type identifier for additional changed path events.
AttributeContextMenu: Manages context menus for USD attribute editing.
ControlStateManager: Manages UI control states based on USD model attributes.
ContextMenu: Creates and handles a context menu in a UI.
Examples: Provides examples of how to use USD PropertyWindow APIs.
PrimSelectionPayload: Represents a selection payload of USD primitives.
PrimPathWidget: Displays and interacts with USD prim path properties.
SelectionNotifier: Notifies about selection changes within a USD context.
Styles: Defines visual styles for a user interface.
UsdPropertyWidgets: Encapsulates a set of widgets for editing USD properties.
UsdBase: A base class for USD models, providing functionality to work with USD stages and properties.
FloatModel: Represents a floating-point value model with editing capabilities.
GfVecAttributeModel: Represents and manipulates vector attributes in USD.
SdfAssetPathAttributeModel: Handles Sdf.AssetPath attribute types in USD.
SdfAssetPathArrayAttributeItemModel: Manages a collection of SdfAssetPath elements.
TfTokenAttributeModel: Manages USD attributes represented as tokens.
UsdAttributeModel: Watches a USD attribute path and provides interaction methods.
General Use Case
Users can use this extension to enhance their interaction with USD properties within Omniverse Kit. They can create and manage property widgets, handle selections of USD primitives, and build custom UI elements for property editing. The extension is useful for creating context menus for attribute editing, controlling UI states based on USD attributes, and managing large selections efficiently. It also aids in representing USD property types as UI items and provides a placeholder for attributes that cannot exist independently. For examples of how to use the APIs, please consult the Python usage pages.