API#

Python API#


Isaac loop bindings

class RunLoopRunner#

Bases: pybind11_object

get_manual_mode(
self: omni.kit.loop._loop.RunLoopRunner,
name: str = '',
) bool#

Gets the manual mode state for the run loop.

Parameters:

name (str) – The name of the run loop. If name is an empty string, returns the state of the first active run loop.

Returns:

True if manual mode is enabled, false otherwise.

Return type:

bool

get_manual_step_size(
self: omni.kit.loop._loop.RunLoopRunner,
name: str = '',
) float#

Gets the time step size (dt) for manual stepping mode.

Parameters:

name (str) – The name of the run loop. If name is an empty string, returns the step size of the first active run loop.

Returns:

The time step size in seconds.

Return type:

double

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

Enables or disables manual stepping mode for the run loop.

Parameters:
  • enabled (bool) – Set to true to enable manual mode, false to disable.

  • name (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 the time step size (dt) for manual stepping mode.

Parameters:
  • dt (double) – The time step size in seconds.

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

set_next_simulation_time(
self: omni.kit.loop._loop.RunLoopRunner,
time: float = 0.0,
name: str = '',
) None#

Sets the next simulation time to be picked up by the run loop.

Parameters:
  • time (double) – The simulation time value in seconds. Use negative value to reset to frame-based time.

  • name (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#