overlapSphere#

Fully qualified name: isaacsim::physics::manager::overlapSphere

uint32_t isaacsim::physics::manager::overlapSphere(
float radius,
const isaacsim::physics::registration::Float3 &position,
registration::OverlapHitReportFunction reportFunction,
)#

Reports objects that overlap a sphere.

Note

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

Parameters:
  • radius – [in] Sphere radius in scene length units. Must be nonnegative.

  • position – [in] Sphere-center position in world coordinates.

  • 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.