Python guide and API reference#

Authoring#

The authoring names are present for OV SIM interface compatibility, but this physics-only adapter does not implement stage authoring. Every function in this section currently raises RuntimeError.

create_stage

create_stage() -> bool

open_stage

str) -> bool

save_stage

str) -> bool

export_stage_to_string

export_stage_to_string() -> str

import_stage_from_string

str) -> bool

close_stage

close_stage() -> bool

add_reference_to_stage

str, type_name: str = 'Xform') -> bool

define_prim

str = 'Xform') -> bool

move_prim

str) -> bool

remove_prim

str) -> bool

create_prim_attribute

str, type_name: str) -> bool

remove_prim_attribute

str) -> bool

set_parameter

str, value: bool | int | int | float | str) -> None

get_parameter

str) -> bool | int | int | float | str

isaacsim.physics.ovsim.control.authoring.create_stage() → bool#

Report that creating a stage is unavailable in this adapter.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.open_stage(usd_path: str) → bool#

Report that opening a stage is unavailable in this adapter.

Parameters:

usd_path – Path or URL of the USD stage to open.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.save_stage(usd_path: str) → bool#

Report that saving a stage is unavailable in this adapter.

Parameters:

usd_path – Destination path or URL for the stage.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.export_stage_to_string() → str#

Report that exporting stage contents is unavailable in this adapter.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.import_stage_from_string(usd_string: str) → bool#

Report that importing stage contents is unavailable in this adapter.

Parameters:

usd_string – Serialized USD stage contents.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.close_stage() → bool#

Report that closing a stage is unavailable in this adapter.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.add_reference_to_stage(
usd_path: str,
path: str,
type_name: str = 'Xform',
) → bool#

Report that adding a USD reference is unavailable in this adapter.

Parameters:
  • usd_path – Path or URL of the referenced USD asset.

  • path – Stage path of the prim that would receive the reference.

  • type_name – USD type used when the destination prim must be defined.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.define_prim(path: str, type_name: str = 'Xform') → bool#

Report that defining a prim is unavailable in this adapter.

Parameters:
  • path – Stage path of the prim to define.

  • type_name – USD type of the prim.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.move_prim(target_path: str, destination_path: str) → bool#

Report that moving a prim is unavailable in this adapter.

Parameters:
  • target_path – Current stage path of the prim.

  • destination_path – New stage path for the prim.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.remove_prim(path: str) → bool#

Report that removing a prim is unavailable in this adapter.

Parameters:

path – Stage path of the prim to remove.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.create_prim_attribute(
path: str,
attribute_name: str,
type_name: str,
) → bool#

Report that creating a prim attribute is unavailable in this adapter.

Parameters:
  • path – Stage path of the prim.

  • attribute_name – Name of the attribute to create.

  • type_name – USD type name of the attribute.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.remove_prim_attribute(path: str, attribute_name: str) → bool#

Report that removing a prim attribute is unavailable in this adapter.

Parameters:
  • path – Stage path of the prim.

  • attribute_name – Name of the attribute to remove.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.set_parameter(
provider: str,
parameter_name: str,
value: bool | int | int | float | str,
) → None#

Report that setting an authoring parameter is unavailable in this adapter.

Parameters:
  • provider – Name of the parameter provider.

  • parameter_name – Name of the parameter to set.

  • value – Value to assign to the parameter.

Raises:

RuntimeError – Always; stage authoring is not implemented.

isaacsim.physics.ovsim.control.authoring.get_parameter(
provider: str,
parameter_name: str,
) → bool | int | int | float | str#

Report that reading an authoring parameter is unavailable in this adapter.

Parameters:
  • provider – Name of the parameter provider.

  • parameter_name – Name of the parameter to retrieve.

Raises:

RuntimeError – Always; stage authoring is not implemented.

Simulation#

Manual simulation requires an OVStage native handle and a registered physics engine. Configure both before initialization:

from isaacsim.physics.ovsim.control import simulation

simulation.set_parameter("physics", "ovstage-stage-ptr", stage_handle)
simulation.set_parameter("physics", "physics-engine", "ovphysx")
simulation.initialize()
simulation.step()
simulation.invalidate()

play(), pause(), and stop() are compatibility no-ops; use initialize(), step(), and invalidate() for manual control.

initialize

initialize() -> None

play

play() -> None

pause

pause() -> None

stop

stop() -> None

step

step() -> None

invalidate

invalidate() -> None

set_parameter

str, value: bool | int | int | float | str) -> None

get_parameter

str) -> bool | int | int | float | str

isaacsim.physics.ovsim.control.simulation.initialize() → None#

Initialize the active physics simulation for manual stepping.

Configure ovstage-stage-ptr before calling this function.

Raises:

RuntimeError – If no OVStage pointer is configured or physics initialization fails.

isaacsim.physics.ovsim.control.simulation.play() → None#

Preserve play-state API compatibility without changing manual simulation state.

isaacsim.physics.ovsim.control.simulation.pause() → None#

Preserve pause-state API compatibility without changing manual simulation state.

isaacsim.physics.ovsim.control.simulation.stop() → None#

Preserve stop-state API compatibility without changing manual simulation state.

isaacsim.physics.ovsim.control.simulation.step() → None#

Advance the manually controlled simulation by one step.

Raises:

RuntimeError – If the simulation is not initialized.

isaacsim.physics.ovsim.control.simulation.invalidate() → None#

Invalidate the manually stepped simulation state.

Raises:

RuntimeError – If physics invalidation fails.

isaacsim.physics.ovsim.control.simulation.set_parameter(
provider: str,
parameter_name: str,
value: bool | int | int | float | str,
) → None#

Set a parameter for the physics simulation provider.

Parameters:
  • provider – Provider name. Only "physics" is supported.

  • parameter_name – "ovstage-stage-ptr" or "physics-engine".

  • value – Native OVStage pointer encoded as an integer, or physics-engine name.

Raises:

ValueError – If the provider, parameter name, or value type is unsupported.

isaacsim.physics.ovsim.control.simulation.get_parameter(
provider: str,
parameter_name: str,
) → bool | int | int | float | str#

Get a parameter from the physics simulation provider.

Parameters:
  • provider – Provider name. Only "physics" is supported.

  • parameter_name – Parameter to retrieve. Only "ovstage-stage-ptr" is supported.

Returns:

Native OVStage pointer encoded as an integer.

Return type:

int

Raises:

ValueError – If the provider or parameter name is unsupported.

Data#

Data operations resolve physics entity views using the active engine. The optional timestamp parameter is accepted for OV SIM compatibility, but time-sampled reads and writes are not yet applied.

read

str, timestamp: float | None = None) -> list[str] | list[list[str]] | warp.array

write

str, values: str | collections.abc.Sequence[str] | collections.abc.Sequence[collections.abc.Sequence[str]] | warp.array, timestamp: float | None = None) -> None

isaacsim.physics.ovsim.data.read(
paths: str | collections.abc.Sequence[str],
attribute_name: str,
timestamp: float | None = None,
) → list[str] | list[list[str]] | warp.array#

Read an attribute from one or more physics prims.

Parameters:
  • paths – Prim path or sequence of prim paths to read.

  • attribute_name – Name of the attribute to read.

  • timestamp – Optional USD time code. Time-sampled reads are not yet applied.

Returns:

Attribute values for the requested prim paths.

Return type:

object

Raises:

RuntimeError – If no active physics engine supports the requested attribute.

isaacsim.physics.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,
) → None#

Write an attribute on one or more physics prims.

Parameters:
  • paths – Prim path or sequence of prim paths to update.

  • attribute_name – Name of the attribute to write.

  • values – Attribute values to assign.

  • timestamp – Optional USD time code. Time-sampled writes are not yet applied.

Raises:

RuntimeError – If no active physics engine supports the requested attribute.