Makeathon ends in00:00:00:00
Docs Home
/
KCL Standard Library
/
Functions
/
Std Gdt Distance

gdt::distanceFunction in std::gdt

GD&T distance annotation for displaying measured edge lengths or distances between two entities.

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

Arguments

NameTypeDescriptionRequired
tolerancenumber(Length)The acceptable distance tolerance.Yes
fromFace or TaggedFace or EdgeThe face or edge to measure from. Must be used with to. The default position is the entity center.No
toFace or TaggedFace or EdgeThe face or edge to measure to. Must be used with from. The default position is the entity center.No
edges[Edge; 1+]The edges whose lengths are annotated. Cannot be combined with from or to.No
precisionnumber(_)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
framePositionPoint2dThe position of the distance label relative to the measured geometry. The default is [100mm, 100mm].No
framePlanePlaneThe plane in which to display the distance. The default is XY. Other standard planes like XZ and YZ can also be used. The distance may be displayed in a plane parallel to the given plane.No
leaderScalenumber(_)Scale of the distance arrows. The default is 1.0. 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::distance 0

Rendered example of gdt::distance 1

Found a typo?