omni.kit.ui_test#

Classes Summary:

InitExt

Extension class for the omni.kit.ui_test extension.

KeyDownScope

A context manager that holds a keyboard key down for the duration of the scope.

Vec2

Generic 2D Vector

WidgetRef

Reference to `omni.ui.Widget` and a path it was found with.

WindowRef

Reference to `omni.ui.WindowHandle`.

Functions Summary:

emulate_char_press

Emulate Keyboard char input. Type N chars immediately and do a delay, then continue.

emulate_key_combo

Emulate Keyboard key combination.

emulate_keyboard_press

Emulate Keyboard key press. Down and up.

emulate_mouse_click

Emulate Mouse single or double click.

emulate_mouse_drag_and_drop

Emulate Mouse Drag & Drop. Click at start position and slowly move to end position.

emulate_mouse_move

Emulate Mouse move into position.

emulate_mouse_move_and_click

Emulate Mouse move into position and click.

emulate_mouse_scroll

Emulate Mouse scroll by delta.

find

Find omni.ui Widget or Window by search query. `omni.ui_query` is used under the hood.

find_all

Find all omni.ui Widget or Window by search query.

find_first

Find first omni.ui Widget or Window by search query.

find_with_retry

Find a widget with retry mechanism, attempting multiple times until found or maximum retries reached.

get_context_menu

Retrieve the structure and available items from a context menu.

get_menubar

Get the main window’s menu bar wrapped in a MenuRef object.

human_delay

Imitate human delay/slowness.

menu_click

Click on a menu item by navigating through the menu hierarchy path.

select_context_menu

Emulate selection of context menu item with mouse.

wait_n_updates

Wait N updates (frames).