Extension: omni.kit.menu.common-2.0.1

Documentation Generated: Aug 12, 2025

Overview#

The omni.kit.menu.common adds common menus.

  • Help (“Discover Kit SDK”, “Developers Manual”, “USD Reference Guide”)

  • Window (F7/F11).

It provides a standardized approach for initializing and managing parts of the Help and Window menus within the Omniverse Kit SDK application. It integrates legacy help and window extensions so that menu items for documentation access and window-specific operations are configured and ready to use right from startup.

Important#

  • As this extension binds the F11 key & so does app window. If this is loaded after kit has started then it can result in double binding, so always load via .kit file. See /exts/omni.appwindow/listenF11 in Settings

Concepts#

  • Help Menu Management: The extension includes a HelpExtension that registers and manages help-related menu items. It dynamically creates actions that open documentation URLs defined by settings such as the Discover Kit SDK, Developers Manual, and USD Reference Guide.

  • Window Menu Functionality: The WindowExtension is responsible for handling window-specific menu items. This includes features like toggling UI visibility, enabling fullscreen mode, and managing DPI scaling settings. The extension configures these items upon initialization and cleans them up during shutdown.

Functionality#

  • Legacy Integration: By leveraging legacy implementations for both Help and Window menus, the extension ensures compatibility with existing workflows while centralizing menu functionality.

  • Dynamic Configuration: The external documentation names and URLs are set through the extension’s configuration, allowing developers to easily adjust what is shown in the help menu without altering core code.

Relationships#

  • Dependencies: This extension depends on omni.kit.menu.utils and omni.kit.ui.actions to create and manage its menu items and associated actions.

  • Inter-extension Coordination: It works in tandem with other menu and UI-based extensions (like omni.appwindow) to provide consistent menu behavior across the application. For example, it sets a related setting in omni.appwindow to prevent conflicts with shortcut keys (e.g., F11).

Considerations#

  • The extension focuses on integrating legacy functionalities; therefore, its behavior is closely tied to how the legacy help and window modules operate.

  • Configuration parameters such as external documentation URLs and display names are unique to this extension and provide a tailored experience for accessing documentation and controlling window features.