Python API
The following is a quick overview of Python API naming conventions, properties and class structure.
Properties
Properties are accessed as attributes of objects. There is also a vcProperty object that is used for registering events and setting the attributes of property objects themselves.
Naming
| Name | Format | Example |
| Constants | VC_[CONSTANT_NAME] | Prefix of "VC_" with all letters capitalized, and each word is separated with an underscore (_). |
| Events | On[EventName] | Prefix of event name is "On" and for every following word its first character is capitalized, for example OnStart. |
| Methods | [methodName]() | First character is lowercase and for every following word its first character is capitalized, for example getConnection(). |
| Objects | vc[ObjectName] | vcGeometryFeature. |
| Properties | [PropertyName] | First character is capitalized, for example Speed, Mass and Name. |
Python Classes
vcInterpolatingTransportController
vcRslProcessHandler (Deprecated) use vcPythonProcessHandler
vcRslProgramExecutor (Deprecated) use vcExecutor
vcConfigurableProductTypeFilter
vcCommandEvent (Deprecated)
vcDistributionModeProductLineEntry
vcLineSet (Deprecated) Use vcCompactLineSet
vcPoint (Deprecated)
vcPolygonSet (Deprecated) Use vcTriangleSet
vcPathObject (Deprecated)
vcPathObjectNode (Deprecated)
vcPathObjectActionNode (Deprecated)
vcPathObjectMotionNode (Deprecated)
vcPathObjectParameterNode (Deprecated)
vcPathObjectReferenceNode (Deprecated)
vcPathObjectSegment (Deprecated)
vcEdge (Deprecated)
vcLine (Deprecated)
vcPoint (Deprecated)
vcPolygon (Deprecated)
vcProductCreatorDistributionMode
vcRslRoutine (Deprecated) use vcRoutine
vcRslStatement (Deprecated) use vcStatement
vcRslMotionStatement (Deprecated) use vcMotionStatement
vcRslProcessStatement (Deprecated) use vcPositionStatement