overlapShape#

Fully qualified name: isaacsim::physics::manager::overlapShape

uint32_t isaacsim::physics::manager::overlapShape(
registration::PathToken geometryPrimitivePath,
registration::OverlapHitReportFunction reportFunction,
)#

Reports objects that overlap a USD geometric primitive.

Note

A backend may use and cache a convex approximation for a mesh query shape. This behavior is backend-specific.

Note

Exceptions that escape a backend query callback propagate to the caller and prevent dispatch to later backends.

Parameters:
  • geometryPrimitivePath – [in] Encoded USD path of the UsdGeomGPrim used as the query shape.

  • reportFunction – [in] Callback invoked for each overlap. Returning true continues the current backend’s traversal; returning false stops it.

Returns:

Sum of the overlap counts returned by all active physics backends. This value may exceed the number of reportFunction invocations, including when the callback stops a backend’s traversal early.