ViewportDisplayMenuBarExtension

class omni.kit.viewport.menubar.display.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.

Parameters

• category (str) – Category to remove menu item. Can be an existing category e.g. “Heads Up Display” or a new one.

• (item (item) – BaseCategoryItem): Item to remove.

deregister_custom_setting(text: str)

Deregister custom display setting.

Parameters

text (str) – Text shown in menu item.

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

Register custom display setting in category.

Parameters

• category (str) – Category to add menu item. Can be an existing category e.g. “Heads Up Display” or a new one.

• (item (item) – BaseCategoryItem): Item to append.

• section (str) – Optional section to organize category, default no section.

register_custom_setting(text: str, setting_path: str)

Register custom display setting.

Parameters

• text (str) – Text shown in menu item.

• setting_path (str) – Setting path for custom display setting (bool value).