Performs a relationship fit (minimization).
Input Arguments
0 |
Collection Name |
Collection Containing Relation- ships |
The collection containing the relationships to minimize. |
1 |
Collection Object Name Ref List |
Objects to Move |
The list of objects to transform. |
2 |
Collection Instrument ID Ref List |
Instruments to Move |
The list of instruments to transform. |
3 |
Solver Mode |
Pick |
Select from the available optimization methods. Refer to the Relationship chapter of the user manual for more details. |
4 |
Fit Degree-Of-Freedom Options |
Motion to allow |
The allowable degrees of freedom for the fit. |
5 |
Boolean |
Use Fit Dialog |
Indicates whether the fit dialog should be dis- played to the user during execution. |
Return Arguments
6 |
Transform |
Resulting Transform |
The transform generated by the relationship minimization. |
7 |
Double |
Fit Objective Value |
|
Returned Status
SUCCESS |
The relationship was deleted successfully. |
FAILURE |
The specified relationship was not found. |
Remarks
The actual transformation is applied to the moving objects and instruments, but the transform is returned in order to perform additional transforms.