Extension: omni.kit.menu.core-1.1.2 |
Documentation Generated: Dec 17, 2024 |
Overview#
The omni.kit.menu.core module provides a set of tools and classes for creating and managing menus and used by omni.kit.menu.utils and omni.kit.context_menu. This includes support for read-only dictionaries, specialized menu items, icons with full paths and menu delegates with customizable styles and behaviors.
Important API List#
The module consists of the following main components:
DictReadOnly: A read-only dictionary that prevents accidental modifications.
IconMenuBaseDelegate: A delegate class for creating menus with icons and customizable styles.
MenuEventType: An enumeration class defining constants for various menu activation events.
has_delegate_func: A utility function to check if a delegate has a specific function.
uiMenu: A subclass of
ui.Menuwith additional properties for glyphs, checkable menus, hotkey texts, and submenus.uiMenuItem: A subclass of
ui.MenuItemwith properties for glyphs, checkable menu items, hotkey texts, and parent menus.
General Use Case#
Users can utilize this module to create sophisticated and highly customizable menus within the Omniverse Kit SDK environment. The DictReadOnly class ensures that certain data remains immutable, which can be useful for configuration settings. The IconMenuBaseDelegate allows for the design of visually appealing menus with icons and various styling options. MenuEventType helps in managing different types of menu activation events. The has_delegate_func function is useful for dynamically checking the presence of methods in delegate objects. The uiMenu and uiMenuItem classes extend the basic menu and menu item functionalities provided by the Omniverse Kit SDK, enabling the creation of more complex and feature-rich menus. For examples of how to use the APIs, please consult the Python usage pages.