/// Functions for working with geometric dimensioning and tolerancing (GD&T).
/// This can be used for model-based definition (MBD).
@no_std
@settings(defaultLengthUnit = mm, kclVersion = 1.0)
/// GD&T datum feature.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
/// width = 5
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [width, 0], tag = $side1)
/// |> line(end = [0, width], tag = $side2)
/// |> line(end = [-width, 0], tag = $side3)
/// |> line(end = [0, -width], tag = $side4)
/// |> close()
/// |> extrude(length = 5, tagStart = $bottom, tagEnd = $top)
///
/// gdt::datum(
/// face = side2,
/// name = "A",
/// framePosition = [5, 0],
/// framePlane = XZ,
/// )
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 8mm, var 0mm])
/// edge2 = line(start = [var 8mm, var 0mm], end = [var 8mm, var 5mm])
/// edge3 = line(start = [var 8mm, var 5mm], end = [var 0mm, var 5mm])
/// edge4 = line(start = [var 0mm, var 5mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [4mm, 2mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
///
/// gdt::datum(
/// face = top,
/// name = "A",
/// framePosition = [10mm, 0mm],
/// framePlane = XZ,
/// )
/// ```
@(impl = std_rust, feature_tree = true)
export fn datum(
/// The face to be annotated.
@(includeInSnippet = true)
face: TaggedFace,
/// The name of the datum.
@(includeInSnippet = true)
name: string,
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): GdtAnnotation {}
/// GD&T annotation specifying how flat faces should be.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// 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)
/// ```
///
/// ```kcl,no3d,legacySketch
///
/// 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], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,legacySketch
///
/// 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], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// gdt::flatness(faces = [top], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn flatness(
/// The faces to be annotated.
@(includeInSnippet = true)
faces: [TaggedFace; 1+],
/// The amount of deviation from a perfect plane that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T annotation specifying how straight a feature must be.
///
/// This is part of model-based definition (MBD).
///
/// Straightness is a form tolerance. When applied to a planar face, every
/// line element of the face must lie between two parallel lines separated by
/// the given `tolerance`. When applied to an edge, the edge itself must lie
/// within that zone.
///
/// Straightness should usually be applied to edges. But depending on the view,
/// a face normal may appear like an edge.
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// blockSketch = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 24mm])
/// edge3 = line(start = [var 10mm, var 24mm], end = [var 0mm, var 24mm])
/// edge4 = line(start = [var 0mm, var 24mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// blockRegion = region(point = [5mm, 3mm], sketch = blockSketch)
/// hide(blockSketch)
/// block = extrude(blockRegion, length = 10mm)
/// gdt::straightness(edges = [blockRegion.tags.edge2], tolerance = 0.05mm)
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// gdt::straightness(faces = [top], tolerance = 0.02mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// sideEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
/// gdt::straightness(edges = [sideEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn straightness(
/// The amount of deviation from perfectly straight that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T annotation specifying how circular (round) a feature must be.
///
/// This is part of model-based definition (MBD).
///
/// Circularity is a form tolerance. It controls how much a feature of
/// revolution may deviate from a perfect circle. When applied to a circular
/// edge, every point of the edge must lie between two concentric circles whose
/// radii differ by the given `tolerance`. When applied to a round face, such as
/// the wall of a cylinder or cone, every cross-section perpendicular to the
/// axis must meet that same requirement.
///
/// Circularity is a form tolerance, so it does not reference datums.
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinderRegion = region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch)
/// hide(cylinderSketch)
/// cylinder = extrude(cylinderRegion, length = 10mm)
/// gdt::circularity(edges = [cylinderRegion.tags.perimeter], tolerance = 0.05mm, framePosition = [-12mm, 8mm])
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm)
/// gdt::circularity(faces = [cylinder.sketch.tags.perimeter], tolerance = 0.02mm, framePosition = [-12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
/// topEdge = getCommonEdge(faces = [cylinder.sketch.tags.perimeter, top])
/// gdt::circularity(edges = [topEdge], tolerance = 0.05mm, framePosition = [-12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn circularity(
/// The amount of deviation from a perfect circle that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T annotation specifying how closely a feature must conform to a perfect cylinder.
///
/// This is part of model-based definition (MBD).
///
/// Cylindricity is a form tolerance. It controls how much a cylindrical
/// surface may deviate from a perfect cylinder, combining roundness,
/// straightness, and taper into a single requirement. Every point on the
/// surface must lie between two coaxial cylinders whose radii differ by the
/// given `tolerance`. When applied to a round face, such as the wall of a
/// cylinder, the whole surface must meet that requirement. When applied to a
/// circular edge, that edge must lie within the same zone.
///
/// Cylindricity is a form tolerance, so it does not reference datums.
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm)
/// gdt::cylindricity(faces = [cylinder.sketch.tags.perimeter], tolerance = 0.02mm, framePosition = [-12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinderRegion = region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch)
/// hide(cylinderSketch)
/// cylinder = extrude(cylinderRegion, length = 10mm)
/// gdt::cylindricity(edges = [cylinderRegion.tags.perimeter], tolerance = 0.05mm, framePosition = [-12mm, 8mm])
/// ```
///
/// ```kcl,no3d,sketchSolve
/// @settings(kclVersion = 2.0)
///
/// cylinderSketch = sketch(on = XY) {
/// perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
/// }
///
/// cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
/// topEdge = getCommonEdge(faces = [cylinder.sketch.tags.perimeter, top])
/// gdt::cylindricity(edges = [topEdge], tolerance = 0.05mm, framePosition = [-12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn cylindricity(
/// The amount of deviation from a perfect cylinder that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T perpendicularity annotation specifying how much faces or edges may deviate from perpendicular orientation relative to datum references.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side)
/// |> line(end = [0, 10])
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// gdt::datum(face = top, name = "A", framePosition = [8mm, 0mm], framePlane = XZ)
/// gdt::perpendicularity(faces = [side], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// sideEdge = getCommonEdge(faces = [block.sketch.tags.edge2, top])
/// gdt::perpendicularity(edges = [sideEdge], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn perpendicularity(
/// The tolerance zone size for perpendicular orientation.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums.
@(includeInSnippet = true)
datums?: [string; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T parallelism annotation specifying how much faces or edges may deviate from parallel orientation relative to datum references.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side)
/// |> line(end = [0, 10])
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// gdt::datum(face = top, name = "A", framePosition = [8mm, 0mm], framePlane = XZ)
/// gdt::parallelism(faces = [side], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// sideEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
/// gdt::parallelism(edges = [sideEdge], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn parallelism(
/// The tolerance zone size for parallel orientation.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums.
@(includeInSnippet = true)
datums?: [string; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T position annotation specifying how much faces or edges may deviate from their ideal location.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side)
/// |> line(end = [0, 10])
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// gdt::datum(face = top, name = "A", framePosition = [8mm, 0mm], framePlane = XZ)
/// gdt::position(faces = [side], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// sideEdge = getCommonEdge(faces = [block.sketch.tags.edge2, top])
/// gdt::position(edges = [sideEdge], tolerance = 0.05mm, datums = ["A"], framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn position(
/// The positional tolerance that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums.
@(includeInSnippet = true)
datums?: [string; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T annotation for attaching manufacturing text to faces or edges.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side)
/// |> line(end = [0, 10])
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// gdt::annotation(faces = [top], annotation = "Break all sharp edges", framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// sideEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
/// gdt::annotation(edges = [sideEdge], annotation = "Deburr edge", framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn annotation(
/// The annotation text to display.
@(includeInSnippet = true)
annotation: string,
/// The faces to be annotated.
@(includeInSnippet = true)
faces?: [TaggedFace; 1+],
/// The edges to be annotated.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// The position of the annotation relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T distance annotation for displaying measured edge lengths or distances between two entities.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side1)
/// |> line(end = [0, 10])
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// lengthEdge = getCommonEdge(faces = [side1, top])
/// gdt::distance(edges = [lengthEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// lengthEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
/// gdt::distance(edges = [lengthEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn distance(
/// The acceptable distance tolerance.
@(includeInSnippet = true)
tolerance: number(Length),
/// The face or edge to measure from. Must be used with `to`. The default position is the entity center.
from?: Face | TaggedFace | Edge,
/// The face or edge to measure to. Must be used with `from`. The default position is the entity center.
to?: Face | TaggedFace | Edge,
/// The edges whose lengths are annotated. Cannot be combined with `from` or `to`.
@(includeInSnippet = true)
edges?: [Edge; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the distance label relative to the measured geometry. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// Scale of the distance arrows. The default is `1.0`. Must be greater than `0`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}
/// GD&T profile annotation specifying how much edges may deviate from their ideal shape.
///
/// This is part of model-based definition (MBD).
///
/// ```kcl,no3d,legacySketch
///
/// startSketchOn(XY)
/// |> startProfile(at = [0, 0])
/// |> line(end = [10, 0], tag = $side1)
/// |> line(end = [0, 10], tag = $side2)
/// |> line(end = [-10, 0])
/// |> line(end = [0, -10])
/// |> close()
/// |> extrude(length = 5, tagEnd = $top)
///
/// profileEdge = getCommonEdge(faces = [side1, top])
///
/// gdt::profile(
/// edges = [profileEdge],
/// tolerance = 0.1mm,
/// datums = ["A"],
/// framePosition = [10mm, 20mm],
/// framePlane = XZ,
/// )
/// ```
///
/// ```kcl,no3d,sketchSolve
///
/// blockProfile = sketch(on = XY) {
/// edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
/// edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
/// edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
/// edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
/// coincident([edge1.end, edge2.start])
/// coincident([edge2.end, edge3.start])
/// coincident([edge3.end, edge4.start])
/// coincident([edge4.end, edge1.start])
/// horizontal(edge1)
/// vertical(edge2)
/// horizontal(edge3)
/// vertical(edge4)
/// }
///
/// block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
/// profileEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
/// gdt::profile(edges = [profileEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
/// ```
@(impl = std_rust, feature_tree = true)
export fn profile(
/// The edges to be annotated.
@(includeInSnippet = true)
edges: [Edge; 1+],
/// The amount of deviation from an ideal profile that is acceptable.
@(includeInSnippet = true)
tolerance: number(Length),
/// The datum references to display in the feature control frame. Supports up to primary, secondary, and tertiary datums.
@(includeInSnippet = true)
datums?: [string; 1+],
/// 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`.
@(includeInSnippet = true)
precision?: number(Count),
/// The position of the feature control frame relative to the leader arrow. The default is `[100mm, 100mm]`.
@(snippetArray = ["100", "100"])
framePosition?: Point2d,
/// The 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.
@(includeInSnippet = true)
framePlane?: Plane,
/// 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`.
leaderScale?: number(Count),
/// 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.
fontSize?: number(Length),
): [GdtAnnotation; 1+] {}