PreferenceBuilderUI

class omni.kit.window.preferences.PreferenceBuilderUI(visibility_changed_fn: Callable)

Bases: object

Preferences “page” display functions.

Methods

__init__(visibility_changed_fn)

create_window()

Create omni.ui.window

destroy()

Destroy class and cleanup.

hide_window()

Hides window

rebuild_pages()

Rebuilds window pages using current page list

select_page(page)

If found, display the given Preference page and select its title in the TreeView.

set_active_page(page_index)

Set the given page index as the active one.

show_window()

Shows window

update_page_list(page_list)

Updates page list

__init__(visibility_changed_fn: Callable)
create_window()

Create omni.ui.window

Parameters

None

Returns

None

destroy()

Destroy class and cleanup.

hide_window() None

Hides window

Parameters

None

Returns

None

rebuild_pages() None

Rebuilds window pages using current page list

Parameters

None

Returns

None

select_page(page: PreferenceBuilder) bool

If found, display the given Preference page and select its title in the TreeView.

Parameters

page – One of the page from the list of pages.

Returns

A flag indicating if the given page was successfully selected.

Return type

bool

set_active_page(page_index: Union[int, str]) None

Set the given page index as the active one.

Parameters

page_index – Index of page of the page list to set as the active one.

Returns

None

show_window() None

Shows window

Parameters

None

Returns

None

update_page_list(page_list: List) None

Updates page list

Parameters

page_list – list of pages

Returns

None