AboutExtension

class omni.kit.window.about.AboutExtension

Bases: IExt

The AboutExtension class implements an extension for displaying an About window in the help menu. This extension integrates with the Omni UI and the Omniverse Kit SDK by setting up a dedicated About window and a corresponding menu entry. It provides methods to toggle the window visibility and to ensure that the menu item reflects the current state of the window.

Methods

menu_show_about(plugins)	Handles the action for showing the about information in the menu and prepares extension version details.
on_shutdown()	Handles the shutdown event for the extension by cleaning up resources, destroying the window, and removing menu items.
on_startup(ext_id)	Handles the startup event for the extension by initializing UI elements and registering actions.
show(visible)	Updates the About window visibility based on the provided parameter.
toggle_window()	Toggles the visibility of the About window.

__init__(self: omni.ext._extensions.IExt) → None

menu_show_about(plugins)

Handles the action for showing the about information in the menu and prepares extension version details.

Parameters:

plugins (list) – A list of plugins for processing about information.

on_shutdown()

Handles the shutdown event for the extension by cleaning up resources, destroying the window, and removing menu items.

on_startup(ext_id)

Handles the startup event for the extension by initializing UI elements and registering actions.

Parameters:

ext_id (str) – The extension id used for initialization.

show(visible: bool)

Updates the About window visibility based on the provided parameter.

Parameters:

visible (bool) – Controls the visibility of the window; True to show, False to hide.

toggle_window()

Toggles the visibility of the About window.