Extension: omni.kit.property.usd-4.2.11 |
Documentation Generated: Nov 07, 2024 |
Overview
The omni.kit.property.usd extension provides a comprehensive set of classes and functions for working with USD properties within Omniverse Kit applications. It includes models for various USD attribute types, widgets for property manipulation, and utilities for managing selection and control states.
Important API List
AllowedTokenItem: Represents an allowed token item in UI selection.
ControlStateManager: Manages control states for USD attributes and properties.
FloatModel: A simple floating-point value model for UI components.
GfMatrixAttributeModel: Handles matrix attributes of various sizes in USD.
GfQuatAttributeModel: Manages quaternion attributes in a USD stage.
GfQuatEulerAttributeModel: Facilitates conversion between quaternion and Euler rotation attributes.
GfVecAttributeModel: Represents and manipulates GfVec typed attributes in USD.
GfVecAttributeSingleChannelModel: Handles single channel vector attributes in USD.
IntModel: A simple integer value model for UI components.
MdlEnumAttributeModel: Represents an enumeration attribute in USD.
OptionItem: Represents an option item for UI selection.
PlaceholderAttribute: Creates a placeholder attribute in USD.
PrimPathWidget: A widget for interacting with USD Prim paths.
PrimSelectionPayload: Encapsulates the selection payload for USD stage’s prim paths.
SdfAssetPathArrayAttributeItemModel: Manages a collection of asset paths as attribute items.
SdfAssetPathArrayAttributeSingleEntryModel: Represents a single entry in an array of SdfAssetPath attributes.
SdfAssetPathAttributeModel: Monitors SDF asset path attributes in USD.
SdfAssetPathItem: Represents a single entry within the SdfAssetPath model.
SdfTimeCodeModel: Handles SDF timecodes in USD attributes.
TfTokenAttributeModel: Manages USD attributes of type ‘TfToken’.
UsdAttributeInvertedModel: Inverts the boolean value from a USD attribute.
UsdAttributeModel: Observes and manipulates USD attribute values.
UsdBase: Base class for USD attributes and properties management.
UsdFloatItem: Represents a USD float item for UI elements.
UsdMatrixItem: Represents a USD matrix item in the UI.
UsdPropertyWidgets: Provides USD property widgets in Omniverse Kit.
UsdQuatItem: Represents a quaternion item in USD.
UsdVectorItem: Handles vector items in USD.
get_large_selection_count: Fetches the count of large selections from settings.
General Use Case
This extension is used to create, manage, and interact with USD property widgets within Omniverse Kit applications. It allows developers to integrate USD property manipulation into their custom UIs, handle attribute changes, manage selections and control states, and work with a variety of USD data types through specialized models and widgets. Users can leverage these tools to build more interactive and feature-rich applications for USD data inspection and editing. For examples of how to use the APIs, please consult the Python usage pages.