QuickLayout

class omni.kit.quicklayout.QuickLayout

Bases: object

Namespace that contains methods to load and save the layout

Methods

__init__()	Initializes a QuickLayout instance.
compare_file(workspace_file[, compare_delegate])	Compare the workspace file with the current layout using the provided delegate.
destroy()	Destroys the current dialog if it exists and resets it.
load(menu, value)	Load layout with the dialog.
load_file(workspace_file[, keep_windows_open])	Load the layout from the workspace file.
quick_load(menu, value)	Quickly loads the layout without prompting through a dialog.
quick_save(menu, value)	Quickly saves the layout without prompting through a dialog.
save(menu, value)	Save layout with the dialog.
save_file(workspace_file)	Save the layout to the workspace file.

__init__()

Initializes a QuickLayout instance.

static compare_file(

workspace_file: str,

compare_delegate: ~omni.ui.workspace_utils.CompareDelegate = <omni.ui.workspace_utils.CompareDelegate object>,

)

Compare the workspace file with the current layout using the provided delegate.

Parameters:

• workspace_file (str) – The workspace file path to compare.

• compare_delegate (CompareDelegate) – Delegate used for workspace comparison.

destroy()

Destroys the current dialog if it exists and resets it.

load(menu: str, value: bool)

Load layout with the dialog.

Parameters:

• menu (str) – Menu option triggering the load dialog.

• value (bool) – Boolean indicating state for the load action.

static load_file(workspace_file: str, keep_windows_open=False)

Load the layout from the workspace file.

Parameters:

• workspace_file (str) – The workspace file path to load the layout from.

• keep_windows_open (bool) – Option to keep windows open after loading.

static quick_load(menu: str, value: bool)

Quickly loads the layout without prompting through a dialog.

Parameters:

• menu (str) – Menu option triggering the quick load.

• value (bool) – Boolean indicating state for the quick load action.

static quick_save(menu: str, value: bool)

Quickly saves the layout without prompting through a dialog.

Parameters:

• menu (str) – Menu option triggering the quick save.

• value (bool) – Boolean indicating state for the quick save action.

save(menu: str, value: bool)

Save layout with the dialog.

Parameters:

• menu (str) – Menu option triggering the save dialog.

• value (bool) – Boolean indicating state for the save action.

static save_file(workspace_file: str)

Save the layout to the workspace file.

Parameters:

workspace_file (str) – The workspace file path to save the layout.