Python guide and API reference#
Simulation#
initialize() -> None |
|
play() -> None |
|
pause() -> None |
|
stop() -> None |
|
step() -> None |
|
invalidate() -> None |
|
str, value: bool | int | int | float | str) -> None |
|
str) -> bool | int | int | float | str |
- isaacsim.foundation.ovsim.control.simulation.initialize() None#
Copy the active OpenUSD stage into a retained OVStage simulation snapshot.
- isaacsim.foundation.ovsim.control.simulation.play() None#
Accept a play request without changing simulation state.
- isaacsim.foundation.ovsim.control.simulation.pause() None#
Accept a pause request without changing simulation state.
- isaacsim.foundation.ovsim.control.simulation.stop() None#
Accept a stop request without changing simulation state.
- isaacsim.foundation.ovsim.control.simulation.step() None#
Accept a manual simulation step request without changing simulation state.
- isaacsim.foundation.ovsim.control.simulation.invalidate() None#
Close and release the retained OVStage simulation snapshot, if one exists.
- isaacsim.foundation.ovsim.control.simulation.set_parameter(
- provider: str,
- parameter_name: str,
- value: bool | int | int | float | str,
Reject a simulation provider parameter because configuration is not implemented.
- Parameters:
provider – Provider identifier.
parameter_name – Provider-specific parameter name.
value – Parameter value.
- Raises:
RuntimeError – Always.
- isaacsim.foundation.ovsim.control.simulation.get_parameter(
- provider: str,
- parameter_name: str,
Reject a simulation provider query because configuration is not implemented.
- Parameters:
provider – Provider identifier.
parameter_name – Provider-specific parameter name.
- Raises:
RuntimeError – Always.
Data#
str, timestamp: float | None = None) -> list[str] | list[list[str]] | warp.array |
|
str, values: str | collections.abc.Sequence[str] | collections.abc.Sequence[collections.abc.Sequence[str]] | warp.array, timestamp: float | None = None) -> None |
- isaacsim.foundation.ovsim.data.read(
- paths: str | collections.abc.Sequence[str],
- attribute_name: str,
- timestamp: float | None = None,
Read one attribute from one or more prims on the active stage.
- Parameters:
paths – Absolute prim path or paths to read.
attribute_name – Name of the attribute or registered facade property to read.
timestamp – Optional time code in stage time units. The current implementation reads default-time values.
- Returns:
Values read for the selected prim paths.
- isaacsim.foundation.ovsim.data.write(
- paths: str | collections.abc.Sequence[str],
- attribute_name: str,
- values: str | collections.abc.Sequence[str] | collections.abc.Sequence[collections.abc.Sequence[str]] | warp.array,
- timestamp: float | None = None,
Write one attribute on one or more prims on the active stage.
- Parameters:
paths – Absolute prim path or paths to modify.
attribute_name – Name of the attribute or registered facade property to write.
values – Values to write to the selected prim paths.
timestamp – Optional time code in stage time units. The current implementation writes default-time values.