Extension: omni.kit.property.transform-1.5.10 |
Documentation Generated: Dec 17, 2024 |
Overview#
The omni.kit.property.transform module provides a comprehensive suite of functionalities for manipulating USD transform operations (xformOps) within the Omniverse Kit. It enables users to add, enable, disable, change, and remove various xformOps such as translate, rotate, scale, and pivot on USD primitives. Additionally, it offers specialized UI widgets for interactively editing these transform attributes and a selection of utility functions to support transform operations.
Important API List#
EnableXformOpCommand: Adds an attribute’s corresponding XformOp to the xformOpOrder array.
ChangeRotationOpCommand: Changes the rotation XformOp in a USD stage.
RemoveXformOpCommand: Removes an XformOp from the xformOpOrder attribute without deleting the attribute itself.
RemoveXformOpAndAttrbuteCommand: Removes an XformOp and its attribute from the xformOpOrder array.
AddXformOpCommand: Adds various transformation operations to a USD prim’s xformOpOrder.
General Use Case#
This module is used for managing transform operations on USD primitives within Omniverse applications. It enables developers and artists to programmatically manipulate the transformation of USD primitives, offering control over translate, rotate, scale, and pivot operations. Through its API, it provides the flexibility to modify xformOps directly or via custom UI components, making it easier to create, adjust, or reset transformations as part of a scene setup or editing process. For examples of how to use the APIs, please consult the Python usage pages.