Method CreateKinematicsSimulation
CreateKinematicsSimulation(DocumentId, ElementId, ElementId, SmartInteger, SmartInteger, bool)
Creates a kinematics simutation operation in a specified document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateKinematicsSimulation(DocumentId inDocumentId, ElementId inStartConfigurationId, ElementId inScenarioId, SmartInteger inPositionsPerSecond, SmartInteger inStepsPerPosition, bool inIsRefreshAuto)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inStartConfigurationId | Identifier of start configuration. |
| ElementId | inScenarioId | Identifier of scenario. |
| SmartInteger | inPositionsPerSecond | Number of positions per second. |
| SmartInteger | inStepsPerPosition | Number of computed steps per position. |
| bool | inIsRefreshAuto | Whether refresh is automatic. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created simulation entity. |
Remarks
StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.