SelectableMenuItem#

class omni.kit.viewport.menubar.core.SelectableMenuItem(
name: str,
model: AbstractValueModel | None = None,
delegate: MenuDelegate | None = None,
hide_on_click: bool = False,
toggle: bool = True,
triggered_fn: Callable = None,
trigger_will_set_model: bool = False,
**kwargs,
)#

Bases: MenuItem

A menu item can be selected.

Methods

__init__(name[, model, delegate, ...])

Constructor.

destroy()

Release resources

Attributes

__init__(
name: str,
model: AbstractValueModel | None = None,
delegate: MenuDelegate | None = None,
hide_on_click: bool = False,
toggle: bool = True,
triggered_fn: Callable = None,
trigger_will_set_model: bool = False,
**kwargs,
)#

Constructor.

Keyword Arguments:

  • model (Optional[ui.AbstractValueModel]) – Model for selected state, defaults to none.

  • delegate (Optional[ui.MenuDelegate]) – Menu item delegate, defaults to None means using ViewportMenuDelegate.

  • hide_on_click (bool) – Hide menu when radio menu item clicked, defaults to False.

  • toggle (bool) – Whether this item can be toggled to (on/off) or always triggers on, defaults to True

  • triggered_fn (callable) – Callback when menu item clicked, defaults to None.

  • trigger_will_set_model (bool) – Update selected state model when menu item clicked, defaults to False.

  • ui.MenuItem (For other kwargs, please refer to)

destroy() → None#

Release resources