Docs Home
/
KCL Standard Library
/
Functions
/
Std Gdt Annotation

gdt::annotationFunction in std::gdt

GD&T annotation for attaching manufacturing text to faces or edges.

This is part of model-based definition (MBD).

Arguments

NameTypeDescriptionRequired
annotationstringThe annotation text to display.Yes
faces[TaggedFace; 1+]The faces to be annotated.No
edges[Edge; 1+]The edges to be annotated.No
framePositionPoint2dThe position of the annotation relative to the leader arrow. The default is [100mm, 100mm].No
framePlanePlaneThe plane in which to display the annotation. The default is XY. Other standard planes like XZ and YZ can also be used. The annotation may be displayed in a plane parallel to the given plane.No
leaderScalenumber(_)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
fontSizenumber(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

Rendered example of gdt::annotation 0

Rendered example of gdt::annotation 1

Found a typo?