overlapBox#

Fully qualified name: isaacsim::physics::manager::overlapBox

uint32_t isaacsim::physics::manager::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.

Note

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

Parameters:
  • halfExtent – [in] Box half-extents in scene length units. Each component must be nonnegative.

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

  • rotation – [in] Box orientation as an (x, y, z, w) quaternion.

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