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

gdt::noteFunction in std::gdt

GD&T note for adding free-floating manufacturing text that is not attached to a face or edge.

This is part of model-based definition (MBD). Unlike gdt::annotation, a note has no leader and is placed directly on a plane. By default it lives on the world XY plane, but any plane (a standard plane like XZ/YZ, or a user-defined plane) can be supplied via framePlane.

Arguments

NameTypeDescriptionRequired
notestringThe note text to display.Yes
framePlanePlaneThe plane the note lies in. The default is XY. Other standard planes like XZ and YZ, or a user-defined plane, can also be used.No
framePositionPoint2dThe 2D position of the note within the plane, in the plane's local coordinates. The default is [100mm, 100mm].No
fontSizenumber(Length)The model-space height to use for the note 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 - A GD&T annotation created by one of the gdt functions.

Examples

Rendered example of gdt::note 0

Rendered example of gdt::note 1

Found a typo?