ExtsWindowExtension

class omni.kit.window.extensions.extension.ExtsWindowExtension

Bases: IExt, MenuHelperExtension

The entry point for the exts 2.0 window.

This extension integrates into the omni.ext.IExt interface and provides a user interface for managing and interacting with extensions in the application. It features a window that lists available extensions and allows users to control their activation state, view detailed information, and manage extension-specific settings. Additionally, it offers a menu integration that allows easy access to the extensions window from the application’s main menu.

Methods

add_searchable_keyword(keyword, description, ...)

Adds a new searchable keyword to the extensions list widget.

add_tab_to_info_widget(tab)

Adds a new tab to the extension information widget.

on_shutdown()

Performs cleanup operations when the extension is shutting down.

on_startup(ext_id)

Initializes the extension with the given extension ID.

refresh_extension_info_widget()

Refreshes the contents of the extension information widget.

refresh_search_items()

Refreshes the list of search items in the extension list widget.

remove_searchable_keyword(keyword_to_remove)

Removes a searchable keyword from the extensions list widget.

remove_tab_from_info_widget(tab)

Removes a tab from the extension information widget.

show_window(value)

Controls the visibility of the window based on the given value.

__init__(self: omni.ext._extensions.IExt) None
classmethod add_searchable_keyword(keyword: str, description: str, filter_on_keyword: Callable, clear_cache: Callable)

Adds a new searchable keyword to the extensions list widget.

Parameters
  • keyword (str) – The keyword to be added.

  • description (str) – A brief description of the keyword.

  • filter_on_keyword (Callable) – The callback for filtering based on the keyword.

  • clear_cache (Callable) – The callback to clear the cache when needed.

classmethod add_tab_to_info_widget(tab: PageBase)

Adds a new tab to the extension information widget.

Parameters

tab (ext_info_widget.PageBase) – The tab to add to the info widget.

on_shutdown()

Performs cleanup operations when the extension is shutting down.

on_startup(ext_id)

Initializes the extension with the given extension ID.

Parameters

ext_id (str) – The extension ID being initialized.

classmethod refresh_extension_info_widget()

Refreshes the contents of the extension information widget.

classmethod refresh_search_items()

Refreshes the list of search items in the extension list widget.

classmethod remove_searchable_keyword(keyword_to_remove: str)

Removes a searchable keyword from the extensions list widget.

Parameters

keyword_to_remove (str) – The keyword to be removed.

classmethod remove_tab_from_info_widget(tab: PageBase)

Removes a tab from the extension information widget.

Parameters

tab (ext_info_widget.PageBase) – The tab to remove from the info widget.

show_window(value)

Controls the visibility of the window based on the given value.

Parameters

value (bool) – Determines whether to show or hide the window.