Overview#

omni.kit.quicklayout provides convenient methods for managing workspace layouts within Omniverse Kit SDK. This extension enables you to save, load, and compare layout configurations using file-based operations, as well as quick actions that bypass dialog prompts. It is designed to help users maintain or restore customized workspace states efficiently.

Concepts#

The extension organizes layout control through the QuickLayout namespace. It encapsulates operations for persisting the workspace layout to a file and reloading it later, along with comparing the current layout against a stored version using a delegate. Quick actions allow for layout changes without the overhead of confirmation dialogs.

Functionality#

Save to a workspace file using methods that handle the layout state.
Load a layout from a file with an option to keep current windows open.
Compare an external workspace layout file with the current layout through a provided comparison delegate.
Offer quick save and quick load operations to streamline user interaction via menu-based actions.

Relationships#

omni.kit.quicklayout works alongside other extensions like omni.kit.mainwindow, omni.ui, and omni.kit.menu.utils. Its integration with optional components such as omni.kit.window.filepicker and omni.kit.actions.core ensures that file dialogs and action triggers align with the overall workspace and UI functionality.