C++ guide and API reference#
Include the headers under isaacsim/physics/manager and link
isaacsim::physics-manager.
PhysicsSimulation.hpp contains simulation lifecycle and stepping operations.
PhysicsSceneQuery.hpp, PhysicsInteraction.hpp, and
PhysicsBenchmark.hpp contain their corresponding process-wide operations.
The tensors headers define the concrete manager-side tensor views.
The declarations and Doxygen comments in the public headers are the authoritative C++ reference.
API reference#
Fully qualified namespace: isaacsim::physics::manager
-
namespace manager#
Classes Summary#
- PhysicsManager
Singleton that manages physics simulations.
Enumerations Summary#
- int InitializeResult
Result of initializing all active physics backends.
- PhysicsEvent
Simulation event types.
Functions Summary#
- bool checkResults()
Collects result-readiness status from active physics backends.
- bool close()
Requests every active physics backend to close and detach its stage.
- void fetchResults()
Waits for active simulations to finish and fetches their results.
- void flushChanges()
Forces every active physics backend to process buffered scene changes.
- long getAttachedStage()
Gets the USD stage identifier reported by the first active backend that exposes the query.
- registration::DebugDataDictionary getPrimDebugData(const std::string &primPath)
Gets aggregated physics debug data for a prim.
- uint64_t getSimulationStepCount(registration::SimulationId simulationId)
Gets the physics step count reported by a simulation.
- uint32_t getSimulationTimeStepsPerSecond(registration::SimulationId simulationId, long stageId, registration::PathToken scenePath)
Gets the configured simulation frequency for a physics scene.
- uint64_t getSimulationTimestamp(registration::SimulationId simulationId)
Gets a simulation's monotonically increasing step timestamp.
- void handleRaycast(const registration::Float3 &origin, const registration::Float3 &direction, bool input)
Dispatches an interaction raycast request to every active physics backend.
- InitializeResult initialize(void *ovstage, const char *usdIdentifier)
Initializes all active physics backends from a stage.
- bool isCapableOfSimulating(registration::SimulationId simulationId, const char **schemaNames, size_t schemaNamesCount, bool *isCapable)
Queries whether a simulation supports USD schema types or applied schema APIs.
- bool isChangeTrackingPaused(registration::SimulationId simulationId)
Checks whether scene-change tracking is paused for a simulation.
- uint32_t overlapBox(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap an oriented box.
- bool overlapBoxAny(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation)
Tests whether an oriented box overlaps any object in the scene.
- uint32_t overlapShape(registration::PathToken geometryPrimitivePath, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap a USD geometric primitive.
- bool overlapShapeAny(registration::PathToken geometryPrimitivePath)
Tests whether a USD geometric primitive overlaps any object in the scene.
- uint32_t overlapSphere(float radius, const isaacsim::physics::registration::Float3 &position, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap a sphere.
- bool overlapSphereAny(float radius, const isaacsim::physics::registration::Float3 &position)
Tests whether a sphere overlaps any object in the scene.
- void pauseChangeTracking(bool pause)
Pauses or resumes scene-change tracking for every active physics backend.
- bool publishTransformsToStage()
Publishes the latest simulated transforms to the stages attached to active physics backends.
- void raycastAll(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::RaycastHitReportFunction reportFunction, bool bothSides)
Reports raycast hits from all active physics backends.
- bool raycastAny(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a ray hits any object in an active physics backend.
- bool raycastClosest(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::RaycastHit &hit, bool bothSides)
Finds the closest raycast hit across all active physics backends.
- void simulate(float elapsedTime, float currentTime)
Runs a synchronous simulation step on every active physics backend.
- void simulateAsynchronously(float elapsedTime, float currentTime)
Starts an asynchronous simulation step on every active physics backend.
- registration::SubscriptionId subscribePhysicsContactReportEvents(registration::OnContactReportEventFunction onEvent)
Subscribes to contact-report events from physics backends.
- registration::SubscriptionId subscribePhysicsOnStepEvents(bool preStep, int order, registration::OnPhysicsStepEventFunction onUpdate)
Subscribes to events before or after each physics step.
- registration::SubscriptionId subscribeProfileStatisticsEvents(registration::ProfileStatisticsNotificationFunction onEvent)
Subscribes to physics simulation profiling events.
- void sweepBoxAll(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping an oriented box through the scene.
- bool sweepBoxAny(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept oriented box encounters any object in the scene.
- bool sweepBoxClosest(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping an oriented box through the scene.
- void sweepShapeAll(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping a USD geometric primitive through the scene.
- bool sweepShapeAny(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept USD geometric primitive encounters any object in the scene.
- bool sweepShapeClosest(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping a USD geometric primitive through the scene.
- void sweepSphereAll(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping a sphere through the scene.
- bool sweepSphereAny(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept sphere encounters any object in the scene.
- bool sweepSphereClosest(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping a sphere through the scene.
- void unsubscribePhysicsContactReportEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics contact-report events.
- void unsubscribePhysicsOnStepEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics step events.
- void unsubscribeProfileStatisticsEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics simulation profiling events.
Typedefs Summary#
- SimulationEventFunction
Callback signature receiving a dictionary of named event payload values.
- SimulationEventPayload
Variant value type used to deliver simulation event payload entries.