Extension: omni.kit.window.toolbar-3.0.2 |
Documentation Generated: Nov 13, 2025 |
Overview#
The omni.kit.window.toolbar extension creates the main toolbar window for Omniverse Kit applications. This extension provides a dockable window that hosts various toolbar widgets and manages context-aware toolbar configurations for different application modes.
UI Components#
Main Toolbar Window#
The extension creates a dockable toolbar window that serves as the primary interface for accessing common tools and controls. The toolbar window can be positioned anywhere within the application interface and maintains its state across sessions.
Widget Management System#
The toolbar operates as both a registry and UI container for widget groups. Extensions can register their own widget groups with the toolbar, which are then organized and displayed based on priority and context settings.
Context System#
The toolbar supports context-aware configurations that allow different sets of tools to be displayed based on the current application mode or workflow. This enables specialized toolbars for different tasks while maintaining a clean interface.
Functionality#
Widget Registration: Extensions can add and remove widget groups dynamically using the add_widget() and remove_widget() methods. Each widget group can be assigned a priority value that determines its position within the toolbar layout.
Context Management: The toolbar provides context acquisition and release mechanisms through acquire_toolbar_context() and release_toolbar_context(). This allows extensions to temporarily take control of the toolbar configuration for specialized workflows.
Custom Selection Types: The extension supports custom selection type entries that can be added and removed dynamically, enabling specialized selection modes for different tools and workflows.
Usage Examples#
The toolbar window becomes available once the extension is enabled and can be accessed through the Window menu. Widget groups from other extensions will automatically appear in the toolbar based on their registration priority and current context.
Integration#
The extension builds upon omni.kit.widget.toolbar to provide the core toolbar functionality within a dockable window interface. It uses omni.kit.menu.utils for menu integration, allowing the toolbar window to be accessed through the application’s menu system.