C++ guide and API reference#

Include the headers under isaacsim/physics/registration and link isaacsim::physics-registration.

The free functions in Physics.hpp register, inspect, activate, and remove simulation implementations. The interfaces under simulator define the callback contracts implemented by an engine. The headers under tensors define tensor metadata and tensor factory registration.

The declarations and Doxygen comments in the public headers are the authoritative C++ reference.

API reference#

Fully qualified namespace: isaacsim::physics::registration

namespace registration#

Classes Summary#

PathToken

Strong type for a USD path encoded as an unsigned 64-bit value.

PathTokenHash

Hash function object for PathToken .

SimulationId

Strong identifier for a registered physics simulation.

SimulationIdHash

Hash function object for SimulationId .

SubscriptionId

Strong identifier for an event subscription.

SubscriptionIdHash

Hash function object for SubscriptionId .

Enumerations Summary#

uint32_t ContactEventType

Types of reported contact-pair events.

int DebugDataItemType

Identifies the value stored in a DebugDataItem .

uint32_t ForceModeType

Specifies how a force-like value affects a body.

uint32_t SimulationRegistryEventType

Types of events emitted by the simulation registry.

Functions Summary#

void activateSimulation(const SimulationId &simulationId)

Activates a registered simulation.

void deactivateSimulation(const SimulationId &simulationId)

Deactivates a registered simulation.

SimulationId getActiveSimulationId(const std::string &simulationName)

Retrieves the active simulation registered under a given name.

const Simulation * getSimulation(const SimulationId &simulationId)

Retrieves a registered simulation.

size_t getSimulationCount()

Returns the number of registered simulations.

size_t getSimulationIds(SimulationId *simulationIds, size_t bufferSize)

Copies registered simulation identifiers into a caller-provided buffer.

std::string getSimulationName(const SimulationId &simulationId)

Retrieves the name of a registered simulation.

bool isSimulationActive(const SimulationId &simulationId)

Reports whether a registered simulation is active.

DebugDataItem makeDebugDataBoolean(const std::string &description, bool value)

Creates a Boolean debug-data item.

DebugDataItem makeDebugDataDouble(const std::string &description, double value)

Creates a double-precision debug-data item.

DebugDataItem makeDebugDataFloat(const std::string &description, float value)

Creates a single-precision debug-data item.

DebugDataItem makeDebugDataInteger(const std::string &description, int32_t value)

Creates an integer debug-data item.

DebugDataItem makeDebugDataPoint(const std::string &description, const Double3 &value)

Creates a double-precision three-dimensional point debug-data item.

DebugDataItem makeDebugDataPoint(const std::string &description, const Float3 &value)

Creates a single-precision three-dimensional point debug-data item.

DebugDataItem makeDebugDataQuaternion(const std::string &description, const Double4 &value)

Creates a double-precision quaternion debug-data item.

DebugDataItem makeDebugDataQuaternion(const std::string &description, const Float4 &value)

Creates a single-precision quaternion debug-data item.

DebugDataItem makeDebugDataString(const std::string &description, const std::string &value)

Creates a string debug-data item.

DebugDataItem makeDebugDataVector(const std::string &description, const Float3 &value)

Creates a single-precision three-dimensional vector debug-data item.

DebugDataItem makeDebugDataVector(const std::string &description, const Double3 &value)

Creates a double-precision three-dimensional vector debug-data item.

SimulationId registerSimulation(const Simulation &simulation, const std::string &simulationName)

Registers a simulation with the physics system.

SubscriptionId subscribeSimulationRegistryEvents(OnSimulationRegistryEventFunction onEvent, void *userData=nullptr)

Subscribes to simulation registry events.

void unregisterSimulation(const SimulationId &simulationId)

Unregisters a simulation from the physics system.

void unsubscribeSimulationRegistryEvents(SubscriptionId subscriptionId)

Unsubscribes from simulation registry events.

Structs Summary#

BenchmarkFunctions

Function table for physics profiling operations.

ContactData

Describes one contact point in a contact pair.

ContactEventHeader

Describes one contact-pair event and its associated data ranges.

DebugDataItem

Describes one debug-data entry produced by GetPrimDebugDataFunction .

Double3

Three-component vector of double-precision floating-point values.

Double4

Four-component vector of double-precision floating-point values.

Float3

Three-component vector of single-precision floating-point values.

Float4

Four-component vector of single-precision floating-point values.

FrictionAnchor

Describes one friction anchor in a contact pair.

InteractionFunctions

Function table for interaction operations.

OverlapHit

Describes an overlap-query hit.

PhysicsProfileStatistics

Timing statistics for a profiled physics zone.

PhysicsStepContext

Identifies the scene and simulation associated with a physics step event.

RaycastHit

Describes a raycast-query hit.

SceneQueryFunctions

Function table for physics scene-query operations.

SceneQueryHitLocation

Describes the location and surface properties of a scene-query hit.

SceneQueryHitObject

Identifies the scene objects associated with a scene-query hit.

Simulation

Aggregates the function tables implemented by a physics simulation backend.

SimulationFunctions

Function table for simulation lifecycle, stepping, and event operations.

SweepHit

Describes a sweep-query hit.

Typedefs Summary#

AttachStageFunction

Initializes the simulation backend from caller-supplied stage inputs.

CheckResultsFunction

Queries the backend-reported readiness of the current simulation step.

ContactDataVector

Sequence of contact-point data delivered to a contact-report callback.

ContactEventHeaderVector

Sequence of contact-event headers delivered to a contact-report callback.

DebugDataDictionary

Debug-data entries keyed by their display names, such as "Position" or "Velocity".

DetachStageFunction

Detaches the currently attached stage.

FetchResultsFunction

Waits for simulation completion and fetches the resulting state.

FlushChangesFunction

Processes all buffered physics changes.

FrictionAnchorsDataVector

Sequence of friction-anchor data delivered to a contact-report callback.

GetAttachedStageFunction

Returns the StageCache identifier of the attached stage.

GetPrimDebugDataFunction

Retrieves simulation debug data for a USD prim.

GetSimulationStepCountFunction

Returns the number of physics steps performed by the active simulation.

GetSimulationTimeStepsPerSecondFunction

Returns the simulation frequency for a physics scene.

GetSimulationTimestampFunction

Returns the current simulation timestamp.

HandleRaycastFunction

Handles a raycast request from the interaction system.

HasAttachedStageFunction

Reports whether the backend currently has an attached stage.

IsCapableOfSimulatingFunction

Queries whether the simulation supports a list of USD schemas.

IsChangeTrackingPausedFunction

Reports whether physics change tracking is paused.

OnContactReportEventFunction

Callback invoked for a physics contact report.

OnPhysicsStepEventFunction

Callback invoked for a physics step event.

OnSimulationRegistryEventFunction

Callback invoked after a simulation registry event.

OverlapBoxAnyFunction

Tests whether a box overlaps any object in the physics scene.

OverlapBoxFunction

Tests a box for overlaps and reports each overlap through a callback.

OverlapHitReportFunction

Callback invoked for each overlap-query hit.

OverlapShapeAnyFunction

Tests whether a USD geometric primitive overlaps any object in the physics scene.

OverlapShapeFunction

Tests a USD geometric primitive for overlaps and reports each overlap through a callback.

OverlapSphereAnyFunction

Tests whether a sphere overlaps any object in the physics scene.

OverlapSphereFunction

Tests a sphere for overlaps and reports each overlap through a callback.

PauseChangeTrackingFunction

Pauses or resumes physics change tracking.

ProfileStatisticsNotificationFunction

Callback invoked when physics profiling statistics are available.

PublishTransformsToStageFunction

Publishes the latest simulated transforms to the attached stage.

RaycastAllFunction

Raycasts against the physics scene and reports each hit through a callback.

RaycastAnyFunction

Tests whether a ray hits any object in the physics scene.

RaycastClosestFunction

Raycasts against the physics scene and returns the closest hit.

RaycastHitReportFunction

Callback invoked for each raycast-query hit.

SimulateAsynchronouslyFunction

Starts an asynchronous physics simulation step.

SimulateFunction

Executes a synchronous physics simulation step.

SubscribePhysicsContactReportEventsFunction

Subscribes to physics contact-report events.

SubscribePhysicsOnStepEventsFunction

Subscribes to physics pre-step or post-step events.

SubscribeProfileStatisticsEventsFunction

Subscribes to physics profiling events.

SweepBoxAllFunction

Sweeps a box through the physics scene and reports each hit through a callback.

SweepBoxAnyFunction

Tests whether a swept box hits any object in the physics scene.

SweepBoxClosestFunction

Sweeps a box through the physics scene and returns the closest hit.

SweepHitReportFunction

Callback invoked for each sweep-query hit.

SweepShapeAllFunction

Sweeps a USD geometric primitive through the physics scene and reports each hit through a callback.

SweepShapeAnyFunction

Tests whether a swept USD geometric primitive hits any object in the physics scene.

SweepShapeClosestFunction

Sweeps a USD geometric primitive through the physics scene and returns the closest hit.

SweepSphereAllFunction

Sweeps a sphere through the physics scene and reports each hit through a callback.

SweepSphereAnyFunction

Tests whether a swept sphere hits any object in the physics scene.

SweepSphereClosestFunction

Sweeps a sphere through the physics scene and returns the closest hit.

UnsubscribePhysicsContactReportEventsFunction

Unsubscribes from physics contact-report events.

UnsubscribePhysicsOnStepEventsFunction

Unsubscribes from physics pre-step or post-step events.

UnsubscribeProfileStatisticsEventsFunction

Unsubscribes from physics profiling events.

Variables Summary#

const SimulationId g_kInvalidSimulationId

Sentinel value representing an invalid simulation identifier.

const SubscriptionId g_kInvalidSubscriptionId

Sentinel value representing an invalid subscription identifier.