Regular API function

simSetPathPosition / sim.setPathPosition

Description Sets the intrinsic position of a path object (i.e. the position along the path). The position is given in meters, but the actual position is dependent on the selected path length calculation method for the given path object.This function is the equivalent of sim.setJointPosition, but for a path object. See also sim.getPathPosition.
C synopsis simInt simSetPathPosition(simInt objectHandle,simFloat position)
C parameters
objectHandle: handle of the path object
position: linear position on the path given in meters (but dependent on the selected path length calculation method)
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=sim.setPathPosition(number objectHandle,number position)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page