GD&T profile annotation specifying how much edges or faces may deviate from their ideal shape.
This is part of model-based definition (MBD).
gdt::profile is kept for backwards compatibility with existing KCL programs.
For new code, prefer gdt::profileLine when annotating edges and
gdt::profileSurface when annotating faces.
Provide exactly one of edges or faces. Passing edges delegates to
profileLine; passing faces delegates to profileSurface. Passing both,
or neither, is a KCL error.
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
tolerance | number(Length) | The amount of deviation from an ideal profile that is acceptable. | Yes |
edges | [Edge or any; 1+] | The edges to be annotated with profile of a line. Provide either edges or faces, but not both. Edge specifier objects ({ sideFaces = [...], endFaces? = [...], index? = 0 }) are experimental; do not use them in generated or user-facing KCL yet. | No |
faces | [TaggedFace; 1+] | The faces to be annotated with profile of a surface. Provide either edges or faces, but not both. | No |
datums | [string; 1+] | The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums. | No |
precision | number(_) | The number of decimal places to display. The default is 3. Must be greater than or equal to 0 and less than or equal to 9. | No |
framePosition | Point2d | The position of the feature control frame relative to the leader arrow. The default is [100mm, 100mm]. | No |
framePlane | Plane | The plane in which to display the feature control frame. The default is XY. Other standard planes like XZ and YZ can also be used. The frame may be displayed in a plane parallel to the given plane. | No |
leaderScale | number(_) | Visual scale of the leader dot. The default is 1.0, which maps to the calibrated normal dot size. The value is normalized against fontSize so the dot stays consistent as text size changes. Must be greater than 0. | No |
fontSize | number(Length) | The model-space height to use for annotation text. The default is 10mm. Explicit units are supported; bare numbers use the file's default length unit. This changes the scene size, not the internal raster texture quality. | No |
Returns
[GdtAnnotation; 1+]
Examples
