[isaacsim.examples.browser] Isaac Sim Example Browser#
Version: 0.3.1
Overview#
The isaacsim.examples.browser extension provides a browser interface for discovering and navigating Isaac Sim robotics examples. It creates a window-based browser that organizes examples by category using a tree-structured interface, allowing users to explore different types of robotics examples available in Isaac Sim through both menu shortcuts and programmatic access.
Functionality#
Example Organization: The browser organizes examples hierarchically by category using the ExampleBrowserModel, which maintains a tree structure where categories can contain subcategories and individual examples. Each example is represented by an Example object that contains metadata including display name, execution logic, UI customization hooks, category path, and thumbnail images.
Window Interface: The ExampleBrowserWindow provides the main user interface, built on top of the tree folder browser widget. Users can navigate through categories to discover examples, with each example displaying its name and thumbnail for visual identification.
Dynamic Registration: Examples can be registered and deregistered at runtime through the extension’s public API methods. The register_example method accepts parameters like name, execute_entrypoint, ui_hook, category, and thumbnail, while deregister_example removes examples by name and category.
Key Components#
ExampleBrowserModel#
The ExampleBrowserModel extends TreeFolderBrowserModel to manage the data structure for Isaac Sim examples. It maintains categories as ExampleCategoryItem objects and examples as ExampleDetailItem objects, providing methods to retrieve category items and detail items for the browser display.
ExampleBrowserWindow#
The ExampleBrowserWindow uses a specialized BrowserWidget that extends TreeFolderBrowserWidgetEx. This widget is customized for displaying robotics examples with consistent thumbnail display settings and visible labels across different thumbnail sizes.
Integration#
The extension integrates with Omniverse Kit’s menu system through omni.kit.menu.utils, registering menu items under “Window > Examples > Robotics Examples” that allow users to toggle the browser window visibility. The browser window can be shown or hidden based on user settings, with the visibility state configurable through the extension’s settings.
Enable Extension#
The extension can be enabled (if not already) in one of the following ways:
Define the next entry as an application argument from a terminal.
APP_SCRIPT.(sh|bat) --enable isaacsim.examples.browser
Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.
[dependencies]
"isaacsim.examples.browser" = {}
Open the Window > Extensions menu in a running application instance and search for isaacsim.examples.browser.
Then, toggle the enable control button if it is not already active.
Actions in isaacsim.examples.browser#
ID |
Display Name |
Description |
|---|---|---|
open_isaac_sim_examples_browser |
Open Isaac Sim Examples Browser |
|
toggle_isaac_sim_examples_browser |
Toggle Isaac Sim Examples Browser |