Regular API function

simSetObjectPosition / sim.setObjectPosition

Description Sets the position (x, y and z-coordinates) of an object. Dynamically simulated objects will implicitely be reset before the command is applied (i.e. similar to calling sim.resetDynamicObject just before). See also the other matrix/transformation functions.
C synopsis simInt simSetObjectPosition(simInt objectHandle,simInt relativeToObjectHandle,const simFloat* position)
C parameters
objectHandle: handle of the object. Can be combined with sim.handleflag_reljointbaseframe (see next argument)
relativeToObjectHandle: indicates relative to which reference frame the position is specified. Specify -1 to set the absolute position, sim_handle_parent to set the position relative to the object's parent, or an object handle relative to whose reference frame the position is specified. If this handle is the handle of a joint, then the position is applied relative to the joint's moving frame (unless objectHandle is combined with sim.handleflag_reljointbaseframe, in which case the position is applied relative to the joint's base frame).
position: coordinates of the object (x, y and z)
C return value
-1 if operation was not successful
Lua synopsis sim.setObjectPosition(int objectHandle,int relativeToObjectHandle,table[3] position)
Lua parameters
Similar to the C-function counterpart
Lua return values
none
Remote API equiv.
Legacy remote API: simxSetObjectPosition