IApp

class omni.kit.app.IApp

Methods

__init__(*args, **kwargs)

delay_app_ready(self, requester_name)

get_app_environment(self)

Name of the environment we are running in.

get_app_filename(self)

App filename.

get_app_name(self)

App name.

get_app_version(self)

App version.

get_app_version_short(self)

Short app version, currently major.minor, e.g.

get_build_version(self)

get_extension_manager(self)

get_kernel_version(self)

Full kit kernel version, e.g.

get_kit_version(self)

Full kit version, e.g.

get_kit_version_hash(self)

Git hash of kit build, 8 letters, e.g.

get_kit_version_short(self)

Short kit version, currently major.minor.

get_log_event_stream(self)

Log event stream.

get_message_bus_event_stream(self, runloop_name)

get_platform_info(self)

get_post_update_event_stream(self, runloop_name)

get_pre_update_event_stream(self, runloop_name)

get_python_scripting(self)

get_shutdown_event_stream(self)

get_startup_event_stream(self)

get_time_since_start_ms(self)

get_time_since_start_s(self)

get_update_event_stream(self, runloop_name)

get_update_number(self)

is_app_external(self)

Is external (public) configuration

is_app_ready(self)

is_debug_build(self)

is_running(self)

next_update_async()

Wait for next update of Omniverse Kit.

post_quit(self[, return_code])

post_uncancellable_quit(self[, return_code])

post_update_async()

pre_update_async()

Wait for next update of Omniverse Kit.

print_and_log(self, message)

replay_log_messages(self, arg0)

Replays recorded log messages for the specified target.

restart(self[, args, overwrite_args, ...])

run(self, app_name, app_path[, argv])

shutdown(self)

startup(self, app_name, app_path[, argv])

toggle_log_message_recording(self, arg0)

Toggles log message recording.

try_cancel_shutdown(self[, reason])

update(self)

__init__(*args, **kwargs)
delay_app_ready(self: omni.kit.app._app.IApp, requester_name: str) None
get_app_environment(self: omni.kit.app._app.IApp) str

Name of the environment we are running in. (/app/environment/name setting, e.g.: teamcity, launcher, etm, default)

get_app_filename(self: omni.kit.app._app.IApp) str

App filename. Name of a kit file

get_app_name(self: omni.kit.app._app.IApp) str

App name. It is app/name setting if defined, otherwise same as `filename`

get_app_version(self: omni.kit.app._app.IApp) str

App version. Version in kit file or kit version

get_app_version_short(self: omni.kit.app._app.IApp) str

Short app version, currently major.minor, e.g. `2021.3`

get_build_version(self: omni.kit.app._app.IApp) str
get_extension_manager(self: omni.kit.app._app.IApp) omni.ext._extensions.ExtensionManager
get_kernel_version(self: omni.kit.app._app.IApp) str

Full kit kernel version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`

get_kit_version(self: omni.kit.app._app.IApp) str

Full kit version, e.g. `103.5+release.7032.aac30830.tc.windows-x86_64.release`

get_kit_version_hash(self: omni.kit.app._app.IApp) str

Git hash of kit build, 8 letters, e.g. `aac30830`

get_kit_version_short(self: omni.kit.app._app.IApp) str

Short kit version, currently major.minor. e.g. `103.5`

get_log_event_stream(self: omni.kit.app._app.IApp) carb::events::IEventStream

Log event stream.

get_message_bus_event_stream(self: omni.kit.app._app.IApp, runloop_name: str = 'main') carb::events::IEventStream
get_platform_info(self: omni.kit.app._app.IApp) dict
get_post_update_event_stream(self: omni.kit.app._app.IApp, runloop_name: str = 'main') carb::events::IEventStream
get_pre_update_event_stream(self: omni.kit.app._app.IApp, runloop_name: str = 'main') carb::events::IEventStream
get_python_scripting(self: omni.kit.app._app.IApp) omni::kit::IAppScripting
get_shutdown_event_stream(self: omni.kit.app._app.IApp) carb::events::IEventStream
get_startup_event_stream(self: omni.kit.app._app.IApp) carb::events::IEventStream
get_time_since_start_ms(self: omni.kit.app._app.IApp) float
get_time_since_start_s(self: omni.kit.app._app.IApp) float
get_update_event_stream(self: omni.kit.app._app.IApp, runloop_name: str = 'main') carb::events::IEventStream
get_update_number(self: omni.kit.app._app.IApp) int
is_app_external(self: omni.kit.app._app.IApp) bool

Is external (public) configuration

is_app_ready(self: omni.kit.app._app.IApp) bool
is_debug_build(self: omni.kit.app._app.IApp) bool
is_running(self: omni.kit.app._app.IApp) bool
async next_update_async() float

Wait for next update of Omniverse Kit. Return delta time in seconds

post_quit(self: omni.kit.app._app.IApp, return_code: int = 0) None
post_uncancellable_quit(self: omni.kit.app._app.IApp, return_code: int = 0) None
async pre_update_async() float

Wait for next update of Omniverse Kit. Return delta time in seconds

print_and_log(self: omni.kit.app._app.IApp, message: str) None
replay_log_messages(self: omni.kit.app._app.IApp, arg0: carb::logging::Logger) None

Replays recorded log messages for the specified target.

restart(self: omni.kit.app._app.IApp, args: List[str] = [], overwrite_args: bool = False, uncancellable: bool = False) None
run(self: omni.kit.app._app.IApp, app_name: str, app_path: str, argv: List[str] = []) int
shutdown(self: omni.kit.app._app.IApp) int
startup(self: omni.kit.app._app.IApp, app_name: str, app_path: str, argv: List[str] = []) None
toggle_log_message_recording(self: omni.kit.app._app.IApp, arg0: bool) None

Toggles log message recording.

try_cancel_shutdown(self: omni.kit.app._app.IApp, reason: str = '') bool
update(self: omni.kit.app._app.IApp) None