Regular API function list (alphabetical order)

The list of API functions below allows you to access many V-REP parameters. There are however too many parameters in V-REP to have a specific API function for each one of them. Auxiliary parameters can be accessed via a set of given functions that use object parameter IDs. Refer also to the global parameter IDs.

simAddBanner
simAddDrawingObject
simAddDrawingObjectItem
simAddForce
simAddForceAndTorque
simAddModuleMenuEntry
simAddObjectCustomData
simAddObjectToSelection
simAddParticleObject
simAddParticleObjectItem
simAddSceneCustomData
simAddScript
simAddStatusbarMessage
simAdjustRealTimeTimer
simAdjustView
simAdvanceSimulationByOneStep
simAnnounceSceneContentChange
simApplyMilling
simAssociateScriptWithObject
simAuxiliaryConsoleClose
simAuxiliaryConsoleOpen
simAuxiliaryConsolePrint
simAuxiliaryConsoleShow
simBoolAnd16
simBoolOr16
simBoolXor16
simBreakForceSensor
simBroadcastMessage
simBuildIdentityMatrix
simBuildMatrix
simBuildMatrixQ
simCameraFitToView
simCheckCollision
simCheckCollisionEx
simCheckDistance
simCheckProximitySensor
simCheckProximitySensorEx
simCheckProximitySensorEx2
simCheckVisionSensor
simCheckVisionSensorEx
simClearFloatSignal
simClearIntegerSignal
simClearStringSignal
simCloseModule
simCloseScene
simConvexDecompose
simCopyMatrix
simCopyPasteSelectedObjects
simCreateBuffer
simCreateDummy
simCreateForceSensor
simCreateHeightfieldShape
simCreateJoint
simCreateMeshShape
simCreatePath
simCreateProximitySensor
simCreatePureShape
simCreateUI
simCreateUIButton
simCreateUIButtonArray
simCreateVisionSensor
simCutPathCtrlPoints
simDelegateChildScriptExecution
simDeleteSelectedObjects
simDeleteUIButtonArray
simDisplayDialog
simDoesFileExist
simEnableWorkThreads
simEndDialog
simExportMesh
simFileDialog
simFloatingViewAdd
simFloatingViewRemove
simFollowPath
simGetArrayParameter
simGetBooleanParameter
simGetClosestPositionOnPath
simGetCollectionHandle
simGetCollectionName
simGetCollisionHandle
simGetConfigurationTree
simGetContactInfo
simGetDialogInput
simGetDialogResult
simGetDistanceHandle
simGetEulerAnglesFromMatrix
simGetExplicitHandling
simGetFloatingParameter
simGetFloatSignal
simGetIkGroupHandle
simGetIntegerParameter
simGetIntegerSignal
simGetInvertedMatrix
simGetJointInterval
simGetJointMatrix
simGetJointMode
simGetJointPosition
simGetJointTargetPosition
simGetJointTargetVelocity
simGetJointType
simGetLastError
simGetLightParameters
simGetLinkDummy
simGetMainWindow
simGetMechanismHandle
simGetModelProperty
simGetModuleName
simGetNameSuffix
simGetNavigationMode
simGetObjectAssociatedWithScript
simGetObjectConfiguration
simGetObjectChild
simGetObjectCustomData
simGetObjectCustomDataLength
simGetObjectFloatParameter
simGetObjectHandle
simGetObjectIntParameter
simGetObjectLastSelection
simGetObjectMatrix
simGetObjectName
simGetObjectOrientation
simGetObjectParent
simGetObjectPosition
simGetObjectProperty
simGetObjectQuaternion
simGetObjects
simGetObjectSelection
simGetObjectSelectionSize
simGetObjectSizeFactor
simGetObjectSpecialProperty
simGetObjectStringParameter
simGetObjectType
simGetObjectUniqueIdentifier
simGetObjectVelocity
simGetOrientationOnPath
simGetPage
simGetPathLength
simGetPathPlanningHandle
simGetPathPosition
simGetPositionOnPath
simGetQuaternionFromMatrix
simGetRealTimeSimulation
simGetRotationAxis
simGetSceneCustomData
simGetSceneCustomDataLength
simGetScript
simGetScriptAssociatedWithObject
simGetScriptExecutionCount
simGetScriptHandle
simGetScriptName
simGetScriptProperty
simGetScriptRawBuffer
simGetScriptSimulationParameter
simGetScriptText
simGetShapeColor
simGetShapeMassAndInertia
simGetShapeMesh
simGetSignalName
simGetSimulationPassesPerRenderingPass
simGetSimulationState
simGetSimulationTime
simGetSimulationTimeStep
simGetSimulatorMessage
simGetStringParameter
simGetStringSignal
simGetSystemTime
simGetSystemTimeInMilliseconds
simGetUIButtonLabel
simGetUIButtonProperty
simGetUIButtonSize
simGetUIEventButton
simGetUIHandle
simGetUIPosition
simGetUIProperty
simGetUISlider
simGetVelocity
simGetVisionSensorDepthBuffer
simGetVisionSensorImage
simGetVisionSensorResolution
simGroupShapes
simHandleChildScript
simHandleCollision
simHandleDistance
simHandleDynamics
simHandleGraph
simHandleJoint
simHandleIkGroup
simHandleMainScript
simHandleMechanism
simHandleMill
simHandleModule
simHandlePath
simHandleProximitySensor
simHandleSensingChildScripts
simHandleVarious
simHandleVisionSensor
simImportMesh
simImportShape
simInitializePathSearch
simInsertPathCtrlPoints
simInterpolateMatrices
simInvertMatrix
simIsHandleValid
simIsObjectInSelection
simIsRealTimeSimulationStepNeeded
simIsScriptExecutionThreaded
simIsScriptRunningInThread
simJointGetForce
simLaunchExecutable
simLoadModel
simLoadModule
simLoadScene
simLoadUI
simLockInterface
simMoveToObject
simMsgBox
simMultiplyMatrices
simMultiplyVector
simOpenModule
simPackFloats
simPackInts
simPauseSimulation
simPerformPathSearchStep
simPersistentDataRead
simPersistentDataWrite
simReadCollision
simReadDistance
simReadForceSensor
simReadProximitySensor
simReadVisionSensor
simReceiveData
simRefreshDialogs
simRegisterContactCallback
simRegisterCustomLuaFunction
simRegisterCustomLuaVariable
simReleaseBuffer
simReleaseScriptRawBuffer
simRemoveBanner
simRemoveCollection
simRemoveDrawingObject
simRemoveObject
simRemoveObjectFromSelection
simRemoveParticleObject
simRemoveScript
simRemoveUI
simResetCollision
simResetDistance
simResetDynamicObject
simResetGraph
simResetJoint
simResetMill
simResetMilling
simResetPath
simResetProximitySensor
simResetScript
simResetVisionSensor
simResumeThreads
simRMLMoveToJointPositions
simRMLPosition
simRMLVelocity
simRotateAroundAxis
simRunSimulator
simSaveModel
simSaveScene
simSaveUI
simScaleSelectedObjects
simSearchPath
simSendData
simSendModuleMessage
simSerialCheck
simSerialClose
simSerialOpen
simSerialRead
simSerialSend
simSetArrayParameter
simSetBooleanParameter
simSetCollectionName
simSetConfigurationTree
simSetExplicitHandling
simSetFloatingParameter
simSetFloatSignal
simSetGraphUserData
simSetIkElementProperties
simSetIkGroupProperties
simSetIntegerParameter
simSetIntegerSignal
simSetJointForce
simSetJointInterval
simSetJointMode
simSetJointPosition
simSetJointTargetPosition
simSetJointTargetVelocity
simSetLastError
simSetLightParameters
simSetLinkDummy
simSetModelProperty
simSetModuleMenuItemState
simSetNameSuffix
simSetNavigationMode
simSetObjectConfiguration
simSetObjectFloatParameter
simSetObjectIntParameter
simSetObjectMatrix
simSetObjectName
simSetObjectOrientation
simSetObjectParent
simSetObjectPosition
simSetObjectProperty
simSetObjectQuaternion
simSetObjectSpecialProperty
simSetObjectStringParameter
simSetPage
simSetPathPosition
simSetPathTargetNominalVelocity
simSetScriptRawBuffer
simSetScriptSimulationParameter
simSetScriptText
simSetShapeColor
simSetShapeMassAndInertia
simSetSimulationPassesPerRenderingPass
simSetSphericalJointMatrix
simSetStringParameter
simSetStringSignal
simSetThreadAutomaticSwitch
simSetThreadIsFree
simSetThreadResumeLocation
simSetThreadSwitchTiming
simSetUIButtonArrayColor
simSetUIButtonColor
simSetUIButtonLabel
simSetUIPosition
simSetUIButtonProperty
simSetUIButtonTexture
simSetUIProperty
simSetUISlider
simSetVisionSensorImage
simStartSimulation
simStopSimulation
simSwitchThread
simTransformVector
simTubeClose
simTubeOpen
simTubeRead
simTubeStatus
simTubeWrite
simUngroupShape
simUnloadModule
simUnpackFloats
simUnpackInts
simWait
simWaitForSignal
simWaitForWorkThreads


Following are additional API functions, only available from the C/C++ interface, that extend functionality and allow faster data access. They however do not perform input data checking, so use them wisely. Refer to the source code for details.

_simAddForceSensorCumulativeForcesAndTorques
_simAddJointCumulativeForcesOrTorques
_simClearAdditionalForceAndTorque
_simDisableDynamicTreeForManipulation
_simDoEntitiesCollide
_simGetAdditionalForceAndTorque
_simGetAllGeometrics
_simGetBulletCollisionMargin
_simGetBulletRestitution
_simGetBulletStickyContact
_simGetContactCallback
_simGetContactCallbackCount
_simGetCumulativeMeshes
_simGetDamping
_simGetDistanceBetweenEntitiesIfSmaller
_simGetDummyLinkType
_simGetDynamicCollisionMask
_simGetDynamicForceSensorLocalTransformationPart2
_simGetDynamicMotorMaxForce
_simGetDynamicMotorTargetPosition
_simGetDynamicMotorTargetVelocity
_simGetDynamicMotorUpperLimitVelocity
_simGetDynamicsFullRefreshFlag
_simGetFriction
_simGetGeometricCount
_simGetGeomProxyDynamicsFullRefreshFlag
_simGetGeomProxyFromShape
_simGetGeomWrapFromGeomProxy
_simGetGravity
_simGetHeightfieldData
_simGetInitialDynamicAngVelocity
_simGetInitialDynamicVelocity
_simGetJointBulletParameters
_simGetJointMode
_simGetJointOdeParameters
_simGetJointPosition
_simGetJointPositionInterval
_simGetJointType
_simGetLastParentForLocalGlobalCollidable
_simGetLocalInertiaFrame
_simGetMass
_simGetMotorPid
_simGetObject
_simGetObjectChildren
_simGetObjectCumulativeTransformation
_simGetObjectFromIndex
_simGetObjectID
_simGetObjectListSize
_simGetObjectLocalTransformation
_simGetObjectType
_simGetOdeMaxContactFrictionCFMandERP
_simGetParentFollowsDynamic
_simGetParentObject
_simGetPrincipalMomentOfInertia
_simGetPurePrimitiveSizes
_simGetPurePrimitiveType
_simGetShapeIsStaticAndNotRespondableButDynamicTag
_simGetStartSleeping
_simGetTimeDiffInMs
_simGetTreeDynamicProperty
_simGetVerticesLocalFrame
_simGetWasPutToSleepOnce
_simIsDynamicMotorEnabled
_simIsDynamicMotorPositionCtrlEnabled
_simIsDynamicMotorTorqueModulationEnabled
_simIsForceSensorBroken
_simIsGeomWrapConvex
_simIsGeomWrapGeometric
_simIsJointInHybridOperation
_simIsShapeDynamicallyRespondable
_simIsShapeDynamicallyStatic
_simMakeDynamicAnnouncement
_simSetDynamicForceSensorLocalTransformationPart2
_simSetDynamicForceSensorLocalTransformationPart2IsValid
_simSetDynamicJointLocalTransformationPart2
_simSetDynamicJointLocalTransformationPart2IsValid
_simSetDynamicMotorPositionControlTargetPosition
_simSetDynamicMotorReflectedPositionFromDynamicEngine
_simSetDynamicObjectFlagForVisualization
_simSetDynamicsFullRefreshFlag
_simSetDynamicSimulationIconCode
_simSetGeomProxyDynamicsFullRefreshFlag
_simSetInitialDynamicAngVelocity
_simSetInitialDynamicVelocity
_simSetJointPosition
_simSetJointSphericalTransformation
_simSetObjectCumulativeTransformation
_simSetObjectLocalTransformation
_simSetShapeDynamicVelocity
_simSetShapeIsStaticAndNotRespondableButDynamicTag

Recommended topics

  • Regular API function list (by category)
  • API constants
  • Object parameter IDs