find

omni.kit.ui_test.find(path: str) → WidgetRef

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

Returned object can be used to get actual found item or/and do UI test operations on it.

stage_window = ui_test.find("Stage//Frame/**/ScrollingFrame/TreeView[*].visible==True")
await stage_window.right_click()

viewport = ui_test.find("Viewport")
center = viewport.center
print(center)

Parameters:

path (str) – Search query path to locate the widget or window.

Returns:

Found Widget or Window wrapped into `WidgetRef` object.

Return type:

WidgetRef