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
simAddGhost
simAddModuleMenuEntry
simAddObjectToCollection
simAddObjectToSelection
simAddParticleObject
simAddParticleObjectItem
simAddScript
simAddStatusbarMessage
simAdjustRealTimeTimer
simAdjustView
simAdvanceSimulationByOneStep
simAnnounceSceneContentChange
simApplyMilling
simAssociateScriptWithObject
simAuxiliaryConsoleClose
simAuxiliaryConsoleOpen
simAuxiliaryConsolePrint
simAuxiliaryConsoleShow
simBoolAnd32
simBoolOr32
simBoolXor32
simBreakForceSensor
simBroadcastMessage
simBuildIdentityMatrix
simBuildMatrix
simBuildMatrixQ
simCallScriptFunction
simCallScriptFunctionEx
simCameraFitToView
simCheckCollision
simCheckCollisionEx
simCheckDistance
simCheckIkGroup
simCheckOctreePointOccupancy
simCheckProximitySensor
simCheckProximitySensorEx
simCheckProximitySensorEx2
simCheckVisionSensor
simCheckVisionSensorEx
simClearFloatSignal
simClearIntegerSignal
simClearStringSignal
simCloseModule
simCloseScene
simComputeJacobian
simComputeMassAndInertia
simConvexDecompose
simCopyMatrix
simCopyPasteObjects
simCopyStack
simCreateBuffer
simCreateCollection
simCreateDummy
simCreateForceSensor
simCreateHeightfieldShape
simCreateIkElement
simCreateIkGroup
simCreateJoint
simCreateMeshShape
simCreateOctree
simCreatePath
simCreatePointCloud
simCreateProximitySensor
simCreatePureShape
simCreateStack
simCreateTexture
simCreateUI
simCreateUIButton
simCreateUIButtonArray
simCreateVisionSensor
simCutPathCtrlPoints
simDebugStack
simDeleteUIButtonArray
simDisplayDialog
simDoesFileExist
simEmptyCollection
simEnableEventCallback
simEndDialog
simExportIk
simExportMesh
simFileDialog
simFloatingViewAdd
simFloatingViewRemove
simFollowPath
simGenerateIkPath
simGetArrayParameter
simGetBoolParameter
simGetClosestPositionOnPath
simGetCollectionHandle
simGetCollectionName
simGetCollectionObjects
simGetCollisionHandle
simGetConfigForTipPose
simGetConfigurationTree
simGetContactInfo
simGetCustomizationScriptAssociatedWithObject
simGetDataOnPath
simGetDecimatedMesh
simGetDialogInput
simGetDialogResult
simGetDistanceHandle
simGetEngineBoolParameter
simGetEngineFloatParameter
simGetEngineInt32Parameter
simGetEulerAnglesFromMatrix
simGetExplicitHandling
simGetFloatParameter
simGetFloatSignal
simGetIkGroupHandle
simGetIkGroupMatrix
simGetInt32Parameter
simGetIntegerSignal
simGetInvertedMatrix
simGetJointForce
simGetJointInterval
simGetJointMatrix
simGetJointMode
simGetJointPosition
simGetJointTargetPosition
simGetJointTargetVelocity
simGetJointType
simGetLastError
simGetLightParameters
simGetLinkDummy
simGetMainWindow
simGetMechanismHandle
simGetModelProperty
simGetModuleName
simGetNameSuffix
simGetNavigationMode
simGetObjectAssociatedWithScript
simGetObjectConfiguration
simGetObjectChild
simGetObjectFloatParameter
simGetObjectHandle
simGetObjectInt32Parameter
simGetObjectLastSelection
simGetObjectMatrix
simGetObjectName
simGetObjectOrientation
simGetObjectParent
simGetObjectPosition
simGetObjectProperty
simGetObjectQuaternion
simGetObjects
simGetObjectSelection
simGetObjectSelectionSize
simGetObjectsInTree
simGetObjectSizeFactor
simGetObjectSizeValues
simGetObjectSpecialProperty
simGetObjectStringParameter
simGetObjectType
simGetObjectUniqueIdentifier
simGetObjectVelocity
simGetOctreeVoxels
simGetOrientationOnPath
simGetPage
simGetPathLength
simGetPathPosition
simGetPointCloudOptions
simGetPointCloudPoints
simGetPositionOnPath
simGetQHull
simGetQuaternionFromMatrix
simGetRealTimeSimulation
simGetExtensionString
simGetReferencedHandles
simGetRotationAxis
simGetScaledImage
simGetScript
simGetScriptAssociatedWithObject
simGetScriptAttribute
simGetScriptExecutionCount
simGetScriptHandle
simGetScriptName
simGetScriptProperty
simGetScriptRawBuffer
simGetScriptSimulationParameter
simGetScriptText
simGetShapeColor
simGetShapeGeomInfo
simGetShapeMassAndInertia
simGetShapeMesh
simGetShapeTextureId
simGetSignalName
simGetSimulationPassesPerRenderingPass
simGetSimulationState
simGetSimulationTime
simGetSimulationTimeStep
simGetSimulatorMessage
simGetStackBoolValue
simGetStackDoubleTable
simGetStackDoubleValue
simGetStackFloatTable
simGetStackFloatValue
simGetStackInt32Table
simGetStackInt32Value
simGetStackSize
simGetStackStringValue
simGetStackTableInfo
simGetStackUInt8Table
simGetStringParameter
simGetStringSignal
simGetSystemTime
simGetSystemTimeInMs
simGetTextureId
simGetThreadAutomaticSwitch
simGetThreadId
simGetUIButtonLabel
simGetUIButtonProperty
simGetUIButtonSize
simGetUIEventButton
simGetUIHandle
simGetUInt64Parameter
simGetUIPosition
simGetUIProperty
simGetUISlider
simGetVelocity
simGetVisionSensorDepthBuffer
simGetVisionSensorCharImage
simGetVisionSensorFilter
simGetVisionSensorImage
simGetVisionSensorResolution
simGroupShapes
simHandleChildScripts
simHandleCollision
simHandleDistance
simHandleDynamics
simHandleGeneralCallbackScript
simHandleGraph
simHandleIkGroup
simHandleMainScript
simHandleMechanism
simHandleMill
simHandleModule
simHandleProximitySensor
simHandleSensingStart
simHandleSimulationStart
simHandleVisionSensor
simImportMesh
simImportShape
simInsertDataIntoStackTable
simInsertObjectIntoOctree
simInsertObjectIntoPointCloud
simInsertPathCtrlPoints
simInsertPointsIntoPointCloud
simInsertVoxelsIntoOctree
simInterpolateMatrices
simIntersectPointsWithPointCloud
simInvertMatrix
simIsHandleValid
simIsObjectInSelection
simIsRealTimeSimulationStepNeeded
simIsScriptExecutionThreaded
simIsStackValueNull
simLaunchExecutable
simLaunchThreadedChildScripts
simLoadImage
simLoadModel
simLoadModule
simLoadScene
simLoadUI
simLockResources
simModifyGhost
simMoveStackItemToTop
simMoveToObject
simMsgBox
simMultiplyMatrices
simMultiplyVector
simOpenModule
simOpenTextEditor
simPackDoubleTable
simPackFloatTable
simPackInt32Table
simPackTable
simPackUInt8Table
simPackUInt16Table
simPackUInt32Table
simPauseSimulation
simPersistentDataRead
simPersistentDataWrite
simPopStackItem
simPushBoolOntoStack
simPushDoubleOntoStack
simPushDoubleTableOntoStack
simPushFloatOntoStack
simPushFloatTableOntoStack
simPushInt32OntoStack
simPushInt32TableOntoStack
simPushNullOntoStack
simPushStringOntoStack
simPushTableOntoStack
simPushUInt8TableOntoStack
simQuitSimulator
simReadCollision
simReadCustomDataBlock
simReadCustomDataBlockTags
simReadDistance
simReadForceSensor
simReadProximitySensor
simReadTexture
simReadVisionSensor
simReceiveData
simRefreshDialogs
simRegisterContactCallback
simRegisterJointCtrlCallback
simRegisterScriptCallbackFunction
simRegisterScriptVariable
simReleaseBuffer
simReleaseScriptRawBuffer
simReleaseStack
simRemoveBanner
simRemoveCollection
simRemoveDrawingObject
simRemoveIkGroup
simRemoveModel
simRemoveObject
simRemoveObjectFromSelection
simRemoveParticleObject
simRemovePointsFromPointCloud
simRemoveScript
simRemoveUI
simRemoveVoxelsFromOctree
simReorientShapeBoundingBox
simResetCollision
simResetDistance
simResetDynamicObject
simResetGraph
simResetMill
simResetMilling
simResetProximitySensor
simResetScript
simResetVisionSensor
simResumeThreads
simRMLMoveToJointPositions
simRMLMoveToPosition
simRMLPos
simRMLRemove
simRMLStep
simRMLVel
simRotateAroundAxis
simRunSimulator
simSaveImage
simSaveModel
simSaveScene
simSaveUI
simScaleObject
simScaleObjects
simSendData
simSendModuleMessage
simSerialCheck
simSerialClose
simSerialOpen
simSerialRead
simSerialSend
simSetArrayParameter
simSetBoolParameter
simSetCollectionName
simSetConfigurationTree
simSetEngineBoolParameter
simSetEngineFloatParameter
simSetEngineInt32Parameter
simSetExplicitHandling
simSetFloatParameter
simSetFloatSignal
simSetGraphUserData
simSetIkElementProperties
simSetIkGroupProperties
simSetInt32Parameter
simSetIntegerSignal
simSetJointForce
simSetJointInterval
simSetJointMode
simSetJointPosition
simSetJointTargetPosition
simSetJointTargetVelocity
simSetLastError
simSetLightParameters
simSetLinkDummy
simSetModelProperty
simSetModuleMenuItemState
simSetNameSuffix
simSetNavigationMode
simSetObjectConfiguration
simSetObjectFloatParameter
simSetObjectInt32Parameter
simSetObjectMatrix
simSetObjectName
simSetObjectOrientation
simSetObjectParent
simSetObjectPosition
simSetObjectProperty
simSetObjectQuaternion
simSetObjectSizeValues
simSetObjectSpecialProperty
simSetObjectStringParameter
simSetPage
simSetPathPosition
simSetPointCloudOptions
simSetReferencedHandles
simSetScriptAttribute
simSetScriptRawBuffer
simSetScriptSimulationParameter
simSetScriptText
simSetScriptVariable
simSetShapeColor
simSetShapeMassAndInertia
simSetShapeMaterial
simSetShapeTexture
simSetSimulationPassesPerRenderingPass
simSetSphericalJointMatrix
simSetStringParameter
simSetStringSignal
simSetThreadAutomaticSwitch
simSetThreadIsFree
simSetThreadResumeLocation
simSetThreadSwitchTiming
simSetUIButtonArrayColor
simSetUIButtonColor
simSetUIButtonLabel
simSetUIPosition
simSetUIButtonProperty
simSetUIButtonTexture
simSetUIProperty
simSetUISlider
simSetVisionSensorCharImage
simSetVisionSensorFilter
simSetVisionSensorImage
simSubtractObjectFromOctree
simSubtractObjectFromPointCloud
simStartSimulation
simStopSimulation
simSwitchThread
simTransformBuffer
simTransformImage
simTransformVector
simTubeClose
simTubeOpen
simTubeRead
simTubeStatus
simTubeWrite
simUnfoldStackTable
simUngroupShape
simUnloadModule
simUnlockResources
simUnpackDoubleTable
simUnpackFloatTable
simUnpackInt32Table
simUnpackTable
simUnpackUInt8Table
simUnpackUInt16Table
simUnpackUInt32Table
simWait
simWaitForSignal
simWriteCustomDataBlock
simWriteTexture


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
_simGetIkGroupObject
_simMpHandleIkGroupObject
_simGetPureHollowScaling
_simGetVortexParameters
_simGetJointCallbackCallOrder
_simGetNewtonParameters

Recommended topics

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