omni.kit.editor module

This module contains bindings to C++ omni::kit::IEditor interface, core C++ part of Omniverse Kit.

All the function are in omni.kit.editor.IEditor class, to get it use get_editor_interface method, which caches acquire interface call:

>>> import omni.kit.editor
>>> e = omni.kit.editor.get_editor_interface()
>>> print(f"Is UI hidden: {e.is_ui_hidden()}")
class omni.kit.editor.IEditor

Bases: pybind11_builtins.pybind11_object

capture_next_frame(self: omni.kit.editor._editor.IEditor, arg0: str)None
dismiss_prompt(self: omni.kit.editor._editor.IEditor, arg0: omni.kit.editor._editor.Prompt)None
get_build_version(self: omni.kit.editor._editor.IEditor)str
get_current_renderer_status(self: omni.kit.editor._editor.IEditor) → Tuple[int, str, int, int]
get_editor_window_height(self: omni.kit.editor._editor.IEditor)int
get_editor_window_width(self: omni.kit.editor._editor.IEditor)int
get_fps(self: omni.kit.editor._editor.IEditor)float
get_gpu_profiler_result(self: omni.kit.editor._editor.IEditor)list

Get GPU profiler result in a list of tuples with dictionaries. Each item in the list correspond to a GPU device, and tuples contain timestamp data in a dictionary.

get_mem_stats_result(self: omni.kit.editor._editor.IEditor, arg0: bool)tuple

Get memory stats result in tuples.

get_prompt_result(self: omni.kit.editor._editor.IEditor, arg0: omni.kit.editor._editor.Prompt, arg1: int)object
get_ui_style(self: omni.kit.editor._editor.IEditor)str
is_debug_build(self: omni.kit.editor._editor.IEditor)bool
is_running(self: omni.kit.editor._editor.IEditor)bool
is_ui_hidden(self: omni.kit.editor._editor.IEditor)bool
post_prompt(self: omni.kit.editor._editor.IEditor, arg0: str, arg1: str, arg2: List[str], arg3: bool) → omni.kit.editor._editor.Prompt
post_quit(self: omni.kit.editor._editor.IEditor)None
reset_render_setting_to_default(self: omni.kit.editor._editor.IEditor, arg0: str)None
set_capture_sync(self: omni.kit.editor._editor.IEditor, arg0: bool)bool
set_ui_hidden(self: omni.kit.editor._editor.IEditor, arg0: bool)None
set_ui_style(self: omni.kit.editor._editor.IEditor, uiStyle: str)None
set_window_open(self: omni.kit.editor._editor.IEditor, arg0: str, arg1: bool)None
show_imgui_demo_window(self: omni.kit.editor._editor.IEditor)None
shutdown(self: omni.kit.editor._editor.IEditor)None
startup(self: omni.kit.editor._editor.IEditor)None
subscribe_to_update_events(self: omni.kit.editor._editor.IEditor, fn: Callable[[float], None]) → carb._carb.Subscription

Subscribes to update events.

Update event would be called every frame and time passed in seconds would be passed into. See Subscription for more information on subscribing mechanism.

Parameters

fn – The callback to be called on every update.

Returns

The subscription holder.

wait_async_capture(self: omni.kit.editor._editor.IEditor)None
class omni.kit.editor.Prompt

Bases: pybind11_builtins.pybind11_object

omni.kit.editor.acquire_editor_interface(plugin_name: str = None, library_path: str = None) → omni::kit::IEditor
omni.kit.editor.get_editor_interface() → omni.kit.editor._editor.IEditor

Returns cached omni.kit.editor.IEditor interface

omni.kit.editor.release_editor_interface(arg0: omni::kit::IEditor)None