Extension: omni.kit.browser.core-2.3.17

Documentation Generated: Sep 16, 2025

Overview

The omni.kit.browser.core extension provides a set of core APIs to support browser functionality within Omniverse Kit SDK. It defines a data model and UI components that manage hierarchical content through collections, categories, and details. The extension is focused on enabling developers to customize how browser items are retrieved, displayed, and interacted with through a series of abstract models, delegates, and widgets.

graph TD %% Inheritance relationships TreeCategoryDelegate --> CategoryDelegate TreeBrowserWidget --> BrowserWidget %% Model-Item relationships AbstractBrowserModel -.->|contains| CategoryItem AbstractBrowserModel -.->|contains| CollectionItem AbstractBrowserModel -.->|contains| DetailItem %% Delegate-Model relationships CategoryDelegate -.->|represents| AbstractBrowserModel DetailDelegate -.->|represents| AbstractBrowserModel %% Widget-Model relationships BrowserWidget -.->|uses| AbstractBrowserModel %% Delegate-Widget relationships CategoryDelegate -.->|renders| BrowserWidget DetailDelegate -.->|renders| BrowserWidget TreeCategoryDelegate -.->|renders| TreeBrowserWidget

Concepts

• The extension introduces an AbstractBrowserModel that requires implementations for obtaining collection, category, and detail items.

• It encapsulates browser items through models such as CategoryItem, CollectionItem, and DetailItem, ensuring consistent data handling and filtering.

• UI components like BrowserWidget, TreeBrowserWidget, and BrowserSearchBar centralize user interactions, while specialized delegates (CategoryDelegate, DetailDelegate, TreeCategoryDelegate) control the visual presentation.

Functionality

• Data Management: By implementing the abstract methods of AbstractBrowserModel, users can define how collections, categories, and details are loaded and cached.

• User Interface: The provided widgets combine lists, tree views, and search bars into a cohesive browsing experience for navigating hierarchical data.

• Interactivity: The OptionsMenu and its associated OptionMenuDescription allow customization of actions within the browser UI, while the create_drop_helper utility function facilitates the integration of drag and drop functionality, optionally leveraging viewport interfaces when available.

Key Components

• Data Models:

  • AbstractBrowserModel

  • CategoryItem, CollectionItem, DetailItem

• UI Widgets:

  • BrowserSearchBar, BrowserWidget, TreeBrowserWidget

• Delegates:

  • CategoryDelegate, DetailDelegate, TreeCategoryDelegate

• Options Menu:

  • OptionsMenu, OptionMenuDescription

• Utility:

  • create_drop_helper (supports drag and drop by optionally integrating with viewport window functionalities)

By providing these well-defined APIs and interfaces, omni.kit.browser.core lays the foundation for building and customizing browser-based views within the Omniverse Kit SDK.