omni.kit.menu.utils

Submodules Summary:

omni.kit.menu.utils.actions	Actions Omniverse Kit API (deprecated)
omni.kit.menu.utils.app_menu	ui.Menu and ui.MenuItem menu libraries
omni.kit.menu.utils.builder_utils	Definition of MenuItemDescription and other menu classes
omni.kit.menu.utils.debug_window	Menu debug window. Press “SHIFT+CONTROL+ALT+M” to open.
omni.kit.menu.utils.extension_window_helper	Simple helper class for adding/removing “Window” menu to your extension. ui.Window creation/show/hide is still down to user to provide functionally.
omni.kit.menu.utils.extension_window_helper_full	Advanced helper class for adding/removing “Window” menu to your extension & controlling ui.Window creation/show/hide. Only thing required is function to create ui_window
omni.kit.menu.utils.layout	Layout implementation class. See “Layouts and & Hooks” section
omni.kit.menu.utils.utils	Menu implementation class.

Classes Summary:

ActionMenuSubscription	Action menu subscription wrapper to make it scoped (auto unsubscribe on del) (deprecated)
AppMenu
IconMenuDelegate	Icon Menu Delegate class.
LayoutSourceSearch	Controls how layouts search for the menu item paths, either everywhere or just in the local menu group
MenuActionControl	Setting for executing actions. Either NODELAY which is executed instantly or NONE which is async with 1 frame delay
MenuAlignment	Menu alignment setting. Either left or right
MenuHelperExtension	Simple helper class for adding/removing “Window” menu to your extension. ui.Window creation/show/hide is still down to user to provide functionally.
MenuHelperExtensionFull	Advanced helper class for adding/removing “Window” menu to your extension & controlling ui.Window creation/show/hide. Only thing required is function to create ui_window
MenuHelperWindow	The Window class represents a window in the underlying windowing system.
MenuItemDescription	Class for creation of menu items
MenuItemOrder	“appear_after” values. FIRST will be top of list and LAST will be bottom of list.
MenuLayout	Layout implementation class. See “Layouts and & Hooks” section
MenuState	Internal state. Invalid is before EVENT_APP_READY event received and Created is after.
MenuUtilsDebugExtension	Menu debug window. Press “SHIFT+CONTROL+ALT+M” to open.
MenuUtilsExtension	Menu implementation class.
PrebuiltItemOrder	Internal flags used by layout for item ordering

Functions Summary:

add_action_to_menu	Add action to menu path. (deprecated)
add_hook	add a menu modification callback hook
add_layout	add a menu layout.
add_menu_items	add a list of menus items to menu.
build_submenu_dict	builds a dictionary of List[MenuItemDescription] with sub_menus from List[MenuItemDescription] with full paths. EG: “/Window/Viewport/Viewport 1”
get_action_path	converts menu path into internal path
get_debug_stats	gets debug stats as dictionary, info on what functions called and how many times.
get_instance	get MenuUtilsExtension class ptr
get_menu_layout	get menu layouts.
get_merged_menus	get combined menus as dictionary
rebuild_menus	force menus to rebuild, triggering hooks
refresh_menu_items	update menus enabled state
remove_hook	remove a menu modification callback hook
remove_layout	remove a menu layout.
remove_menu_items	remove a list of menus items to menu.
replace_menu_items	replace a existing list of menus items to menu.
set_default_menu_priority	set default menu priority