LiveSessionEndWindow#

class omni.kit.widget.live_session_management_ui.LiveSessionEndWindow(
current_session,
on_ok_button_cb: Callable[[], None],
warn_root_prims=False,
)#

Bases: object

A modal dialog window for managing live session merge operations when a session ends.

This window provides users with options to merge changes from an ending live session, allowing them to choose between merging to corresponding layers or creating a new layer. It includes a checkpoint description field and handles file picking operations for save destinations.

Parameters:

  • current_session (object) – The live session that is ending and needs merge handling.

  • on_ok_button_cb (Callable[[], None]) – Callback function executed when the user confirms the merge operation.

  • warn_root_prims (bool) – Whether to display a warning about PrimSpecs in the root layer that could be hidden during merge.

Methods

__init__(current_session, on_ok_button_cb[, ...])

Initializes a modal dialog window for handling live session end options with merge choices and checkpoint description.

destroy()

Cleans up the window and releases UI resources.

set_error_msg(msg)

Show error message in dialog

show_file_picker(file_handler[, ...])

Displays a file picker dialog for saving live session changes.

Attributes

visible

Gets the visibility state of the merge options window.
__init__(
current_session,
on_ok_button_cb: Callable[[], None],
warn_root_prims=False,
)#

Initializes a modal dialog window for handling live session end options with merge choices and checkpoint description.

destroy()#

Cleans up the window and releases UI resources.

set_error_msg(msg)#

Show error message in dialog

Parameters:

msg (str) – Error message to display in the dialog.

show_file_picker(
file_handler,
default_location=None,
default_filename=None,
new_os_window=False,
)#

Displays a file picker dialog for saving live session changes.

Parameters:

  • file_handler (Callable) – Callback function to handle the selected file.

  • default_location (str) – Initial directory path for the file picker.

  • default_filename (str) – Default filename to display in the picker.

  • new_os_window (bool) – Whether to open the picker in a new OS window.

property visible#

Gets the visibility state of the merge options window.

Returns:

True if the window is visible, False otherwise.

Return type:

bool