Python guide and API reference#
Use setup() before importing a backend that needs the packaged OVStage
runtime directly. get_native_handle() registers a Python stage for later
lookup, while as_native_handle() normalizes integer and nanobind capsule
representations.
|
Make the private OVStage runtime discoverable. |
|
Get the native address for a public OVStage object. |
|
Normalize a native ovstage address from an int or nanobind |
|
Look up a Python OVStage previously registered via |
- isaacsim.physics_engines.ovstage.setup() None#
Make the private OVStage runtime discoverable.
Repeated calls are safe. On Linux, each call refreshes the loader hint to select an OVStage library that an engine binding has loaded since the prior call. This function does not import or modify
pxr.- Raises:
RuntimeError – If the bundled runtime is missing.
Example:
>>> from isaacsim.physics_engines.ovstage import setup >>> setup()
- isaacsim.physics_engines.ovstage.get_native_handle(stage: object) int#
Get the native address for a public OVStage object.
Registers
stagesolookup_stage()can recover it from the integer handle passed throughphysics_manager.initialize.- Parameters:
stage – OVStage object whose native address is required by a consumer.
- Returns:
Native OVStage address.
- Raises:
TypeError – If stage is not an OVStage-compatible object.
RuntimeError – If the OVStage object has been destroyed.
- isaacsim.physics_engines.ovstage.as_native_handle(value: object | None) int#
Normalize a native ovstage address from an int or nanobind
void*capsule.physics_manager.initializeaccepts aninthandle, but when the manager invokes a PythonSimulationFns.initializecallback the C++void*is delivered as a nanobindPyCapsulenamednb_handle.- Parameters:
value – Native address as
int, nanobindPyCapsule, orNone/0.- Returns:
Native address as
int, or0whenvalueis null.- Raises:
TypeError – If
valueis neither an integer nor a recognized capsule.
- isaacsim.physics_engines.ovstage.lookup_stage(handle: object | None) object | None#
Look up a Python OVStage previously registered via
get_native_handle().- Parameters:
handle – Native OVStage address as
intor nanobindvoid*capsule.- Returns:
Owning Python Stage when still alive, otherwise None.