Regular API function

simGetObjectVelocity / sim.getObjectVelocity

Description Retrieves the linear and/or angular velocity of an object, in absolute coordinates. The velocity is a measured velocity (i.e. from one simulation step to the next), and is available for all objects in the scene. See also sim.getVelocity.
C synopsis simInt simGetObjectVelocity(simInt objectHandle,simFloat* linearVelocity,simFloat* angularVelocity)
C parameters
objectHandle: handle of a scene object. It is recommended to add sim.handleflag_axis to the object handle, in order to obtain the regular angular velocity for the object, i.e. the rotation axis and the rotation velocity that is represented by the axis' length.
linearVelocity: pointer to 3 values that will receive the linear velocity. Can be NULL
angularVelocity: pointer to 3 values that will receive the angular velocity. Can be NULL
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis table_3 linearVelocity,table_3 angularVelocity=sim.getObjectVelocity(number shapeHandle)
Lua parameters
objectHandle: same as C-function
Lua return values
linearVelocity: table containing 3 values that represent the linear velocity, or nil in case of an error
angularVelocity: table containing 3 values that represent the angular velocity, or nil in case of an error
Remote API equiv.
B0-based remote API: simxGetObjectVelocity
Legacy remote API: simxGetObjectVelocity

All regular API functions on one page