Remote API function list (by category)

If the function you are looking for is not listed below, then make sure to have a look at the generic function simxCallScriptFunction, which allows you to implement virtually any remote API function.

Remote API helper functions

simxStart
simxFinish
simxGetConnectionId
simxPauseCommunication
simxCreateBuffer
simxReleaseBuffer
simxSynchronous
simxSynchronousTrigger
simxGetPingTime
simxGetLastCmdTime
simxGetInMessageInfo
simxGetOutMessageInfo
simxTransferFile
simxEraseFile
simxPackFloats
simxPackInts
simxUnpackFloats
simxUnpackInts

File operations

simxTransferFile
simxEraseFile
simxLoadModel
simxLoadScene
simxLoadUI

See also the generic function simxCallScriptFunction.

General object handle retrieval

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjects
simxGetObjectChild
simxGetObjectParent
simxGetUIHandle
simxGetCollisionHandle
simxGetDistanceHandle
simxGetCollectionHandle

See also the generic function simxCallScriptFunction.

Collision detection functionality

simxGetCollisionHandle
simxGetObjectGroupData
simxReadCollision

See also the generic function simxCallScriptFunction.

Minimum distance calculation functionality

simxGetDistanceHandle
simxGetObjectGroupData
simxReadDistance

See also the generic function simxCallScriptFunction.

Proximity sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxReadProximitySensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their proximity sensor related parameters.

Vision sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetVisionSensorImage
simxSetVisionSensorImage
simxGetVisionSensorDepthBuffer
simxReadVisionSensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their vision sensor related parameters.

Force sensor functionality

simxGetObjectHandle
simxGetObjectGroupData
simxBreakForceSensor
simxReadForceSensor
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their force sensor related parameters.

Milling functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their mill related parameters.

Joint object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetJointMatrix
simxGetJointPosition
simxGetJointForce
simxSetJointForce
simxSetJointPosition
simxSetJointTargetPosition
simxSetJointTargetVelocity
simxSetSphericalJointMatrix
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their joint related parameters.

Path object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their path related parameters.

Shape object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their shape related parameters.

Graph object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their graph related parameters.

Light object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their light related parameters.

Camera object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their camera related parameters.

Dummy object functionality

simxCreateDummy
simxGetObjectHandle
simxGetObjectGroupData
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their dummy related parameters.

Scene object functionality

simxGetObjectHandle
simxGetObjectGroupData
simxGetObjects
simxRemoveObject
simxRemoveModel
simxGetObjectChild
simxGetObjectParent
simxSetObjectParent
simxGetObjectOrientation
simxGetObjectPosition
simxSetObjectOrientation
simxSetObjectPosition
simxGetObjectVelocity
simxCopyPasteObjects
simxGetObjectSelection
simxSetObjectSelection
simxGetObjectFloatParameter
simxSetObjectFloatParameter
simxGetObjectIntParameter
simxSetObjectIntParameter

See also the generic function simxCallScriptFunction,
or the simxSetObjectXXXParameter and simxGetObjectXXXParameter functions
and their scene object related parameters.

OpenGl-based custom UI functionality

simxLoadUI
simxRemoveUI
simxGetUIEventButton
simxGetUIHandle
simxGetObjectGroupData
simxGetUISlider
simxSetUISlider
simxGetUIButtonProperty
simxSetUIButtonProperty
simxSetUIButtonLabel

See also the generic function simxCallScriptFunction.

Generic dialog functionality

simxDisplayDialog
simxEndDialog
simxGetDialogInput
simxGetDialogResult

See also the generic function simxCallScriptFunction.

Model functionality

simxLoadModel
simxGetModelProperty
simxSetModelProperty

See also the generic function simxCallScriptFunction.

Object selection functionality

simxGetObjectSelection
simxSetObjectSelection

See also the generic function simxCallScriptFunction.

Simulation functionality

simxPauseSimulation
simxStartSimulation
simxStopSimulation

See also the generic function simxCallScriptFunction.

Signals

simxReadStringStream
simxWriteStringStream
simxClearFloatSignal
simxClearIntegerSignal
simxClearStringSignal
simxGetFloatSignal
simxGetIntegerSignal
simxGetStringSignal
simxGetAndClearStringSignal
simxSetFloatSignal
simxSetIntegerSignal
simxSetStringSignal
simxAppendStringSignal

See also the generic function simxCallScriptFunction.

Auxiliary console functions

simxAuxiliaryConsoleClose
simxAuxiliaryConsoleOpen
simxAuxiliaryConsolePrint
simxAuxiliaryConsoleShow

See also the generic function simxCallScriptFunction.

Simulator parameter retrieval

simxGetArrayParameter
simxSetArrayParameter
simxGetBooleanParameter
simxSetBooleanParameter
simxGetFloatingParameter
simxSetFloatingParameter
simxGetIntegerParameter
simxSetIntegerParameter
simxGetStringParameter

See also the generic function simxCallScriptFunction.

Other commands

simxCallScriptFunction
simxAddStatusbarMessage
simxGetLastErrors
simxCloseScene
simxCopyPasteObjects

Recommended topics

  • Remote API function list (alphabetical order)
  • Remote API constants
  • API constants