Regular API function

simSearchPath (DEPRECATED)

Description DEPRECATED. See the OMPL library based path/motion planning functionality instead.

Searches for a path. A registered path planning object is required (path planning objects can be registered in the scene editor). When called from C or from a non-threaded script, then this function will be blocking. When called from a threaded child script, this function is still blocking, but will switch to other threads at the specified time interval (subTimeStep). See also simGetPathPlanningHandle, simInitializePathSearch and simPerformPathSearchStep.
C synopsis simInt simSearchPath(simInt pathPlanningObjectHandle,simFloat maxSearchTime)
C parameters
pathPlanningObjectHandle: handle of the path planning object
maxSearchTime: maximum search time in seconds
C return value
-1 if operation was not successful (error), 0 if no path was found, 1 if a partial path was found or 2 if a full path was found (check the path planning task settings dialog)
Lua synopsis number result=simSearchPath(number pathPlanningObjectHandle,number maxSearchTime,subTimeStep)
Lua parameters
pathPlanningObjectHandle: handle of the path planning object
maxSearchTime: maximum search time in seconds
subTimeStep: the delay after which the thread will switch to other threads (meaningful only for threaded child scripts). Can be nil or ignored, in which case a default value of 0.05 is used.
Lua return values
-1 if operation was not successful (error), 0 if no path was found, 1 if a partial path was found or 2 if a full path was found (check the path planning task settings dialog)

All regular API functions on one page