ViewportDisplayMenuBarExtension

class omni.kit.viewport.menubar.display.extension.ViewportDisplayMenuBarExtension

Bases: IExt

The Entry Point for the Display Settings in Viewport Menu Bar

Methods

deregister_custom_category_item(category, item)	Deregister custom display setting in category.
deregister_custom_setting(text)	Deregister custom display setting.
on_shutdown()
on_startup(ext_id)
register_custom_category_item(category, item)	Register custom display setting in category.
register_custom_setting(text, setting_path)	Register custom display setting.

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

deregister_custom_category_item(category: str, item: BaseCategoryItem)

Deregister custom display setting in category. :param category: Category to remove menu item. Can be an existing category e.g. “Heads Up Display” or a new one. :type category: str :param item (item: BaseCategoryItem): Item to remove.

deregister_custom_setting(text: str)

Deregister custom display setting. :param text: Text shown in menu item. :type text: str

register_custom_category_item(category: str, item: BaseCategoryItem, section: str = 'default')

Register custom display setting in category. :param category: Category to add menu item. Can be an existing category e.g. “Heads Up Display” or a new one. :type category: str :param item (item: BaseCategoryItem): Item to append. :param section: Optional section to organise category, default no section. :type section: str

register_custom_setting(text: str, setting_path: str)

Register custom display setting. :param text: Text shown in menu item. :type text: str :param setting_path: Setting path for custom display setting (bool value). :type setting_path: str