Overview#

This extension provides a comprehensive set of utilities for manipulating primitives in 3D space, offering capabilities such as translation, rotation, and scaling. It includes support for both global and local transformations and integrates snapping features for precise positioning. The extension also includes tools for setting the pivot point based on various criteria, such as the center of selection or bounding box. In addition to manipulating individual primitives, it can handle multiple selections with options to maintain or ignore spacing between objects during transformations. The extension accommodates both viewport and legacy modes, and it features a toolbar for easy access to manipulator settings and functions.

Important API List#

The module consists of the following main components:

PrimDataAccessorRegistry : Manages the registration of data accessor functions for primitives.
TransformManipulatorRegistry : Handles the lifecycle of transform manipulator instances in a scene.
PrimTransformManipulator : Provides a manipulator for interactive transformation of USD prims.
PrimTransformModel : Represents a model for transforming USD prims in a viewport.
get_toolbar_registry : Retrieves the singleton instance of the toolbar registry for manipulator tools.

General Use Case#

The extension is used for transforming USD primitives within a 3D application, allowing users to translate, rotate, and scale objects with precision. It also provides tools for setting and manipulating the pivot point for transformations. Users can access these functionalities through a dedicated toolbar, enhancing the efficiency of 3D scene editing and manipulation workflows. For examples of how to use the APIs, please consult the Python usage pages.

User Guide#

Events#

Data accessor registry operations generate global events that can be observed through the carb.eventdispatcher system for tracking data accessor additions and removals.

Data Accessor Added#

Event: omni.kit.manipulator.prim.core:data_accessor_added
Python constant: omni.kit.manipulator.prim.core.DataRegistryGlobalEvent.DATA_ACCESSOR_ADDED

Dispatched when a new data accessor function is registered to the prim data accessor registry.

Parameters:

data_tag (string) - The identifier tag for the data accessor that was added

Data Accessor Removed#

Event: omni.kit.manipulator.prim.core:data_accessor_removed
Python constant: omni.kit.manipulator.prim.core.DataRegistryGlobalEvent.DATA_ACCESSOR_REMOVED

Dispatched when a data accessor function is unregistered from the prim data accessor registry.

Parameters:

data_tag (string) - The identifier tag for the data accessor that was removed