Fits a geometric shape (line, plane, circle, sphere, cylinder, cone, paraboloid, or ellipse) to a list of points.
Input Arguments
0 |
Geometry Type |
Geometry Type |
The type of geometry to fit to the points. |
1 |
Point Name Ref List |
Points to Fit |
The points to use in the fit. |
2 |
Collection Object Name |
Resulting Object Name |
The name of the resulting geometry. |
3 |
String |
Fit Profile Name |
The name of the geometry fit profile to use. |
4 |
Boolean |
Report Deviations |
Indicates whether a dialog should be displayed showing the fit results. |
5 |
Double |
Fit Interface Tolerance (-1.0 use profile) |
The tolerance to use for the geometry fit. |
6 |
Boolean |
Ignore Out of Tolerance Points |
Indicates whether or not points outside of the tolerance specified in Argument 5 should be included in the fit. |
7 |
Collection Object Name |
Starting Condition Geometry (optional) |
The name of a like geometry type to use as an initial guess for the geometry fit. |
Return Arguments
None.
Returned Status
SUCCESS |
The fit was successful. |
PARTIAL SUCCESS |
The fit was successful, but the tolerance was exceeded. |
FAILURE |
The fit was unsuccessful because the points or fit profile could not be found. |
Remarks
Leave the fit profile name blank in order to use the default fit profile for the specified geometry type. Use a fit toler- ance of -1.0 to use the tolerance defined in the specified fit profile or a value of 0.0 to indicate that no tolerance should apply. The optional starting condition geometry is useful in rare cases when a fit algorithm gets “confused” and fails to settle on an acceptable solution. Providing a starting condition geometry can often eliminate this problem. An object providing starting condition geometry is usually not required.
As of 2022.3 the Geometry Type argument [A0] can reference a string. It will accept [Line, Plane, Circle, Slot, Ellipse, Cylinder, Sphere, Cone, and Paraboloid] *Notes - first letter must be capitalized.