Overview#

The omni.kit.widget.versioning extension offers a set of UI components and helpers for displaying and managing branch and checkpoint information in Omniverse Kit SDK. It provides a cohesive way to list, filter, and restore checkpoints for files while supporting different visual layouts and interactive controls.

Concepts#

The extension introduces a model-view approach where a CheckpointModel manages checkpoint data and a CheckpointWidget provides a visual interface to display that data.
Individual checkpoint entries are represented by CheckpointItem objects, which include utility methods such as converting file sizes and formatting dates.
CheckpointCombobox offers a compact dropdown interface for selecting checkpoints, while CheckpointHelper centralizes URL processing and checkpoint status verification.

Functionality#

The CheckpointModel retrieves checkpoint data asynchronously, supports search filtering, and manages selection modes for single or multiple checkpoints.
The CheckpointWidget integrates the model with various layout options and event callbacks (mouse pressed, double-click, and context menus) to drive user interaction.
Helper functions in CheckpointHelper simplify server URL extraction and enable efficient caching for checkpoint status queries.

Dependencies#

This extension relies on omni.ui and omni.client for UI elements and client-side operations, as well as omni.kit.widget.context_menu for context menu support.

Considerations#

The extension is designed specifically for versioning tasks and checkpoint management; its functionality is tailored to handling file checkpoints, so integration with your asset management workflow is key.
As checkpoint listings and restoration involve asynchronous operations, ensure that your application handles these updates appropriately to maintain a responsive UI.