Regular API function

simHandleDistance / sim.handleDistance

Description DEPRECATED. See sim.checkDistance instead.
C/C++
synopsis
simInt simHandleDistance(simInt distanceObjectHandle,simFloat* smallestDistance)
C/C++
parameters
distanceObjectHandle: handle of the distance object or sim_handle_all or sim_handle_all_except_explicit. (sim_handle_all will handle all registered distance objects, while sim_handle_all_except_explicit will only handle those that are not marked as "explicit handling")
smallestDistance: smallest measured distance. Can be nullptr
C/C++
return value
1 if at least one distance was measured, 0 if no distance was measured, -1 in case of an error
Lua synopsis int result,float smallestDistance=sim.handleDistance(int distanceObjectHandle)
Lua parameters
Similar to the C-function counterpart
Lua return values
result: 1 if at least one distance was measured, 0 if no distance was measured
smallestDistance: the smallest distance measured.