Regular API function

simGetPathLength

Description Retrieves the length of a path object. The length is given in meters, but the actual returned length is dependent on the selected path length calculation method for the given path object. See also simGetPathPosition and simSetPathPosition.
C synopsis simInt simGetPathLength(simInt objectHandle,simFloat* length)
C parameters
objectHandle: handle of the path object
length: length of 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 length=simGetPathLength(number objectHandle)
Lua parameters
objectHandle: handle of the path object
Lua return values
length: length of the path given in meters (but dependent on the selected path length calculation method), or nil in case of an error

All regular API functions on one page