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

gdt::symmetryFunction in std::gdt

GD&T symmetry annotation specifying how closely a feature's median plane must align with datum references.

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

Symmetry is a location tolerance for features of size. It controls the derived median points of opposing feature surfaces relative to a datum center plane. The tolerance zone is bounded by two parallel planes equally disposed about the datum plane, with a total width equal to tolerance. Datum references are required.

Symmetry is the non-circular counterpart to concentricity. It is typically used where mass balance or form distribution about a datum plane matters, but it is difficult to inspect and is often replaced by position or profile controls where appropriate.

In American Society of Mechanical Engineers (ASME) Y14.5, symmetry is applied regardless of feature size (RFS) and does not use maximum material condition (MMC) or least material condition (LMC) modifiers.

Arguments

NameTypeDescriptionRequired
tolerancenumber(Length)The total width of the tolerance zone between two parallel planes.Yes
datums[string; 1+]The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums.Yes
faces[TaggedFace; 1+]The faces to be annotated.No
edges[Edge; 1+]The edges to be annotated.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 feature control frame relative to the leader arrow. The default is [100mm, 100mm].No
framePlanePlaneThe 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
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::symmetry 0

Rendered example of gdt::symmetry 1

Found a typo?