[omni.kit.loop-isaac] Isaac Loop Runner#

Version: 1.2.1

Custom Loop Runner for Isaac Sim

Enable Extension#

The extension can be enabled (if not already) in one of the following ways:

Define the next entry as an application argument from a terminal.

APP_SCRIPT.(sh|bat) --enable omni.kit.loop-isaac

Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.

[dependencies]
"omni.kit.loop-isaac" = {}

Open the Window > Extensions menu in a running application instance and search for omni.kit.loop-isaac. Then, toggle the enable control button if it is not already active.

API#

Python API#


Isaac loop bindings

class RunLoopRunner#

Bases: pybind11_object

set_manual_mode(
self: omni.kit.loop._loop.RunLoopRunner,
enabled: bool = 'True',
name: str = '',
) None#

Sets dt for run loop.

Parameters:
  • arg0 (bool) – Set to true to enable manual mode.

  • arg1 (str) – The name of the run loop. If name is an empty string, all active run loops are set.

set_manual_step_size(
self: omni.kit.loop._loop.RunLoopRunner,
dt: float = '0.01667',
name: str = '',
) None#

Sets dt for run loop.

Parameters:
  • arg0 (double) – The dt value to set to.

  • arg1 (str) – The name of the run loop. If name is an empty string, all active run loops are set.

acquire_loop_interface(
plugin_name: str = None,
library_path: str = None,
) omni.kit.loop._loop.RunLoopRunner#
release_loop_interface(
arg0: omni.kit.loop._loop.RunLoopRunner,
) None#

Settings#

Other Settings#

The extension changes some settings of the application or other extensions, which are listed in the table below.

Application/extension setting

Value

app.runLoopsGlobal.syncToPresent

False

app.runLoops.main.rateLimitEnabled

True

app.runLoops.main.rateLimitFrequency

120

app.runLoops.main.rateLimitUseBusyLoop

False

app.runLoops.present.rateLimitEnabled

True

app.runLoops.present.rateLimitFrequency

60

app.runLoops.present.rateLimitUseBusyLoop

False

app.runLoops.rendering_0.rateLimitEnabled

True

app.runLoops.rendering_0.rateLimitFrequency

120

app.runLoops.rendering_0.rateLimitUseBusyLoop

False