Python guide and API reference#
The registration package contains the shared simulation callback structures, registry operations, subscriptions, and tensor registration vocabulary.
- class isaacsim.physics.registration.BenchmarkFns(self)#
Bases:
objectCallbacks that expose backend profiling data.
Create an empty profiling callback collection.
- property subscribe_profile_stats_events#
Callback that subscribes to physics profiling statistics.
- property unsubscribe_profile_stats_events#
Callback that unsubscribes from physics profiling statistics.
- class isaacsim.physics.registration.ContactData(self)#
Bases:
objectDescribe one contact point.
Create empty contact-point data.
- property impulse#
Normal impulse magnitude.
- property normal#
World-space contact normal.
- property position#
World-space contact position.
- property separation#
Signed separation distance.
- class isaacsim.physics.registration.ContactDataVector(self)#
- class isaacsim.physics.registration.ContactDataVector( )
- class isaacsim.physics.registration.ContactDataVector(
- self,
- arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.ContactData],
- /,
Bases:
objectMutable sequence of contact points.
Overloaded function.
__init__(self) -> None
Default constructor
__init__(self, arg: isaacsim.physics.registration.bindings._bindings.ContactDataVector) -> None
Copy constructor
__init__(self, arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.ContactData], /) -> None
Construct from an iterable object
- append#
Append arg to the end of the list.
- clear#
Remove all items from list.
- extend#
Extend self by appending elements from arg.
- insert#
Insert object arg1 before index arg0.
- pop#
Remove and return item at index (default last).
- class isaacsim.physics.registration.ContactEventHeader(self)#
Bases:
objectDescribe one pair of objects in a contact event.
Create an empty contact-event header.
- property actor0#
First actor path identifier.
- property actor1#
Second actor path identifier.
- property collider0#
First collider path identifier.
- property collider1#
Second collider path identifier.
- property contact_data_offset#
Offset of this pair’s first contact point.
- property friction_anchors_data_offset#
Offset of this pair’s first friction anchor.
- property num_contact_data#
Number of contact points for this pair.
- property num_friction_anchors_data#
Number of friction anchors for this pair.
- property proto_index0#
Prototype index for the first actor.
- property proto_index1#
Prototype index for the second actor.
- property stage_id#
Identifier of the stage containing the contact.
- property type#
Lifecycle state of the contact pair.
- class isaacsim.physics.registration.ContactEventHeaderVector(self)#
- class isaacsim.physics.registration.ContactEventHeaderVector( )
- class isaacsim.physics.registration.ContactEventHeaderVector(
- self,
- arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.ContactEventHeader],
- /,
Bases:
objectMutable sequence of contact-event headers.
Overloaded function.
__init__(self) -> None
Default constructor
__init__(self, arg: isaacsim.physics.registration.bindings._bindings.ContactEventHeaderVector) -> None
Copy constructor
__init__(self, arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.ContactEventHeader], /) -> None
Construct from an iterable object
- append#
Append arg to the end of the list.
- clear#
Remove all items from list.
- extend#
Extend self by appending elements from arg.
- insert#
Insert object arg1 before index arg0.
- pop#
Remove and return item at index (default last).
- class isaacsim.physics.registration.ContactEventType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumLifecycle states reported for a contact pair.
- CONTACT_FOUND = 0#
- CONTACT_LOST = 1#
- CONTACT_PERSIST = 2#
- class isaacsim.physics.registration.DType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumElement types supported by the tensor API.
- BOOL = 11#
- FLOAT32 = 1#
- FLOAT64 = 2#
- INT16 = 4#
- INT32 = 5#
- INT64 = 6#
- INT8 = 3#
- UINT16 = 8#
- UINT32 = 9#
- UINT64 = 10#
- UINT8 = 7#
- UNKNOWN = 0#
- class isaacsim.physics.registration.DeviceKind(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumDevice-placement requirements for a tensor implementation.
- CPU = 0#
- ENGINE_DEFAULT = 2#
- GPU = 1#
- class isaacsim.physics.registration.DofDriveType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumDegree-of-freedom drive types.
- Acceleration = 2#
- Force = 1#
- None_ = 0#
- class isaacsim.physics.registration.DofMotion(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumDegree-of-freedom motion constraints.
- Free = 1#
- Invalid = 0#
- Limited = 2#
- Locked = 3#
- class isaacsim.physics.registration.DofType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumDegree-of-freedom types.
- Invalid = 0#
- Rotation = 1#
- Translation = 2#
- class isaacsim.physics.registration.Float3(self)#
- class isaacsim.physics.registration.Float3(self, x: float, y: float, z: float)
Bases:
objectStore a three-component floating-point value.
Overloaded function.
__init__(self) -> None
Create a value initialized to zero.
__init__(self, x: float, y: float, z: float) -> None
Create a value from its three components.
- property x#
First component.
- property y#
Second component.
- property z#
Third component.
- class isaacsim.physics.registration.Float4(self)#
- class isaacsim.physics.registration.Float4(self, x: float, y: float, z: float, w: float)
Bases:
objectStore a four-component floating-point value.
Overloaded function.
__init__(self) -> None
Create a value initialized to zero.
__init__(self, x: float, y: float, z: float, w: float) -> None
Create a value from its four components.
- property w#
Fourth component.
- property x#
First component.
- property y#
Second component.
- property z#
Third component.
- class isaacsim.physics.registration.ForceMode(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumModes used when applying forces to physics objects.
- ACCELERATION = 3#
- FORCE = 0#
- IMPULSE = 1#
- VELOCITY_CHANGE = 2#
- class isaacsim.physics.registration.FrictionAnchor(self)#
Bases:
objectDescribe one friction anchor.
Create empty friction-anchor data.
- property impulse#
Friction impulse at the anchor.
- property position#
World-space anchor position.
- class isaacsim.physics.registration.FrictionAnchorsDataVector(self)#
- class isaacsim.physics.registration.FrictionAnchorsDataVector( )
- class isaacsim.physics.registration.FrictionAnchorsDataVector(
- self,
- arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.FrictionAnchor],
- /,
Bases:
objectMutable sequence of friction anchors.
Overloaded function.
__init__(self) -> None
Default constructor
__init__(self, arg: isaacsim.physics.registration.bindings._bindings.FrictionAnchorsDataVector) -> None
Copy constructor
__init__(self, arg: collections.abc.Iterable[isaacsim.physics.registration.bindings._bindings.FrictionAnchor], /) -> None
Construct from an iterable object
- append#
Append arg to the end of the list.
- clear#
Remove all items from list.
- extend#
Extend self by appending elements from arg.
- insert#
Insert object arg1 before index arg0.
- pop#
Remove and return item at index (default last).
- class isaacsim.physics.registration.ImplKind(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumOperation kinds implemented by an entity view.
- Get = 0#
- Set = 1#
- class isaacsim.physics.registration.InteractionFns(self)#
Bases:
objectCallbacks that implement interactive physics tools.
Create an empty interaction callback collection.
- property get_prim_debug_data#
Callback that returns debug data for a prim.
- property handle_raycast#
Callback that handles an interactive raycast request.
- class isaacsim.physics.registration.JointType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumJoint types.
- Fixed = 1#
- Invalid = 0#
- Prismatic = 3#
- Revolute = 2#
- Spherical = 4#
- class isaacsim.physics.registration.ObjectType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumObject types in the physics scene.
- Articulation = 2#
- ArticulationJoint = 5#
- ArticulationLink = 3#
- ArticulationRootLink = 4#
- Invalid = 0#
- RigidBody = 1#
- class isaacsim.physics.registration.OverlapHit(self)#
Bases:
SceneQueryHitObjectDescribe an overlap query result.
Create an empty overlap hit.
- class isaacsim.physics.registration.PhysicsProfileStats(self)#
Bases:
objectTiming data for one physics profiling zone.
Create empty profiling statistics.
- property ms#
Time in milliseconds for this zone.
- property zone_name#
Name of the profiling zone.
- class isaacsim.physics.registration.PhysicsStepContext(self)#
Bases:
objectIdentify the scene and simulation for a step callback.
Create an empty step context.
- property scene_path#
Path of the simulated physics scene.
- property simulation_id#
Identifier of the simulation backend.
- class isaacsim.physics.registration.RaycastHit(self)#
Bases:
SceneQueryHitLocationDescribe a raycast query result.
Create an empty raycast hit.
- class isaacsim.physics.registration.SceneQueryFns(self)#
Bases:
objectCallbacks that implement physics scene queries.
Create an empty scene-query callback collection.
- property overlap_box#
Callback that returns overlapping shapes for a box.
- property overlap_box_any#
Callback that reports whether a box overlaps a shape.
- property overlap_shape#
Callback that returns shapes overlapping a stage shape.
- property overlap_shape_any#
Callback that reports whether a stage shape overlaps another shape.
- property overlap_sphere#
Callback that returns overlapping shapes for a sphere.
- property overlap_sphere_any#
Callback that reports whether a sphere overlaps a shape.
- property raycast_all#
Callback that returns every raycast hit.
- property raycast_any#
Callback that reports whether a raycast hits.
- property raycast_closest#
Callback that returns the closest raycast hit.
- property sweep_box_all#
Callback that returns every box-sweep hit.
- property sweep_box_any#
Callback that reports whether a box sweep hits.
- property sweep_box_closest#
Callback that returns the closest box-sweep hit.
- property sweep_shape_all#
Callback that returns every shape-sweep hit.
- property sweep_shape_any#
Callback that reports whether a shape sweep hits.
- property sweep_shape_closest#
Callback that returns the closest shape-sweep hit.
- property sweep_sphere_all#
Callback that returns every sphere-sweep hit.
- property sweep_sphere_any#
Callback that reports whether a sphere sweep hits.
- property sweep_sphere_closest#
Callback that returns the closest sphere-sweep hit.
- class isaacsim.physics.registration.SceneQueryHitLocation(self)#
Bases:
SceneQueryHitObjectDescribe the location and material of a scene-query hit.
Create an empty located scene-query hit.
- property distance#
Distance from the query origin.
- property face_index#
Index of the hit mesh face.
- property material#
Path of the hit physics material.
- property normal#
Surface normal at the hit.
- property position#
World-space hit position.
- class isaacsim.physics.registration.SceneQueryHitObject(self)#
Bases:
objectIdentify the objects reported by a scene query.
Create an empty scene-query object hit.
- property collision#
Path of the hit collision shape.
- property proto_index#
Prototype index for an instanced hit.
- property rigid_body#
Path of the hit rigid body.
- class isaacsim.physics.registration.Simulation(self)#
Bases:
objectGroup the callback collections registered by a physics engine.
Create an empty physics simulation registration.
- property benchmark_fns#
Physics profiling callbacks.
- property interaction_fns#
Interactive physics callbacks.
- property scene_query_fns#
Physics scene-query callbacks.
- property simulation_fns#
Simulation lifecycle callbacks.
- class isaacsim.physics.registration.SimulationFns(self)#
Bases:
objectCallbacks that implement a physics simulation backend.
Create an empty simulation callback collection.
- property check_results#
Callback that reports whether simulation results are ready.
- property close#
Callback that closes simulation resources.
- property fetch_results#
Callback that waits for and applies simulation results.
- property flush_changes#
Callback that flushes pending stage changes to simulation.
- property get_attached_stage#
Callback that returns the attached stage identifier.
- property get_simulation_step_count#
Callback that returns the current simulation step count.
- property get_simulation_time_steps_per_second#
Callback that returns the configured simulation frequency.
- property get_simulation_timestamp#
Callback that returns the current simulation timestamp.
- property has_attached_stage#
Callback that reports whether a stage is attached.
- property initialize#
Callback that initializes a simulation against an OVStage instance.
- property is_capable_of_simulating#
Callback that reports support for stage schema types.
- property is_change_tracking_paused#
Callback that reports whether stage-change tracking is paused.
- property pause_change_tracking#
Callback that pauses or resumes stage-change tracking.
- property publish_transforms_to_stage#
Callback that publishes simulated transforms to the stage.
- property simulate#
Callback that starts a simulation step.
- property simulate_async#
Callback that starts an asynchronous simulation step.
- property subscribe_physics_contact_report_events#
Callback that subscribes to physics contact-report events.
- property subscribe_physics_on_step_events#
Callback that subscribes to simulation step events.
- property unsubscribe_physics_contact_report_events#
Callback that unsubscribes from physics contact-report events.
- property unsubscribe_physics_on_step_events#
Callback that unsubscribes from simulation step events.
- class isaacsim.physics.registration.SimulationId(self)#
- class isaacsim.physics.registration.SimulationId(self, id: int)
Bases:
objectA unique identifier for a physics simulation instance.
Overloaded function.
__init__(self) -> None
Create an invalid simulation identifier.
__init__(self, id: int) -> None
Create an identifier from an integer value.
- property id#
Integer identifier value.
- class isaacsim.physics.registration.SimulationRegistryEventType(
- value,
- names=<not given>,
- *values,
- module=None,
- qualname=None,
- type=None,
- start=1,
- boundary=None,
Bases:
EnumChanges reported by the simulation registry.
- SIMULATION_ACTIVATED = 2#
- SIMULATION_DEACTIVATED = 3#
- SIMULATION_REGISTERED = 0#
- SIMULATION_UNREGISTERED = 1#
- class isaacsim.physics.registration.Subscription#
Bases:
objectHandle returned by subscribe_* methods; unsubscribes automatically when the handle is destroyed or when .unsubscribe() is called.
- property id#
Underlying SubscriptionId, or k_invalid_subscription_id if released.
- unsubscribe#
Unsubscribe immediately. Idempotent.
- property valid#
Whether the subscription remains active.
- class isaacsim.physics.registration.SweepHit(self)#
Bases:
SceneQueryHitLocationDescribe a shape-sweep query result.
Create an empty shape-sweep hit.
- class isaacsim.physics.registration.TensorDesc(self)#
- class isaacsim.physics.registration.TensorDesc(self, array: ndarray[])
Bases:
objectDescribe a tensor buffer and retain its backing storage.
Overloaded function.
__init__(self) -> None
Create an empty tensor descriptor.
__init__(self, array: ndarray[]) -> None
Create a descriptor that keeps the source array alive.
- property device#
Device kind containing the tensor buffer.
- property device_ordinal#
Ordinal of the device containing the tensor buffer.
- property dtype#
Tensor element type.
- property is_empty#
Whether the descriptor has no tensor buffer.
- property num_elements#
Total number of tensor elements.
- property shape#
Tensor dimensions.
- property strides#
Tensor strides measured in elements.
- to_array#
Return an array view of the tensor buffer, or None when empty.
- class isaacsim.physics.registration.TensorRegistry#
Bases:
objectProcess-wide registry that maps (engine, entity-name) to view factories.
- clear_for_testing#
Remove all registered tensor factories.
- has_entity#
Return whether an engine has an entity-view factory.
- instance = <nanobind.nb_func object>#
- list_engines#
Return the names of the declared physics engines.
- list_entities#
Return the entity-view types registered for an engine.
- list_simulations#
Return the simulation names that have registered factories, which is what create_entity accepts.
- register_engine#
Declare that a physics engine is available. The declaration lasts for the life of the process; it describes what can be simulated, not what is being simulated.
- register_entity#
Register an entity-view factory for an engine.
- unregister_entity#
Unregister an entity-view factory.
- class isaacsim.physics.registration.TensorSpec(self)#
- class isaacsim.physics.registration.TensorSpec(
- self,
- dtype: isaacsim.physics.registration.bindings._bindings.DType = DType.FLOAT32,
- shape_hint: collections.abc.Sequence[int] = [],
- device_kind: isaacsim.physics.registration.bindings._bindings.DeviceKind = DeviceKind.ENGINE_DEFAULT,
- supports: bool = True,
- supports_indexed_read: bool = False,
- supports_indexed_write: bool = False,
- supports_masked_write: bool = False,
Bases:
objectDescribe a tensor operation’s shape, type, placement, and capabilities.
Overloaded function.
__init__(self) -> None
Create a tensor specification with default capabilities.
__init__(self, dtype: isaacsim.physics.registration.bindings._bindings.DType = DType.FLOAT32, shape_hint: collections.abc.Sequence[int] = [], device_kind: isaacsim.physics.registration.bindings._bindings.DeviceKind = DeviceKind.ENGINE_DEFAULT, supports: bool = True, supports_indexed_read: bool = False, supports_indexed_write: bool = False, supports_masked_write: bool = False) -> None
Create a tensor specification from capability fields.
- property device_kind#
Required tensor device placement.
- property dtype#
Required tensor element type.
- property requires_host_data#
Whether write data must be available in host memory.
- property shape_hint#
Expected tensor dimensions, excluding the view dimension.
- property supports#
Whether the operation is supported.
- property supports_indexed_read#
Whether the operation supports indexed reads.
- property supports_indexed_write#
Whether the operation supports indexed writes.
- property supports_masked_write#
Whether the operation supports masked writes.