kcl-std → functions → gdt::flatness

gdt::flatnessFunction in std::gdt

WARNING: This function is experimental and may change or be removed.

GD&T annotation specifying how flat faces should be.

gdt::flatness(
  faces: [TaggedFace; 1+],
  tolerance: number(Length),
  precision?: number(_),
  framePosition?: Point2d,
  inPlane?: Plane,
  fontPointSize?: number(_),
  fontScale?: number(_),
)

Arguments

NameTypeDescriptionRequired
faces[TaggedFace; 1+]The faces to be annotated.Yes
tolerancenumber(Length)The amount of deviation from a perfect plane that is acceptable.Yes
precisionnumber(_)The number of decimal places to display. The default is 3. Must be greater than or equal to 0.No
framePositionPoint2dThe position of the feature control frame relative to the leader arrow. The default is [100mm, 100mm].No
inPlanePlaneThe 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
fontPointSizenumber(_)The font point size to use for the annotation text rendering. The default is 36.No
fontScalenumber(_)Scale to use for the annotation text after rendering with the point size. The default is 1.0. Must be greater than 0.No

Examples

@settings(experimentalFeatures = allow)

startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0])
  |> line(end = [0, -10])
  |> close()
  |> extrude(length = 5, tagStart = $face1)
gdt::flatness(faces = [face1], tolerance = 0.1mm)

@settings(experimentalFeatures = allow)

startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0])
  |> line(end = [0, -10])
  |> close()
  |> extrude(length = 5, tagEnd = $face1)
gdt::flatness(
  faces = [face1],
  tolerance = 0.02mm,
  framePosition = [10mm, 20mm],
  inPlane = XZ,
)

@settings(experimentalFeatures = allow)

startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0], tag = $face1)
  |> line(end = [0, -10])
  |> close()
  |> extrude(length = 5)
gdt::flatness(
  faces = [face1],
  tolerance = 0.02mm,
  framePosition = [10mm, 20mm],
  inPlane = XZ,
)

Found a typo?