Skip to main content

kcl_lib/std/
gdt.rs

1use kcl_error::SourceRange;
2use kcmc::ModelingCmd;
3use kcmc::each_cmd as mcmd;
4use kittycad_modeling_cmds::shared::AnnotationBasicDimension;
5use kittycad_modeling_cmds::shared::AnnotationFeatureControl;
6use kittycad_modeling_cmds::shared::AnnotationFeatureTag;
7use kittycad_modeling_cmds::shared::AnnotationLineEnd;
8use kittycad_modeling_cmds::shared::AnnotationMbdBasicDimension;
9use kittycad_modeling_cmds::shared::AnnotationMbdControlFrame;
10use kittycad_modeling_cmds::shared::AnnotationOptions;
11use kittycad_modeling_cmds::shared::AnnotationType;
12use kittycad_modeling_cmds::shared::MbdSymbol;
13use kittycad_modeling_cmds::shared::Point2d as KPoint2d;
14use kittycad_modeling_cmds::{self as kcmc};
15
16use crate::ExecState;
17use crate::KclError;
18use crate::errors::KclErrorDetails;
19use crate::exec::KclValue;
20use crate::execution::Artifact;
21use crate::execution::ArtifactId;
22use crate::execution::CodeRef;
23use crate::execution::Face;
24use crate::execution::GdtAnnotation;
25use crate::execution::GdtAnnotationArtifact;
26use crate::execution::Metadata;
27use crate::execution::ModelingCmdMeta;
28use crate::execution::Plane;
29use crate::execution::TagIdentifier;
30use crate::execution::types::ArrayLen;
31use crate::execution::types::RuntimeType;
32use crate::parsing::ast::types as ast;
33use crate::parsing::ast::types::BoxNode;
34use crate::std::Args;
35use crate::std::args::FromKclValue;
36use crate::std::args::TyF64;
37use crate::std::edge;
38use crate::std::fillet::EdgeReference;
39use crate::std::sketch::ensure_sketch_plane_in_engine;
40use crate::unit_conversion::ToKcmc;
41
42// The engine exposes two text knobs:
43// - font_point_size controls the FreeType raster/bitmap texture resolution in pixels/points.
44// - font_scale is the unitless model-space multiplier applied to that texture.
45// KCL exposes only fontSize as a Length. Keep the raster quality fixed so changing
46// quality does not resize the text, and map the requested length into font_scale.
47const GDT_FONT_TEXTURE_POINT_SIZE: u32 = 36;
48const DEFAULT_GDT_FONT_SIZE_MM: f64 = 10.0;
49const DEFAULT_GDT_DOT_LEADER_SCALE: f64 = 1.0;
50const DEFAULT_GDT_DIMENSION_LEADER_SCALE: f64 = 1.0;
51const GDT_DOT_LEADER_REFERENCE_FONT_SIZE_MM: f64 = 100.0;
52const GDT_DOT_LEADER_REFERENCE_ENGINE_SCALE: f64 = 0.5;
53
54// Calibration target: measured annotation text/frame height in millimeters when
55// font_scale is 1.0 and GDT_FONT_TEXTURE_POINT_SIZE is fixed. Tune this value from
56// scene measurements, not by exposing engine font_point_size to users.
57const GDT_FONT_SCALE_1_HEIGHT_MM: f64 = 8.0;
58
59fn gdt_font_scale(font_size: Option<&TyF64>, args: &Args) -> Result<f32, KclError> {
60    let requested_height_mm = font_size.map(TyF64::to_mm).unwrap_or(DEFAULT_GDT_FONT_SIZE_MM);
61    if requested_height_mm <= 0.0 {
62        return Err(KclError::new_semantic(KclErrorDetails::new(
63            "fontSize must be greater than 0.".to_owned(),
64            vec![args.source_range],
65        )));
66    }
67    Ok(gdt_font_scale_for_height_mm(requested_height_mm))
68}
69
70fn gdt_font_scale_for_height_mm(requested_height_mm: f64) -> f32 {
71    (requested_height_mm / GDT_FONT_SCALE_1_HEIGHT_MM) as f32
72}
73
74fn gdt_user_leader_scale(leader_scale: Option<&TyF64>, default_scale: f64, args: &Args) -> Result<f32, KclError> {
75    let scale = leader_scale.map(|scale| scale.n).unwrap_or(default_scale);
76    if scale <= 0.0 {
77        return Err(KclError::new_semantic(KclErrorDetails::new(
78            "leaderScale must be greater than 0.".to_owned(),
79            vec![args.source_range],
80        )));
81    }
82    Ok(scale as f32)
83}
84
85fn gdt_dot_leader_scale(leader_scale: Option<&TyF64>, font_size: Option<&TyF64>, args: &Args) -> Result<f32, KclError> {
86    let user_scale = gdt_user_leader_scale(leader_scale, DEFAULT_GDT_DOT_LEADER_SCALE, args)?;
87    // Engine dot leaders are screen-space point sprites after an internal font_scale
88    // multiplier. Divide that out so KCL leaderScale stays stable across fontSize.
89    Ok(user_scale * gdt_dot_leader_normal_size() / gdt_font_scale(font_size, args)?)
90}
91
92fn gdt_dot_leader_normal_size() -> f32 {
93    gdt_font_scale_for_height_mm(GDT_DOT_LEADER_REFERENCE_FONT_SIZE_MM) * GDT_DOT_LEADER_REFERENCE_ENGINE_SCALE as f32
94}
95
96fn gdt_dimension_leader_scale(leader_scale: Option<&TyF64>, args: &Args) -> Result<f32, KclError> {
97    gdt_user_leader_scale(leader_scale, DEFAULT_GDT_DIMENSION_LEADER_SCALE, args)
98}
99
100#[derive(Debug, Clone)]
101enum DistanceEntity {
102    Face(Box<Face>),
103    TaggedFace(Box<TagIdentifier>),
104    Edge(EdgeReference),
105    Specifier(kcmc::shared::EdgeSpecifier),
106}
107
108#[derive(Debug, Clone)]
109enum GdtEdgeReference {
110    Entity(EdgeReference),
111    Specifier(kcmc::shared::EdgeSpecifier),
112}
113
114#[derive(Debug, Clone)]
115struct DistanceEndpoint {
116    entity_id: Option<uuid::Uuid>,
117    edge_reference: Option<kcmc::shared::EdgeSpecifier>,
118    entity_pos: KPoint2d<f64>,
119}
120
121#[derive(Debug, Clone, Copy)]
122enum GdtFeatureControlKind {
123    Flatness,
124    Straightness,
125    Circularity,
126    Cylindricity,
127    Concentricity,
128    Symmetry,
129    Runout,
130    ProfileLine,
131    ProfileSurface,
132    Position,
133    Angularity,
134    Perpendicularity,
135    Parallelism,
136}
137
138struct GdtFeatureControlParams {
139    faces: Vec<TagIdentifier>,
140    edges: Vec<GdtEdgeReference>,
141    datums: Option<Vec<String>>,
142    tolerance: TyF64,
143    precision: Option<TyF64>,
144    frame_position: Option<[TyF64; 2]>,
145    frame_plane: Option<Plane>,
146    leader_scale: Option<TyF64>,
147    font_size: Option<TyF64>,
148}
149
150struct GdtProfileCommonParams {
151    datums: Option<Vec<String>>,
152    tolerance: TyF64,
153    precision: Option<TyF64>,
154    frame_position: Option<[TyF64; 2]>,
155    frame_plane: Option<Plane>,
156    leader_scale: Option<TyF64>,
157    font_size: Option<TyF64>,
158}
159
160impl GdtFeatureControlKind {
161    fn label(self) -> &'static str {
162        match self {
163            Self::Flatness => "Flatness",
164            Self::Straightness => "Straightness",
165            Self::Circularity => "Circularity",
166            Self::Cylindricity => "Cylindricity",
167            Self::Concentricity => "Concentricity",
168            Self::Symmetry => "Symmetry",
169            Self::Runout => "Runout",
170            Self::ProfileLine => "Profile line",
171            Self::ProfileSurface => "Profile surface",
172            Self::Position => "Position",
173            Self::Angularity => "Angularity",
174            Self::Perpendicularity => "Perpendicularity",
175            Self::Parallelism => "Parallelism",
176        }
177    }
178
179    fn symbol(self) -> MbdSymbol {
180        match self {
181            Self::Flatness => MbdSymbol::Flatness,
182            Self::Straightness => MbdSymbol::Straightness,
183            Self::Circularity => MbdSymbol::Roundness,
184            Self::Cylindricity => MbdSymbol::Cylindricity,
185            Self::Concentricity => MbdSymbol::Concentricity,
186            Self::Symmetry => MbdSymbol::Symmetry,
187            Self::Runout => MbdSymbol::Runout,
188            Self::ProfileLine => MbdSymbol::ProfileOfLine,
189            Self::ProfileSurface => MbdSymbol::SurfaceProfile,
190            Self::Position => MbdSymbol::Position,
191            Self::Angularity => MbdSymbol::Angularity,
192            Self::Perpendicularity => MbdSymbol::Perpendicularity,
193            Self::Parallelism => MbdSymbol::Parallelism,
194        }
195    }
196
197    fn diameter_symbol(self) -> Option<MbdSymbol> {
198        match self {
199            Self::Concentricity => Some(MbdSymbol::Diameter),
200            _ => None,
201        }
202    }
203
204    fn requires_datums(self) -> bool {
205        matches!(self, Self::Concentricity | Self::Symmetry | Self::Runout)
206    }
207}
208
209fn add_gdt_annotation_artifact(exec_state: &mut ExecState, args: &Args, annotation_id: uuid::Uuid) {
210    exec_state.add_artifact(Artifact::GdtAnnotation(GdtAnnotationArtifact {
211        id: ArtifactId::new(annotation_id),
212        code_ref: CodeRef::placeholder(args.source_range),
213    }));
214}
215
216impl DistanceEntity {
217    async fn to_endpoint(&self, exec_state: &mut ExecState, args: &Args) -> Result<DistanceEndpoint, KclError> {
218        match self {
219            DistanceEntity::Face(face) => Ok(DistanceEndpoint {
220                entity_id: Some(face.id),
221                edge_reference: None,
222                entity_pos: KPoint2d { x: 0.5, y: 0.5 },
223            }),
224            DistanceEntity::TaggedFace(face) => Ok(DistanceEndpoint {
225                entity_id: Some(args.get_adjacent_face_to_tag(exec_state, face, false).await?),
226                edge_reference: None,
227                entity_pos: KPoint2d { x: 0.5, y: 0.5 },
228            }),
229            DistanceEntity::Edge(edge) => Ok(DistanceEndpoint {
230                entity_id: Some(edge.get_engine_id(exec_state, args)?),
231                edge_reference: None,
232                entity_pos: KPoint2d { x: 0.5, y: 0.0 },
233            }),
234            DistanceEntity::Specifier(edge_reference) => Ok(DistanceEndpoint {
235                entity_id: None,
236                edge_reference: Some(edge_reference.clone()),
237                entity_pos: KPoint2d { x: 0.5, y: 0.0 },
238            }),
239        }
240    }
241}
242
243impl<'a> FromKclValue<'a> for DistanceEntity {
244    fn from_kcl_val(arg: &'a KclValue) -> Option<Self> {
245        match arg {
246            KclValue::Face { value } => Some(Self::Face(value.to_owned())),
247            KclValue::Uuid { value, .. } => Some(Self::Edge(EdgeReference::Uuid(*value))),
248            KclValue::TagIdentifier(value) => Some(Self::TaggedFace(value.to_owned())),
249            _ => None,
250        }
251    }
252}
253
254async fn parse_distance_entity_arg(
255    arg_name: &str,
256    exec_state: &mut ExecState,
257    args: &Args,
258) -> Result<Option<DistanceEntity>, KclError> {
259    let Some(value): Option<KclValue> = args.get_kw_arg_opt(arg_name, &RuntimeType::any(), exec_state)? else {
260        return Ok(None);
261    };
262
263    if edge::is_edge_specifier_object(&value) {
264        let unresolved = edge::parse_edge_specifier_value(&value, args)?;
265        let edge_reference = edge::resolve_edge_specifier_with_face_tags(&unresolved, None, exec_state, args).await?;
266        return Ok(Some(DistanceEntity::Specifier(edge_reference)));
267    }
268
269    DistanceEntity::from_kcl_val(&value)
270        .map(Some)
271        .ok_or_else(|| {
272            KclError::new_type(KclErrorDetails::new(
273                format!(
274                    "`{arg_name}` must be a face, tagged face, tagged edge, edge UUID, or edge specifier object (e.g. {{ sideFaces = [...], endFaces = [...], index = 0 }})"
275                ),
276                vec![args.source_range],
277            ))
278        })
279}
280
281async fn parse_gdt_edges_arg(exec_state: &mut ExecState, args: &Args) -> Result<Vec<GdtEdgeReference>, KclError> {
282    // Face API edge specifiers are object-shaped payloads, so keep the runtime type
283    // broad here and validate each element below. This mirrors fillet/chamfer.
284    let Some(edges): Option<Vec<KclValue>> = args.get_kw_arg_opt("edges", &RuntimeType::any_array(), exec_state)?
285    else {
286        return Ok(Vec::new());
287    };
288
289    if edges.is_empty() {
290        return Err(KclError::new_semantic(KclErrorDetails::new(
291            "`edges` must contain at least one edge.".to_owned(),
292            vec![args.source_range],
293        )));
294    }
295
296    let mut parsed_edges = Vec::with_capacity(edges.len());
297    for edge_value in &edges {
298        if edge::is_edge_specifier_object(edge_value) {
299            let unresolved = edge::parse_edge_specifier_value(edge_value, args)?;
300            let edge_reference =
301                edge::resolve_edge_specifier_with_face_tags(&unresolved, None, exec_state, args).await?;
302            parsed_edges.push(GdtEdgeReference::Specifier(edge_reference));
303        } else if let Some(edge) = EdgeReference::from_kcl_val(edge_value) {
304            parsed_edges.push(GdtEdgeReference::Entity(edge));
305        } else {
306            return Err(KclError::new_type(KclErrorDetails::new(
307                "edges must contain tagged edges, edge UUIDs, or edge specifier objects (e.g. { sideFaces = [...], endFaces = [...], index = 0 })".to_owned(),
308                vec![args.source_range],
309            )));
310        }
311    }
312    Ok(parsed_edges)
313}
314
315pub async fn datum(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
316    let face: TagIdentifier = args.get_kw_arg("face", &RuntimeType::tagged_face(), exec_state)?;
317    let name: String = args.get_kw_arg("name", &RuntimeType::string(), exec_state)?;
318    let frame_position: Option<[TyF64; 2]> =
319        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
320    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
321    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
322    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
323
324    let annotation = inner_datum(
325        face,
326        name,
327        frame_position,
328        frame_plane,
329        leader_scale,
330        font_size,
331        exec_state,
332        &args,
333    )
334    .await?;
335    Ok(KclValue::GdtAnnotation {
336        value: Box::new(annotation),
337    })
338}
339
340#[allow(clippy::too_many_arguments)]
341async fn inner_datum(
342    face: TagIdentifier,
343    name: String,
344    frame_position: Option<[TyF64; 2]>,
345    frame_plane: Option<Plane>,
346    leader_scale: Option<TyF64>,
347    font_size: Option<TyF64>,
348    exec_state: &mut ExecState,
349    args: &Args,
350) -> Result<GdtAnnotation, KclError> {
351    const DATUM_LENGTH_ERROR: &str = "Datum name must be a single character.";
352    if name.len() > 1 {
353        return Err(KclError::new_semantic(KclErrorDetails::new(
354            DATUM_LENGTH_ERROR.to_owned(),
355            vec![args.source_range],
356        )));
357    }
358    let name_char = name.chars().next().ok_or_else(|| {
359        KclError::new_semantic(KclErrorDetails::new(
360            DATUM_LENGTH_ERROR.to_owned(),
361            vec![args.source_range],
362        ))
363    })?;
364    let mut frame_plane = if let Some(plane) = frame_plane {
365        plane
366    } else {
367        // No plane given. Use one of the standard planes.
368        xy_plane(exec_state, args).await?
369    };
370    ensure_sketch_plane_in_engine(
371        &mut frame_plane,
372        exec_state,
373        &args.ctx,
374        args.source_range,
375        args.node_path.clone(),
376    )
377    .await?;
378    let face_id = args.get_adjacent_face_to_tag(exec_state, &face, false).await?;
379    let meta = vec![Metadata::from(args.source_range)];
380    let annotation_id = exec_state.next_uuid();
381    let feature_control = AnnotationFeatureControl::builder()
382        .maybe_entity_id(Some(face_id))
383        // Point to the center of the face.
384        .entity_pos(KPoint2d { x: 0.5, y: 0.5 })
385        .leader_type(AnnotationLineEnd::Dot)
386        .defined_datum(name_char)
387        .plane_id(frame_plane.id)
388        .offset(if let Some(offset) = &frame_position {
389            KPoint2d {
390                x: offset[0].to_mm(),
391                y: offset[1].to_mm(),
392            }
393        } else {
394            KPoint2d { x: 100.0, y: 100.0 }
395        })
396        .precision(0)
397        .font_scale(gdt_font_scale(font_size.as_ref(), args)?)
398        .font_point_size(GDT_FONT_TEXTURE_POINT_SIZE)
399        .leader_scale(gdt_dot_leader_scale(leader_scale.as_ref(), font_size.as_ref(), args)?)
400        .build();
401    exec_state
402        .batch_modeling_cmd(
403            ModelingCmdMeta::from_args_id(exec_state, args, annotation_id),
404            ModelingCmd::from(
405                mcmd::NewAnnotation::builder()
406                    .options(AnnotationOptions::builder().feature_control(feature_control).build())
407                    .clobber(false)
408                    .annotation_type(AnnotationType::T3D)
409                    .build(),
410            ),
411        )
412        .await?;
413    add_gdt_annotation_artifact(exec_state, args, annotation_id);
414    Ok(GdtAnnotation {
415        id: annotation_id,
416        meta,
417    })
418}
419
420pub async fn note(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
421    let note: String = args.get_kw_arg("note", &RuntimeType::string(), exec_state)?;
422    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
423    let frame_position: Option<[TyF64; 2]> =
424        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
425    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
426
427    let annotation = inner_note(note, frame_plane, frame_position, font_size, exec_state, &args).await?;
428    Ok(KclValue::GdtAnnotation {
429        value: Box::new(annotation),
430    })
431}
432
433async fn inner_note(
434    note: String,
435    frame_plane: Option<Plane>,
436    frame_position: Option<[TyF64; 2]>,
437    font_size: Option<TyF64>,
438    exec_state: &mut ExecState,
439    args: &Args,
440) -> Result<GdtAnnotation, KclError> {
441    let mut frame_plane = if let Some(plane) = frame_plane {
442        plane
443    } else {
444        // No plane given. Default to the world XY plane.
445        xy_plane(exec_state, args).await?
446    };
447    ensure_sketch_plane_in_engine(
448        &mut frame_plane,
449        exec_state,
450        &args.ctx,
451        args.source_range,
452        args.node_path.clone(),
453    )
454    .await?;
455    let meta = vec![Metadata::from(args.source_range)];
456    let annotation_id = exec_state.next_uuid();
457    // A note does not attach to a face. Passing the plane as the entity tells the engine to
458    // place the note inline on that plane with no leader (an MBD free note).
459    let feature_tag = AnnotationFeatureTag::builder()
460        .maybe_entity_id(Some(frame_plane.id))
461        .entity_pos(KPoint2d { x: 0.0, y: 0.0 })
462        .leader_type(AnnotationLineEnd::None)
463        .key(String::new())
464        .value(note)
465        .show_key(false)
466        .plane_id(frame_plane.id)
467        .offset(if let Some(offset) = &frame_position {
468            KPoint2d {
469                x: offset[0].to_mm(),
470                y: offset[1].to_mm(),
471            }
472        } else {
473            KPoint2d { x: 100.0, y: 100.0 }
474        })
475        .font_scale(gdt_font_scale(font_size.as_ref(), args)?)
476        .font_point_size(GDT_FONT_TEXTURE_POINT_SIZE)
477        .leader_scale(1.0)
478        .build();
479    exec_state
480        .batch_modeling_cmd(
481            ModelingCmdMeta::from_args_id(exec_state, args, annotation_id),
482            ModelingCmd::from(
483                mcmd::NewAnnotation::builder()
484                    .options(AnnotationOptions::builder().feature_tag(feature_tag).build())
485                    .clobber(false)
486                    .annotation_type(AnnotationType::T3D)
487                    .build(),
488            ),
489        )
490        .await?;
491    add_gdt_annotation_artifact(exec_state, args, annotation_id);
492    Ok(GdtAnnotation {
493        id: annotation_id,
494        meta,
495    })
496}
497
498pub async fn flatness(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
499    let faces: Vec<TagIdentifier> = args.get_kw_arg(
500        "faces",
501        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
502        exec_state,
503    )?;
504    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
505    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
506    let frame_position: Option<[TyF64; 2]> =
507        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
508    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
509    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
510    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
511
512    let annotations = create_feature_control_annotations(
513        GdtFeatureControlKind::Flatness,
514        GdtFeatureControlParams {
515            faces,
516            edges: Vec::new(),
517            datums: None,
518            tolerance,
519            precision,
520            frame_position,
521            frame_plane,
522            leader_scale,
523            font_size,
524        },
525        exec_state,
526        &args,
527    )
528    .await?;
529    Ok(annotations.into())
530}
531
532pub async fn straightness(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
533    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
534        "faces",
535        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
536        exec_state,
537    )?;
538    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
539    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
540    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
541    let frame_position: Option<[TyF64; 2]> =
542        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
543    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
544    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
545    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
546
547    let annotations = create_feature_control_annotations(
548        GdtFeatureControlKind::Straightness,
549        GdtFeatureControlParams {
550            faces: faces.unwrap_or_default(),
551            edges,
552            datums: None,
553            tolerance,
554            precision,
555            frame_position,
556            frame_plane,
557            leader_scale,
558            font_size,
559        },
560        exec_state,
561        &args,
562    )
563    .await?;
564    Ok(annotations.into())
565}
566
567pub async fn circularity(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
568    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
569        "faces",
570        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
571        exec_state,
572    )?;
573    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
574    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
575    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
576    let frame_position: Option<[TyF64; 2]> =
577        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
578    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
579    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
580    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
581
582    let annotations = create_feature_control_annotations(
583        GdtFeatureControlKind::Circularity,
584        GdtFeatureControlParams {
585            faces: faces.unwrap_or_default(),
586            edges,
587            datums: None,
588            tolerance,
589            precision,
590            frame_position,
591            frame_plane,
592            leader_scale,
593            font_size,
594        },
595        exec_state,
596        &args,
597    )
598    .await?;
599    Ok(annotations.into())
600}
601
602pub async fn cylindricity(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
603    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
604        "faces",
605        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
606        exec_state,
607    )?;
608    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
609    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
610    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
611    let frame_position: Option<[TyF64; 2]> =
612        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
613    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
614    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
615    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
616
617    let annotations = create_feature_control_annotations(
618        GdtFeatureControlKind::Cylindricity,
619        GdtFeatureControlParams {
620            faces: faces.unwrap_or_default(),
621            edges,
622            datums: None,
623            tolerance,
624            precision,
625            frame_position,
626            frame_plane,
627            leader_scale,
628            font_size,
629        },
630        exec_state,
631        &args,
632    )
633    .await?;
634    Ok(annotations.into())
635}
636
637pub async fn concentricity(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
638    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
639        "faces",
640        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
641        exec_state,
642    )?;
643    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
644    let datums: Vec<String> = args.get_kw_arg(
645        "datums",
646        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
647        exec_state,
648    )?;
649    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
650    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
651    let frame_position: Option<[TyF64; 2]> =
652        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
653    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
654    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
655    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
656
657    let annotations = create_feature_control_annotations(
658        GdtFeatureControlKind::Concentricity,
659        GdtFeatureControlParams {
660            faces: faces.unwrap_or_default(),
661            edges,
662            datums: Some(datums),
663            tolerance,
664            precision,
665            frame_position,
666            frame_plane,
667            leader_scale,
668            font_size,
669        },
670        exec_state,
671        &args,
672    )
673    .await?;
674    Ok(annotations.into())
675}
676
677pub async fn symmetry(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
678    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
679        "faces",
680        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
681        exec_state,
682    )?;
683    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
684    let datums: Vec<String> = args.get_kw_arg(
685        "datums",
686        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
687        exec_state,
688    )?;
689    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
690    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
691    let frame_position: Option<[TyF64; 2]> =
692        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
693    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
694    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
695    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
696
697    let annotations = create_feature_control_annotations(
698        GdtFeatureControlKind::Symmetry,
699        GdtFeatureControlParams {
700            faces: faces.unwrap_or_default(),
701            edges,
702            datums: Some(datums),
703            tolerance,
704            precision,
705            frame_position,
706            frame_plane,
707            leader_scale,
708            font_size,
709        },
710        exec_state,
711        &args,
712    )
713    .await?;
714    Ok(annotations.into())
715}
716
717pub async fn runout(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
718    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
719        "faces",
720        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
721        exec_state,
722    )?;
723    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
724    let datums: Vec<String> = args.get_kw_arg(
725        "datums",
726        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
727        exec_state,
728    )?;
729    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
730    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
731    let frame_position: Option<[TyF64; 2]> =
732        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
733    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
734    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
735    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
736
737    let annotations = create_feature_control_annotations(
738        GdtFeatureControlKind::Runout,
739        GdtFeatureControlParams {
740            faces: faces.unwrap_or_default(),
741            edges,
742            datums: Some(datums),
743            tolerance,
744            precision,
745            frame_position,
746            frame_plane,
747            leader_scale,
748            font_size,
749        },
750        exec_state,
751        &args,
752    )
753    .await?;
754    Ok(annotations.into())
755}
756
757pub async fn profile_line(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
758    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
759    let params = profile_common_params(&args, exec_state)?;
760
761    let annotations = inner_profile_line(edges, params, exec_state, &args).await?;
762    Ok(annotations.into())
763}
764
765pub async fn profile_surface(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
766    let faces: Vec<TagIdentifier> = args.get_kw_arg(
767        "faces",
768        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
769        exec_state,
770    )?;
771    let params = profile_common_params(&args, exec_state)?;
772
773    let annotations = inner_profile_surface(faces, params, exec_state, &args).await?;
774    Ok(annotations.into())
775}
776
777/// Backwards-compatible implementation for the historical `gdt::profile` KCL function.
778///
779/// New KCL should call `gdt::profileLine` for edges or `gdt::profileSurface` for faces.
780/// Keep the dispatch explicit so invalid combinations produce semantic KCL errors
781/// instead of silently choosing one entity type.
782pub async fn profile(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
783    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
784        "faces",
785        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
786        exec_state,
787    )?;
788    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
789
790    let annotations = match (!edges.is_empty(), faces) {
791        (true, None) => {
792            let params = profile_common_params(&args, exec_state)?;
793            inner_profile_line(edges, params, exec_state, &args).await?
794        }
795        (false, Some(faces)) => {
796            let params = profile_common_params(&args, exec_state)?;
797            inner_profile_surface(faces, params, exec_state, &args).await?
798        }
799        (true, Some(_)) => {
800            return Err(KclError::new_semantic(KclErrorDetails::new(
801                "Profile cannot combine `edges` and `faces`. Use `profileLine` for edges or `profileSurface` for faces."
802                    .to_owned(),
803                vec![args.source_range],
804            )));
805        }
806        (false, None) => {
807            return Err(KclError::new_semantic(KclErrorDetails::new(
808                "Profile requires either `edges` for `profileLine` or `faces` for `profileSurface`.".to_owned(),
809                vec![args.source_range],
810            )));
811        }
812    };
813
814    Ok(annotations.into())
815}
816
817fn profile_common_params(args: &Args, exec_state: &mut ExecState) -> Result<GdtProfileCommonParams, KclError> {
818    let datums: Option<Vec<String>> = args.get_kw_arg_opt(
819        "datums",
820        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
821        exec_state,
822    )?;
823    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
824    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
825    let frame_position: Option<[TyF64; 2]> =
826        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
827    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
828    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
829    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
830
831    Ok(GdtProfileCommonParams {
832        datums,
833        tolerance,
834        precision,
835        frame_position,
836        frame_plane,
837        leader_scale,
838        font_size,
839    })
840}
841
842async fn inner_profile_line(
843    edges: Vec<GdtEdgeReference>,
844    params: GdtProfileCommonParams,
845    exec_state: &mut ExecState,
846    args: &Args,
847) -> Result<Vec<GdtAnnotation>, KclError> {
848    create_feature_control_annotations(
849        GdtFeatureControlKind::ProfileLine,
850        GdtFeatureControlParams {
851            faces: Vec::new(),
852            edges,
853            datums: params.datums,
854            tolerance: params.tolerance,
855            precision: params.precision,
856            frame_position: params.frame_position,
857            frame_plane: params.frame_plane,
858            leader_scale: params.leader_scale,
859            font_size: params.font_size,
860        },
861        exec_state,
862        args,
863    )
864    .await
865}
866
867async fn inner_profile_surface(
868    faces: Vec<TagIdentifier>,
869    params: GdtProfileCommonParams,
870    exec_state: &mut ExecState,
871    args: &Args,
872) -> Result<Vec<GdtAnnotation>, KclError> {
873    create_feature_control_annotations(
874        GdtFeatureControlKind::ProfileSurface,
875        GdtFeatureControlParams {
876            faces,
877            edges: Vec::new(),
878            datums: params.datums,
879            tolerance: params.tolerance,
880            precision: params.precision,
881            frame_position: params.frame_position,
882            frame_plane: params.frame_plane,
883            leader_scale: params.leader_scale,
884            font_size: params.font_size,
885        },
886        exec_state,
887        args,
888    )
889    .await
890}
891
892pub async fn position(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
893    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
894        "faces",
895        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
896        exec_state,
897    )?;
898    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
899    let datums: Option<Vec<String>> = args.get_kw_arg_opt(
900        "datums",
901        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
902        exec_state,
903    )?;
904    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
905    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
906    let frame_position: Option<[TyF64; 2]> =
907        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
908    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
909    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
910    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
911
912    let annotations = create_feature_control_annotations(
913        GdtFeatureControlKind::Position,
914        GdtFeatureControlParams {
915            faces: faces.unwrap_or_default(),
916            edges,
917            datums,
918            tolerance,
919            precision,
920            frame_position,
921            frame_plane,
922            leader_scale,
923            font_size,
924        },
925        exec_state,
926        &args,
927    )
928    .await?;
929    Ok(annotations.into())
930}
931
932pub async fn distance(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
933    let from = parse_distance_entity_arg("from", exec_state, &args).await?;
934    let to = parse_distance_entity_arg("to", exec_state, &args).await?;
935    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
936    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
937    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
938    let frame_position: Option<[TyF64; 2]> =
939        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
940    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
941    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
942    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
943
944    let annotations = inner_distance(
945        from,
946        to,
947        edges,
948        tolerance,
949        precision,
950        frame_position,
951        frame_plane,
952        leader_scale,
953        font_size,
954        exec_state,
955        &args,
956    )
957    .await?;
958    Ok(annotations.into())
959}
960
961#[allow(clippy::too_many_arguments)]
962async fn inner_distance(
963    from: Option<DistanceEntity>,
964    to: Option<DistanceEntity>,
965    edges: Vec<GdtEdgeReference>,
966    tolerance: TyF64,
967    precision: Option<TyF64>,
968    frame_position: Option<[TyF64; 2]>,
969    frame_plane: Option<Plane>,
970    leader_scale: Option<TyF64>,
971    font_size: Option<TyF64>,
972    exec_state: &mut ExecState,
973    args: &Args,
974) -> Result<Vec<GdtAnnotation>, KclError> {
975    let precision = resolve_precision(precision, args)?;
976    let mut frame_plane = if let Some(plane) = frame_plane {
977        plane
978    } else {
979        xy_plane(exec_state, args).await?
980    };
981    ensure_sketch_plane_in_engine(
982        &mut frame_plane,
983        exec_state,
984        &args.ctx,
985        args.source_range,
986        args.node_path.clone(),
987    )
988    .await?;
989
990    if from.is_some() || to.is_some() {
991        if !edges.is_empty() {
992            return Err(KclError::new_semantic(KclErrorDetails::new(
993                "Distance cannot combine `from`/`to` with `edges`.".to_owned(),
994                vec![args.source_range],
995            )));
996        }
997
998        let (Some(from), Some(to)) = (from, to) else {
999            return Err(KclError::new_semantic(KclErrorDetails::new(
1000                "Distance requires both `from` and `to` when measuring between entities.".to_owned(),
1001                vec![args.source_range],
1002            )));
1003        };
1004
1005        let from = from.to_endpoint(exec_state, args).await?;
1006        let to = to.to_endpoint(exec_state, args).await?;
1007        let mut annotations = Vec::with_capacity(1);
1008        create_basic_distance_annotation(
1009            from,
1010            to,
1011            &tolerance,
1012            precision,
1013            frame_position.as_ref(),
1014            frame_plane.id,
1015            leader_scale.as_ref(),
1016            font_size.as_ref(),
1017            exec_state,
1018            args,
1019            &mut annotations,
1020        )
1021        .await?;
1022        return Ok(annotations);
1023    }
1024
1025    if edges.is_empty() {
1026        return Err(KclError::new_semantic(KclErrorDetails::new(
1027            "Distance requires either `edges` or both `from` and `to`.".to_owned(),
1028            vec![args.source_range],
1029        )));
1030    }
1031
1032    let mut annotations = Vec::with_capacity(edges.len());
1033    for edge in &edges {
1034        let (entity_id, edge_reference) = match edge {
1035            GdtEdgeReference::Entity(edge) => (Some(edge.get_engine_id(exec_state, args)?), None),
1036            GdtEdgeReference::Specifier(edge_reference) => (None, Some(edge_reference.clone())),
1037        };
1038        create_basic_distance_annotation(
1039            DistanceEndpoint {
1040                entity_id,
1041                edge_reference: edge_reference.clone(),
1042                entity_pos: KPoint2d { x: 0.0, y: 0.0 },
1043            },
1044            DistanceEndpoint {
1045                entity_id,
1046                edge_reference,
1047                entity_pos: KPoint2d { x: 1.0, y: 0.0 },
1048            },
1049            &tolerance,
1050            precision,
1051            frame_position.as_ref(),
1052            frame_plane.id,
1053            leader_scale.as_ref(),
1054            font_size.as_ref(),
1055            exec_state,
1056            args,
1057            &mut annotations,
1058        )
1059        .await?;
1060    }
1061    Ok(annotations)
1062}
1063
1064#[allow(clippy::too_many_arguments)]
1065async fn create_basic_distance_annotation(
1066    from: DistanceEndpoint,
1067    to: DistanceEndpoint,
1068    tolerance: &TyF64,
1069    precision: u32,
1070    frame_position: Option<&[TyF64; 2]>,
1071    frame_plane_id: uuid::Uuid,
1072    leader_scale: Option<&TyF64>,
1073    font_size: Option<&TyF64>,
1074    exec_state: &mut ExecState,
1075    args: &Args,
1076    annotations: &mut Vec<GdtAnnotation>,
1077) -> Result<(), KclError> {
1078    let meta = vec![Metadata::from(args.source_range)];
1079    let annotation_id = exec_state.next_uuid();
1080    let display_units = exec_state.length_unit();
1081    let dimension = AnnotationBasicDimension::builder()
1082        .maybe_from_entity_id(from.entity_id)
1083        .maybe_from_edge_reference(from.edge_reference)
1084        .from_entity_pos(from.entity_pos)
1085        .maybe_to_entity_id(to.entity_id)
1086        .maybe_to_edge_reference(to.edge_reference)
1087        .to_entity_pos(to.entity_pos)
1088        .dimension(
1089            AnnotationMbdBasicDimension::builder()
1090                .tolerance(tolerance.to_length_units(display_units))
1091                .build(),
1092        )
1093        .plane_id(frame_plane_id)
1094        .offset(if let Some(offset) = frame_position {
1095            KPoint2d {
1096                x: offset[0].to_mm(),
1097                y: offset[1].to_mm(),
1098            }
1099        } else {
1100            KPoint2d { x: 100.0, y: 100.0 }
1101        })
1102        .precision(precision)
1103        .font_scale(gdt_font_scale(font_size, args)?)
1104        .font_point_size(GDT_FONT_TEXTURE_POINT_SIZE)
1105        .arrow_scale(gdt_dimension_leader_scale(leader_scale, args)?)
1106        .build();
1107    let options = AnnotationOptions::builder()
1108        .dimension(dimension)
1109        .units(display_units.to_kcmc())
1110        .build();
1111    let annotation_cmd = ModelingCmd::from(
1112        mcmd::NewAnnotation::builder()
1113            .options(options)
1114            .clobber(false)
1115            .annotation_type(AnnotationType::T3D)
1116            .build(),
1117    );
1118    let cmd_meta = ModelingCmdMeta::from_args_id(exec_state, args, annotation_id);
1119    exec_state.batch_modeling_cmd(cmd_meta, annotation_cmd).await?;
1120    add_gdt_annotation_artifact(exec_state, args, annotation_id);
1121    annotations.push(GdtAnnotation {
1122        id: annotation_id,
1123        meta,
1124    });
1125    Ok(())
1126}
1127
1128pub async fn angularity(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
1129    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
1130        "faces",
1131        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
1132        exec_state,
1133    )?;
1134    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
1135    let datums: Option<Vec<String>> = args.get_kw_arg_opt(
1136        "datums",
1137        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
1138        exec_state,
1139    )?;
1140    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
1141    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
1142    let frame_position: Option<[TyF64; 2]> =
1143        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
1144    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
1145    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
1146    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
1147
1148    let annotations = create_feature_control_annotations(
1149        GdtFeatureControlKind::Angularity,
1150        GdtFeatureControlParams {
1151            faces: faces.unwrap_or_default(),
1152            edges,
1153            datums,
1154            tolerance,
1155            precision,
1156            frame_position,
1157            frame_plane,
1158            leader_scale,
1159            font_size,
1160        },
1161        exec_state,
1162        &args,
1163    )
1164    .await?;
1165    Ok(annotations.into())
1166}
1167
1168pub async fn perpendicularity(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
1169    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
1170        "faces",
1171        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
1172        exec_state,
1173    )?;
1174    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
1175    let datums: Option<Vec<String>> = args.get_kw_arg_opt(
1176        "datums",
1177        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
1178        exec_state,
1179    )?;
1180    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
1181    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
1182    let frame_position: Option<[TyF64; 2]> =
1183        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
1184    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
1185    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
1186    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
1187
1188    let annotations = create_feature_control_annotations(
1189        GdtFeatureControlKind::Perpendicularity,
1190        GdtFeatureControlParams {
1191            faces: faces.unwrap_or_default(),
1192            edges,
1193            datums,
1194            tolerance,
1195            precision,
1196            frame_position,
1197            frame_plane,
1198            leader_scale,
1199            font_size,
1200        },
1201        exec_state,
1202        &args,
1203    )
1204    .await?;
1205    Ok(annotations.into())
1206}
1207
1208pub async fn parallelism(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
1209    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
1210        "faces",
1211        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
1212        exec_state,
1213    )?;
1214    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
1215    let datums: Option<Vec<String>> = args.get_kw_arg_opt(
1216        "datums",
1217        &RuntimeType::Array(Box::new(RuntimeType::string()), ArrayLen::Minimum(1)),
1218        exec_state,
1219    )?;
1220    let tolerance = args.get_kw_arg("tolerance", &RuntimeType::length(), exec_state)?;
1221    let precision = args.get_kw_arg_opt("precision", &RuntimeType::count(), exec_state)?;
1222    let frame_position: Option<[TyF64; 2]> =
1223        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
1224    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
1225    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
1226    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
1227
1228    let annotations = create_feature_control_annotations(
1229        GdtFeatureControlKind::Parallelism,
1230        GdtFeatureControlParams {
1231            faces: faces.unwrap_or_default(),
1232            edges,
1233            datums,
1234            tolerance,
1235            precision,
1236            frame_position,
1237            frame_plane,
1238            leader_scale,
1239            font_size,
1240        },
1241        exec_state,
1242        &args,
1243    )
1244    .await?;
1245    Ok(annotations.into())
1246}
1247
1248pub async fn annotation(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
1249    let annotation: String = args.get_kw_arg("annotation", &RuntimeType::string(), exec_state)?;
1250    let faces: Option<Vec<TagIdentifier>> = args.get_kw_arg_opt(
1251        "faces",
1252        &RuntimeType::Array(Box::new(RuntimeType::tagged_face()), ArrayLen::Minimum(1)),
1253        exec_state,
1254    )?;
1255    let edges = parse_gdt_edges_arg(exec_state, &args).await?;
1256    let frame_position: Option<[TyF64; 2]> =
1257        args.get_kw_arg_opt("framePosition", &RuntimeType::point2d(), exec_state)?;
1258    let frame_plane: Option<Plane> = args.get_kw_arg_opt("framePlane", &RuntimeType::plane(), exec_state)?;
1259    let leader_scale: Option<TyF64> = args.get_kw_arg_opt("leaderScale", &RuntimeType::count(), exec_state)?;
1260    let font_size: Option<TyF64> = args.get_kw_arg_opt("fontSize", &RuntimeType::length(), exec_state)?;
1261
1262    let annotations = inner_annotation(
1263        annotation,
1264        faces.unwrap_or_default(),
1265        edges,
1266        frame_position,
1267        frame_plane,
1268        leader_scale,
1269        font_size,
1270        exec_state,
1271        &args,
1272    )
1273    .await?;
1274    Ok(annotations.into())
1275}
1276
1277#[allow(clippy::too_many_arguments)]
1278async fn inner_annotation(
1279    annotation: String,
1280    faces: Vec<TagIdentifier>,
1281    edges: Vec<GdtEdgeReference>,
1282    frame_position: Option<[TyF64; 2]>,
1283    frame_plane: Option<Plane>,
1284    leader_scale: Option<TyF64>,
1285    font_size: Option<TyF64>,
1286    exec_state: &mut ExecState,
1287    args: &Args,
1288) -> Result<Vec<GdtAnnotation>, KclError> {
1289    if annotation.is_empty() {
1290        return Err(KclError::new_semantic(KclErrorDetails::new(
1291            "Annotation text must not be empty.".to_owned(),
1292            vec![args.source_range],
1293        )));
1294    }
1295    if faces.is_empty() && edges.is_empty() {
1296        return Err(KclError::new_semantic(KclErrorDetails::new(
1297            "Annotation requires at least one face or edge.".to_owned(),
1298            vec![args.source_range],
1299        )));
1300    }
1301
1302    let mut frame_plane = if let Some(plane) = frame_plane {
1303        plane
1304    } else {
1305        xy_plane(exec_state, args).await?
1306    };
1307    ensure_sketch_plane_in_engine(
1308        &mut frame_plane,
1309        exec_state,
1310        &args.ctx,
1311        args.source_range,
1312        args.node_path.clone(),
1313    )
1314    .await?;
1315
1316    let mut annotations = Vec::with_capacity(faces.len() + edges.len());
1317    for face in &faces {
1318        let face_id = args.get_adjacent_face_to_tag(exec_state, face, false).await?;
1319        create_annotation(
1320            Some(face_id),
1321            None,
1322            &annotation,
1323            frame_position.as_ref(),
1324            frame_plane.id,
1325            leader_scale.as_ref(),
1326            font_size.as_ref(),
1327            exec_state,
1328            args,
1329            &mut annotations,
1330        )
1331        .await?;
1332    }
1333    for edge in &edges {
1334        match edge {
1335            GdtEdgeReference::Entity(edge) => {
1336                create_annotation(
1337                    Some(edge.get_engine_id(exec_state, args)?),
1338                    None,
1339                    &annotation,
1340                    frame_position.as_ref(),
1341                    frame_plane.id,
1342                    leader_scale.as_ref(),
1343                    font_size.as_ref(),
1344                    exec_state,
1345                    args,
1346                    &mut annotations,
1347                )
1348                .await?;
1349            }
1350            GdtEdgeReference::Specifier(edge_reference) => {
1351                create_annotation(
1352                    None,
1353                    Some(edge_reference.clone()),
1354                    &annotation,
1355                    frame_position.as_ref(),
1356                    frame_plane.id,
1357                    leader_scale.as_ref(),
1358                    font_size.as_ref(),
1359                    exec_state,
1360                    args,
1361                    &mut annotations,
1362                )
1363                .await?;
1364            }
1365        }
1366    }
1367
1368    Ok(annotations)
1369}
1370
1371fn resolve_precision(precision: Option<TyF64>, args: &Args) -> Result<u32, KclError> {
1372    if let Some(precision) = precision {
1373        let rounded = precision.n.round();
1374        if !(0.0..=9.0).contains(&rounded) {
1375            return Err(KclError::new_semantic(KclErrorDetails::new(
1376                "Precision must be between 0 and 9".to_owned(),
1377                vec![args.source_range],
1378            )));
1379        }
1380        Ok(rounded as u32)
1381    } else {
1382        Ok(3)
1383    }
1384}
1385
1386async fn resolve_gdt_frame_plane(
1387    frame_plane: Option<Plane>,
1388    exec_state: &mut ExecState,
1389    args: &Args,
1390) -> Result<Plane, KclError> {
1391    let mut frame_plane = if let Some(plane) = frame_plane {
1392        plane
1393    } else {
1394        // No plane given. Use one of the standard planes.
1395        xy_plane(exec_state, args).await?
1396    };
1397    ensure_sketch_plane_in_engine(
1398        &mut frame_plane,
1399        exec_state,
1400        &args.ctx,
1401        args.source_range,
1402        args.node_path.clone(),
1403    )
1404    .await?;
1405    Ok(frame_plane)
1406}
1407
1408async fn create_feature_control_annotations(
1409    kind: GdtFeatureControlKind,
1410    params: GdtFeatureControlParams,
1411    exec_state: &mut ExecState,
1412    args: &Args,
1413) -> Result<Vec<GdtAnnotation>, KclError> {
1414    let GdtFeatureControlParams {
1415        faces,
1416        edges,
1417        datums,
1418        tolerance,
1419        precision,
1420        frame_position,
1421        frame_plane,
1422        leader_scale,
1423        font_size,
1424    } = params;
1425
1426    if faces.is_empty() && edges.is_empty() {
1427        return Err(KclError::new_semantic(KclErrorDetails::new(
1428            format!("{} requires at least one face or edge.", kind.label()),
1429            vec![args.source_range],
1430        )));
1431    }
1432
1433    let precision = resolve_precision(precision, args)?;
1434    let datums = resolve_datums(datums, args, kind.label())?;
1435    if kind.requires_datums() && datums.is_empty() {
1436        return Err(KclError::new_semantic(KclErrorDetails::new(
1437            format!("{} requires at least one datum.", kind.label()),
1438            vec![args.source_range],
1439        )));
1440    }
1441    let frame_plane = resolve_gdt_frame_plane(frame_plane, exec_state, args).await?;
1442    let symbol = kind.symbol();
1443    let diameter_symbol = kind.diameter_symbol();
1444
1445    let mut annotations = Vec::with_capacity(faces.len() + edges.len());
1446    for face in &faces {
1447        let face_id = args.get_adjacent_face_to_tag(exec_state, face, false).await?;
1448        create_feature_control_annotation(
1449            Some(face_id),
1450            None,
1451            symbol,
1452            diameter_symbol,
1453            &tolerance,
1454            &datums,
1455            precision,
1456            frame_position.as_ref(),
1457            frame_plane.id,
1458            leader_scale.as_ref(),
1459            font_size.as_ref(),
1460            exec_state,
1461            args,
1462            &mut annotations,
1463        )
1464        .await?;
1465    }
1466    for edge in &edges {
1467        match edge {
1468            GdtEdgeReference::Entity(edge) => {
1469                create_feature_control_annotation(
1470                    Some(edge.get_engine_id(exec_state, args)?),
1471                    None,
1472                    symbol,
1473                    diameter_symbol,
1474                    &tolerance,
1475                    &datums,
1476                    precision,
1477                    frame_position.as_ref(),
1478                    frame_plane.id,
1479                    leader_scale.as_ref(),
1480                    font_size.as_ref(),
1481                    exec_state,
1482                    args,
1483                    &mut annotations,
1484                )
1485                .await?;
1486            }
1487            GdtEdgeReference::Specifier(edge_reference) => {
1488                create_feature_control_annotation(
1489                    None,
1490                    Some(edge_reference.clone()),
1491                    symbol,
1492                    diameter_symbol,
1493                    &tolerance,
1494                    &datums,
1495                    precision,
1496                    frame_position.as_ref(),
1497                    frame_plane.id,
1498                    leader_scale.as_ref(),
1499                    font_size.as_ref(),
1500                    exec_state,
1501                    args,
1502                    &mut annotations,
1503                )
1504                .await?;
1505            }
1506        }
1507    }
1508
1509    Ok(annotations)
1510}
1511
1512#[allow(clippy::too_many_arguments)]
1513async fn create_feature_control_annotation(
1514    entity_id: Option<uuid::Uuid>,
1515    edge_reference: Option<kcmc::shared::EdgeSpecifier>,
1516    symbol: MbdSymbol,
1517    diameter_symbol: Option<MbdSymbol>,
1518    tolerance: &TyF64,
1519    datums: &[char],
1520    precision: u32,
1521    frame_position: Option<&[TyF64; 2]>,
1522    frame_plane_id: uuid::Uuid,
1523    leader_scale: Option<&TyF64>,
1524    font_size: Option<&TyF64>,
1525    exec_state: &mut ExecState,
1526    args: &Args,
1527    annotations: &mut Vec<GdtAnnotation>,
1528) -> Result<(), KclError> {
1529    let meta = vec![Metadata::from(args.source_range)];
1530    let annotation_id = exec_state.next_uuid();
1531    let display_units = exec_state.length_unit();
1532    let control_frame = gdt_control_frame(
1533        symbol,
1534        diameter_symbol,
1535        tolerance.to_length_units(display_units),
1536        datums,
1537    );
1538    let feature_control = AnnotationFeatureControl::builder()
1539        .maybe_entity_id(entity_id)
1540        .maybe_edge_reference(edge_reference)
1541        .entity_pos(KPoint2d { x: 0.5, y: 0.5 })
1542        .leader_type(AnnotationLineEnd::Dot)
1543        .control_frame(control_frame)
1544        .plane_id(frame_plane_id)
1545        .offset(if let Some(offset) = frame_position {
1546            KPoint2d {
1547                x: offset[0].to_mm(),
1548                y: offset[1].to_mm(),
1549            }
1550        } else {
1551            KPoint2d { x: 100.0, y: 100.0 }
1552        })
1553        .precision(precision)
1554        .font_scale(gdt_font_scale(font_size, args)?)
1555        .font_point_size(GDT_FONT_TEXTURE_POINT_SIZE)
1556        .leader_scale(gdt_dot_leader_scale(leader_scale, font_size, args)?)
1557        .build();
1558    let options = AnnotationOptions::builder().feature_control(feature_control).build();
1559    exec_state
1560        .batch_modeling_cmd(
1561            ModelingCmdMeta::from_args_id(exec_state, args, annotation_id),
1562            ModelingCmd::from(
1563                mcmd::NewAnnotation::builder()
1564                    .options(options)
1565                    .clobber(false)
1566                    .annotation_type(AnnotationType::T3D)
1567                    .build(),
1568            ),
1569        )
1570        .await?;
1571    add_gdt_annotation_artifact(exec_state, args, annotation_id);
1572    annotations.push(GdtAnnotation {
1573        id: annotation_id,
1574        meta,
1575    });
1576    Ok(())
1577}
1578
1579fn gdt_control_frame(
1580    symbol: MbdSymbol,
1581    diameter_symbol: Option<MbdSymbol>,
1582    tolerance: f64,
1583    datums: &[char],
1584) -> AnnotationMbdControlFrame {
1585    match datums {
1586        [] => AnnotationMbdControlFrame::builder()
1587            .symbol(symbol)
1588            .maybe_diameter_symbol(diameter_symbol)
1589            .tolerance(tolerance)
1590            .build(),
1591        [primary] => AnnotationMbdControlFrame::builder()
1592            .symbol(symbol)
1593            .maybe_diameter_symbol(diameter_symbol)
1594            .tolerance(tolerance)
1595            .primary_datum(*primary)
1596            .build(),
1597        [primary, secondary] => AnnotationMbdControlFrame::builder()
1598            .symbol(symbol)
1599            .maybe_diameter_symbol(diameter_symbol)
1600            .tolerance(tolerance)
1601            .primary_datum(*primary)
1602            .secondary_datum(*secondary)
1603            .build(),
1604        [primary, secondary, tertiary] => AnnotationMbdControlFrame::builder()
1605            .symbol(symbol)
1606            .maybe_diameter_symbol(diameter_symbol)
1607            .tolerance(tolerance)
1608            .primary_datum(*primary)
1609            .secondary_datum(*secondary)
1610            .tertiary_datum(*tertiary)
1611            .build(),
1612        _ => unreachable!("resolve_datums rejects more than three datums"),
1613    }
1614}
1615
1616#[allow(clippy::too_many_arguments)]
1617async fn create_annotation(
1618    entity_id: Option<uuid::Uuid>,
1619    edge_reference: Option<kcmc::shared::EdgeSpecifier>,
1620    annotation: &str,
1621    frame_position: Option<&[TyF64; 2]>,
1622    frame_plane_id: uuid::Uuid,
1623    leader_scale: Option<&TyF64>,
1624    font_size: Option<&TyF64>,
1625    exec_state: &mut ExecState,
1626    args: &Args,
1627    annotations: &mut Vec<GdtAnnotation>,
1628) -> Result<(), KclError> {
1629    let meta = vec![Metadata::from(args.source_range)];
1630    let annotation_id = exec_state.next_uuid();
1631    let feature_control = AnnotationFeatureControl::builder()
1632        .maybe_entity_id(entity_id)
1633        .maybe_edge_reference(edge_reference)
1634        .entity_pos(KPoint2d { x: 0.5, y: 0.5 })
1635        .leader_type(AnnotationLineEnd::Dot)
1636        .prefix(annotation.to_owned())
1637        .plane_id(frame_plane_id)
1638        .offset(if let Some(offset) = frame_position {
1639            KPoint2d {
1640                x: offset[0].to_mm(),
1641                y: offset[1].to_mm(),
1642            }
1643        } else {
1644            KPoint2d { x: 100.0, y: 100.0 }
1645        })
1646        .precision(0)
1647        .font_scale(gdt_font_scale(font_size, args)?)
1648        .font_point_size(GDT_FONT_TEXTURE_POINT_SIZE)
1649        .leader_scale(gdt_dot_leader_scale(leader_scale, font_size, args)?)
1650        .build();
1651    let options = AnnotationOptions::builder().feature_control(feature_control).build();
1652    exec_state
1653        .batch_modeling_cmd(
1654            ModelingCmdMeta::from_args_id(exec_state, args, annotation_id),
1655            ModelingCmd::from(
1656                mcmd::NewAnnotation::builder()
1657                    .options(options)
1658                    .clobber(false)
1659                    .annotation_type(AnnotationType::T3D)
1660                    .build(),
1661            ),
1662        )
1663        .await?;
1664    add_gdt_annotation_artifact(exec_state, args, annotation_id);
1665    annotations.push(GdtAnnotation {
1666        id: annotation_id,
1667        meta,
1668    });
1669    Ok(())
1670}
1671
1672fn resolve_datums(datums: Option<Vec<String>>, args: &Args, annotation_name: &str) -> Result<Vec<char>, KclError> {
1673    let datums = datums.unwrap_or_default();
1674    if datums.len() > 3 {
1675        return Err(KclError::new_semantic(KclErrorDetails::new(
1676            format!("{annotation_name} datums must include at most three names."),
1677            vec![args.source_range],
1678        )));
1679    }
1680
1681    let mut resolved = Vec::with_capacity(datums.len());
1682    for datum in &datums {
1683        let mut chars = datum.chars();
1684        let Some(name) = chars.next() else {
1685            return Err(KclError::new_semantic(KclErrorDetails::new(
1686                format!("{annotation_name} datum names must be a single character."),
1687                vec![args.source_range],
1688            )));
1689        };
1690        if chars.next().is_some() {
1691            return Err(KclError::new_semantic(KclErrorDetails::new(
1692                format!("{annotation_name} datum names must be a single character."),
1693                vec![args.source_range],
1694            )));
1695        }
1696        resolved.push(name);
1697    }
1698
1699    Ok(resolved)
1700}
1701
1702/// Get the XY plane by evaluating the `XY` expression so that it's the same as
1703/// if the user specified `XY`.
1704async fn xy_plane(exec_state: &mut ExecState, args: &Args) -> Result<Plane, KclError> {
1705    let plane_ast = plane_ast("XY", args.source_range);
1706    let metadata = Metadata::from(args.source_range);
1707    let plane_value = args.ctx.eval_expr_fresh_root(&plane_ast, exec_state, &metadata).await?;
1708    // Evaluating a constant name cannot exit().
1709    let plane_value = plane_value.into_value();
1710    Ok(plane_value
1711        .as_plane()
1712        .ok_or_else(|| {
1713            KclError::new_internal(KclErrorDetails::new(
1714                "Expected XY plane to be defined".to_owned(),
1715                vec![args.source_range],
1716            ))
1717        })?
1718        .clone())
1719}
1720
1721/// An AST node for a plane with the given name.
1722fn plane_ast(plane_name: &str, range: SourceRange) -> ast::Node<ast::Expr> {
1723    ast::Node::new(
1724        ast::Expr::Name(BoxNode::new(ast::Node::new(
1725            ast::Name {
1726                name: ast::Identifier::new(plane_name),
1727                path: Vec::new(),
1728                // TODO: We may want to set this to true once we implement it to
1729                // prevent it breaking if users redefine the identifier.
1730                abs_path: false,
1731                digest: None,
1732            },
1733            range.start(),
1734            range.end(),
1735            range.module_id(),
1736        ))),
1737        range.start(),
1738        range.end(),
1739        range.module_id(),
1740    )
1741}
1742
1743#[cfg(test)]
1744mod tests {
1745    use super::*;
1746    use crate::ExecutorContext;
1747    use crate::execution::Artifact;
1748    use crate::execution::ExecutorSettings;
1749    use crate::execution::MockConfig;
1750    use crate::execution::parse_execute;
1751
1752    const GDT_DISTANCE_KCL_TEMPLATE: &str = r#"
1753@settings(defaultLengthUnit = __UNIT__, kclVersion = 2)
1754
1755sketch001 = sketch(on = XY) {
1756  line1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
1757  line2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 10mm])
1758  line3 = line(start = [var 10mm, var 10mm], end = [var 0mm, var 10mm])
1759  line4 = line(start = [var 0mm, var 10mm], end = [var 0mm, var 0mm])
1760  coincident([line1.end, line2.start])
1761  coincident([line2.end, line3.start])
1762  coincident([line3.end, line4.start])
1763  coincident([line4.end, line1.start])
1764  parallel([line2, line4])
1765  parallel([line3, line1])
1766  perpendicular([line1, line2])
1767  horizontal(line3)
1768}
1769
1770region001 = region(point = [5mm, 5mm], sketch = sketch001)
1771extrude001 = extrude(region001, length = 10mm)
1772gdt::distance(
1773  edges = [
1774    getCommonEdge(faces = [
1775      region001.tags.line4,
1776      region001.tags.line1
1777    ])
1778  ],
1779  tolerance = __TOLERANCE__,
1780  framePosition = __FRAME_POSITION__,
1781  fontSize = 2in,
1782)
1783"#;
1784
1785    const GDT_FLATNESS_KCL_TEMPLATE: &str = r#"
1786@settings(defaultLengthUnit = __UNIT__, kclVersion = 2)
1787
1788sketch001 = sketch(on = XY) {
1789  line1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
1790  line2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 10mm])
1791  line3 = line(start = [var 10mm, var 10mm], end = [var 0mm, var 10mm])
1792  line4 = line(start = [var 0mm, var 10mm], end = [var 0mm, var 0mm])
1793  coincident([line1.end, line2.start])
1794  coincident([line2.end, line3.start])
1795  coincident([line3.end, line4.start])
1796  coincident([line4.end, line1.start])
1797  parallel([line2, line4])
1798  parallel([line3, line1])
1799  perpendicular([line1, line2])
1800  horizontal(line3)
1801}
1802
1803region001 = region(point = [5mm, 5mm], sketch = sketch001)
1804extrude001 = extrude(region001, length = 10mm, tagEnd = $capEnd001)
1805gdt::flatness(
1806  faces = [capEnd001],
1807  tolerance = __TOLERANCE__,
1808  framePosition = __FRAME_POSITION__,
1809  framePlane = XZ,
1810  fontSize = 2in,
1811)
1812"#;
1813
1814    fn gdt_distance_kcl(unit: &str, tolerance: &str, frame_position: &str) -> String {
1815        GDT_DISTANCE_KCL_TEMPLATE
1816            .replace("__UNIT__", unit)
1817            .replace("__TOLERANCE__", tolerance)
1818            .replace("__FRAME_POSITION__", frame_position)
1819    }
1820
1821    fn gdt_flatness_kcl(unit: &str, tolerance: &str, frame_position: &str) -> String {
1822        GDT_FLATNESS_KCL_TEMPLATE
1823            .replace("__UNIT__", unit)
1824            .replace("__TOLERANCE__", tolerance)
1825            .replace("__FRAME_POSITION__", frame_position)
1826    }
1827
1828    async fn gdt_commands(code: &str) -> Vec<ModelingCmd> {
1829        let result = parse_execute(code).await.unwrap();
1830        result
1831            .root_module_artifact_commands()
1832            .iter()
1833            .map(|artifact_command| artifact_command.command.clone())
1834            .collect()
1835    }
1836
1837    fn annotation_options(command: &ModelingCmd) -> Result<&AnnotationOptions, KclError> {
1838        let ModelingCmd::NewAnnotation(new_annotation) = command else {
1839            return Err(KclError::new_internal(KclErrorDetails::new(
1840                format!("expected new_annotation command, got {command:?}"),
1841                vec![SourceRange::default()],
1842            )));
1843        };
1844        Ok(&new_annotation.options)
1845    }
1846
1847    fn feature_control(command: &ModelingCmd) -> Result<&AnnotationFeatureControl, KclError> {
1848        let ModelingCmd::NewAnnotation(new_annotation) = command else {
1849            return Err(KclError::new_internal(KclErrorDetails::new(
1850                format!("expected new_annotation command, got {command:?}"),
1851                vec![SourceRange::default()],
1852            )));
1853        };
1854        new_annotation.options.feature_control.as_ref().ok_or_else(|| {
1855            KclError::new_internal(KclErrorDetails::new(
1856                "expected new_annotation command to have a feature_control".to_owned(),
1857                vec![SourceRange::default()],
1858            ))
1859        })
1860    }
1861
1862    fn find_control_frame_with_symbol(
1863        commands: &[ModelingCmd],
1864        symbol: MbdSymbol,
1865    ) -> Result<&AnnotationMbdControlFrame, KclError> {
1866        for command in commands {
1867            if let Ok(feature_control) = feature_control(command)
1868                && let Some(control_frame) = feature_control.control_frame.as_ref()
1869                && control_frame.symbol == symbol
1870            {
1871                return Ok(control_frame);
1872            }
1873        }
1874
1875        Err(KclError::new_internal(KclErrorDetails::new(
1876            format!("expected commands to contain a {symbol:?} control frame"),
1877            vec![SourceRange::default()],
1878        )))
1879    }
1880
1881    #[track_caller]
1882    fn assert_close(actual: f64, expected: f64) {
1883        assert!((actual - expected).abs() < 1e-6, "expected {expected}, got {actual}");
1884    }
1885
1886    fn new_annotation_command_index(commands: &[ModelingCmd]) -> Result<usize, KclError> {
1887        commands
1888            .iter()
1889            .position(|command| matches!(command, ModelingCmd::NewAnnotation(_)))
1890            .ok_or_else(|| {
1891                KclError::new_internal(KclErrorDetails::new(
1892                    "expected commands to contain a new_annotation command".to_owned(),
1893                    vec![SourceRange::default()],
1894                ))
1895            })
1896    }
1897
1898    #[test]
1899    fn gdt_font_scale_is_scene_height_divided_by_calibration_height() {
1900        let scale_at_calibrated_height = gdt_font_scale_for_height_mm(GDT_FONT_SCALE_1_HEIGHT_MM);
1901        assert!((scale_at_calibrated_height - 1.0).abs() < f32::EPSILON);
1902
1903        let double_height_scale = gdt_font_scale_for_height_mm(GDT_FONT_SCALE_1_HEIGHT_MM * 2.0);
1904        assert!((double_height_scale - 2.0).abs() < f32::EPSILON);
1905
1906        let inch_in_mm = 25.4;
1907        let inch_scale = gdt_font_scale_for_height_mm(inch_in_mm);
1908        assert!((inch_scale - (inch_in_mm / GDT_FONT_SCALE_1_HEIGHT_MM) as f32).abs() < f32::EPSILON);
1909    }
1910
1911    const GDT_FLATNESS_LEADER_KCL_TEMPLATE: &str = r#"
1912@settings(defaultLengthUnit = mm, kclVersion = 2)
1913
1914blockProfile = sketch(on = XY) {
1915  edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
1916  edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 10mm])
1917  edge3 = line(start = [var 10mm, var 10mm], end = [var 0mm, var 10mm])
1918  edge4 = line(start = [var 0mm, var 10mm], end = [var 0mm, var 0mm])
1919  coincident([edge1.end, edge2.start])
1920  coincident([edge2.end, edge3.start])
1921  coincident([edge3.end, edge4.start])
1922  coincident([edge4.end, edge1.start])
1923  parallel([edge2, edge4])
1924  parallel([edge3, edge1])
1925  perpendicular([edge1, edge2])
1926  horizontal(edge3)
1927}
1928
1929region001 = region(point = [5mm, 5mm], sketch = blockProfile)
1930extrude001 = extrude(region001, length = 10mm, tagEnd = $top)
1931gdt::flatness(
1932  faces = [top],
1933  tolerance = 0.1mm,
1934  framePosition = [10mm, 0mm],
1935  framePlane = XZ,
1936  fontSize = __FONT_SIZE__
1937  __LEADER_SCALE__
1938)
1939"#;
1940
1941    fn gdt_flatness_leader_kcl(font_size: &str, leader_scale: Option<&str>) -> String {
1942        GDT_FLATNESS_LEADER_KCL_TEMPLATE
1943            .replace("__FONT_SIZE__", font_size)
1944            .replace(
1945                "__LEADER_SCALE__",
1946                leader_scale
1947                    .map(|scale| format!(",\n  leaderScale = {scale}"))
1948                    .unwrap_or_default()
1949                    .as_str(),
1950            )
1951    }
1952
1953    async fn gdt_flatness_feature_control(
1954        font_size: &str,
1955        leader_scale: Option<&str>,
1956    ) -> Result<AnnotationFeatureControl, KclError> {
1957        let code = gdt_flatness_leader_kcl(font_size, leader_scale);
1958        let commands = gdt_commands(&code).await;
1959        let annotation_index = new_annotation_command_index(&commands)?;
1960        Ok(feature_control(&commands[annotation_index])?.clone())
1961    }
1962
1963    #[tokio::test(flavor = "multi_thread")]
1964    async fn gdt_dot_leader_scale_is_normalized_against_font_scale() -> Result<(), KclError> {
1965        let tiny = gdt_flatness_feature_control("1mm", None).await?;
1966        let large = gdt_flatness_feature_control("100mm", None).await?;
1967
1968        assert_close(f64::from(tiny.font_scale), gdt_font_scale_for_height_mm(1.0).into());
1969        assert_close(f64::from(large.font_scale), gdt_font_scale_for_height_mm(100.0).into());
1970        assert_close(f64::from(tiny.leader_scale), 50.0);
1971        assert_close(f64::from(large.leader_scale), 0.5);
1972
1973        assert_close(
1974            f64::from(tiny.font_scale) * f64::from(tiny.leader_scale),
1975            f64::from(gdt_dot_leader_normal_size()),
1976        );
1977        assert_close(
1978            f64::from(large.font_scale) * f64::from(large.leader_scale),
1979            f64::from(gdt_dot_leader_normal_size()),
1980        );
1981        Ok(())
1982    }
1983
1984    #[tokio::test(flavor = "multi_thread")]
1985    async fn explicit_gdt_dot_leader_scale_multiplies_normal_size() -> Result<(), KclError> {
1986        let tiny = gdt_flatness_feature_control("1mm", Some("2")).await?;
1987        let large = gdt_flatness_feature_control("100mm", Some("2")).await?;
1988
1989        let expected_scaled_dot_size = f64::from(gdt_dot_leader_normal_size()) * 2.0;
1990        assert_close(
1991            f64::from(tiny.font_scale) * f64::from(tiny.leader_scale),
1992            expected_scaled_dot_size,
1993        );
1994        assert_close(
1995            f64::from(large.font_scale) * f64::from(large.leader_scale),
1996            expected_scaled_dot_size,
1997        );
1998        Ok(())
1999    }
2000
2001    #[tokio::test(flavor = "multi_thread")]
2002    async fn gdt_flatness_uses_scene_units_for_control_frame_tolerance() -> Result<(), KclError> {
2003        let cases = [
2004            ("in", "0.1in", "[10, -10]", 0.1, 254.0, -254.0),
2005            ("cm", "10mm", "[1, -1]", 1.0, 10.0, -10.0),
2006        ];
2007
2008        for (default_unit, tolerance, frame_position, expected_tolerance, expected_x, expected_y) in cases {
2009            let code = gdt_flatness_kcl(default_unit, tolerance, frame_position);
2010            let commands = gdt_commands(&code).await;
2011            let annotation_index = new_annotation_command_index(&commands)?;
2012            let feature_control = feature_control(&commands[annotation_index])?;
2013            let control_frame = feature_control.control_frame.as_ref().ok_or_else(|| {
2014                KclError::new_internal(KclErrorDetails::new(
2015                    "expected feature_control to have a control_frame".to_owned(),
2016                    vec![SourceRange::default()],
2017                ))
2018            })?;
2019
2020            assert_close(control_frame.tolerance, expected_tolerance);
2021            assert_close(feature_control.offset.x, expected_x);
2022            assert_close(feature_control.offset.y, expected_y);
2023            assert_close(
2024                f64::from(feature_control.font_scale),
2025                gdt_font_scale_for_height_mm(50.8).into(),
2026            );
2027        }
2028        Ok(())
2029    }
2030
2031    #[tokio::test(flavor = "multi_thread")]
2032    async fn gdt_distance_sets_units() -> Result<(), KclError> {
2033        let cases = [
2034            (
2035                "in",
2036                "2.54mm",
2037                "[10, -10]",
2038                kcmc::units::UnitLength::Inches,
2039                0.1,
2040                254.0,
2041                -254.0,
2042            ),
2043            (
2044                "cm",
2045                "10mm",
2046                "[1, -1]",
2047                kcmc::units::UnitLength::Centimeters,
2048                1.0,
2049                10.0,
2050                -10.0,
2051            ),
2052            (
2053                "mm",
2054                "2.54mm",
2055                "[10, -10]",
2056                kcmc::units::UnitLength::Millimeters,
2057                2.54,
2058                10.0,
2059                -10.0,
2060            ),
2061        ];
2062
2063        for (default_unit, tolerance, frame_position, scene_unit, expected_tolerance, expected_x, expected_y) in cases {
2064            let code = gdt_distance_kcl(default_unit, tolerance, frame_position);
2065            let commands = gdt_commands(&code).await;
2066            let annotation_index = new_annotation_command_index(&commands)?;
2067            let options = annotation_options(&commands[annotation_index])?;
2068
2069            assert_eq!(options.units, Some(scene_unit));
2070
2071            let dimension = options
2072                .dimension
2073                .as_ref()
2074                .expect("expected new_annotation command to have a dimension");
2075            assert_close(dimension.dimension.tolerance, expected_tolerance);
2076            assert_close(dimension.offset.x, expected_x);
2077            assert_close(dimension.offset.y, expected_y);
2078            assert_close(
2079                f64::from(dimension.font_scale),
2080                gdt_font_scale_for_height_mm(50.8).into(),
2081            );
2082        }
2083        Ok(())
2084    }
2085
2086    const GDT_FACE_API_EDGE_KCL_TEMPLATE: &str = r#"
2087@settings(defaultLengthUnit = mm, kclVersion = 2)
2088
2089sketch001 = sketch(on = XY) {
2090  line1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
2091  line2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 10mm])
2092  line3 = line(start = [var 10mm, var 10mm], end = [var 0mm, var 10mm])
2093  line4 = line(start = [var 0mm, var 10mm], end = [var 0mm, var 0mm])
2094  coincident([line1.end, line2.start])
2095  coincident([line2.end, line3.start])
2096  coincident([line3.end, line4.start])
2097  coincident([line4.end, line1.start])
2098  parallel([line2, line4])
2099  parallel([line3, line1])
2100  perpendicular([line1, line2])
2101  horizontal(line3)
2102}
2103
2104region001 = region(point = [5mm, 5mm], sketch = sketch001)
2105extrude001 = extrude(region001, length = 10mm, tagStart = $capStart001)
2106__GDT_CALL__
2107"#;
2108
2109    fn gdt_face_api_edge_kcl(gdt_call: &str) -> String {
2110        GDT_FACE_API_EDGE_KCL_TEMPLATE.replace("__GDT_CALL__", gdt_call)
2111    }
2112
2113    fn assert_feature_control_uses_edge_reference(feature_control: &AnnotationFeatureControl) {
2114        assert!(feature_control.entity_id.is_none());
2115        let edge_reference = feature_control
2116            .edge_reference
2117            .as_ref()
2118            .expect("expected face API edge specifier to emit edge_reference");
2119        assert_eq!(edge_reference.side_faces.len(), 2);
2120        assert!(edge_reference.end_faces.is_empty());
2121        assert_eq!(edge_reference.index, None);
2122    }
2123
2124    #[tokio::test(flavor = "multi_thread")]
2125    async fn gdt_straightness_accepts_face_api_edge_specifier() -> Result<(), KclError> {
2126        let code = gdt_face_api_edge_kcl(
2127            r#"gdt::straightness(
2128  edges = [
2129    {
2130      sideFaces = [region001.tags.line1, capStart001]
2131    }
2132  ],
2133  tolerance = 0.1mm,
2134  framePosition = [12mm, 8mm],
2135  framePlane = XZ,
2136)"#,
2137        );
2138        let commands = gdt_commands(&code).await;
2139        let annotation_index = new_annotation_command_index(&commands)?;
2140        let feature_control = feature_control(&commands[annotation_index])?;
2141        assert_feature_control_uses_edge_reference(feature_control);
2142        assert!(feature_control.control_frame.is_some());
2143        Ok(())
2144    }
2145
2146    #[tokio::test(flavor = "multi_thread")]
2147    async fn gdt_annotation_accepts_face_api_edge_specifier() -> Result<(), KclError> {
2148        let code = gdt_face_api_edge_kcl(
2149            r#"gdt::annotation(
2150  annotation = "A",
2151  edges = [
2152    {
2153      sideFaces = [region001.tags.line1, capStart001]
2154    }
2155  ],
2156  framePosition = [12mm, 8mm],
2157  framePlane = XZ,
2158)"#,
2159        );
2160        let commands = gdt_commands(&code).await;
2161        let annotation_index = new_annotation_command_index(&commands)?;
2162        let feature_control = feature_control(&commands[annotation_index])?;
2163        assert_feature_control_uses_edge_reference(feature_control);
2164        assert_eq!(feature_control.prefix.as_deref(), Some("A"));
2165        Ok(())
2166    }
2167
2168    #[tokio::test(flavor = "multi_thread")]
2169    async fn gdt_distance_accepts_face_api_edge_specifier() -> Result<(), KclError> {
2170        let code = gdt_face_api_edge_kcl(
2171            r#"gdt::distance(
2172  edges = [
2173    {
2174      sideFaces = [region001.tags.line1, capStart001]
2175    }
2176  ],
2177  tolerance = 0.1mm,
2178  framePosition = [12mm, 8mm],
2179  framePlane = XZ,
2180)"#,
2181        );
2182        let commands = gdt_commands(&code).await;
2183        let annotation_index = new_annotation_command_index(&commands)?;
2184        let options = annotation_options(&commands[annotation_index])?;
2185        let dimension = options
2186            .dimension
2187            .as_ref()
2188            .expect("expected new_annotation command to have a dimension");
2189        assert!(dimension.from_entity_id.is_none());
2190        assert!(dimension.to_entity_id.is_none());
2191        assert_eq!(
2192            dimension
2193                .from_edge_reference
2194                .as_ref()
2195                .expect("expected from_edge_reference")
2196                .side_faces
2197                .len(),
2198            2
2199        );
2200        assert_eq!(
2201            dimension
2202                .to_edge_reference
2203                .as_ref()
2204                .expect("expected to_edge_reference")
2205                .side_faces
2206                .len(),
2207            2
2208        );
2209        Ok(())
2210    }
2211
2212    #[tokio::test(flavor = "multi_thread")]
2213    async fn gdt_distance_from_to_accept_face_api_edge_specifiers() -> Result<(), KclError> {
2214        let code = gdt_face_api_edge_kcl(
2215            r#"gdt::distance(
2216  from = {
2217    sideFaces = [region001.tags.line1, capStart001]
2218  },
2219  to = {
2220    sideFaces = [region001.tags.line3, capStart001]
2221  },
2222  tolerance = 0.1mm,
2223  framePosition = [12mm, 8mm],
2224  framePlane = XZ,
2225)"#,
2226        );
2227        let commands = gdt_commands(&code).await;
2228        let annotation_index = new_annotation_command_index(&commands)?;
2229        let options = annotation_options(&commands[annotation_index])?;
2230        let dimension = options
2231            .dimension
2232            .as_ref()
2233            .expect("expected new_annotation command to have a dimension");
2234        assert!(dimension.from_entity_id.is_none());
2235        assert!(dimension.to_entity_id.is_none());
2236        assert_eq!(
2237            dimension
2238                .from_edge_reference
2239                .as_ref()
2240                .expect("expected from_edge_reference")
2241                .side_faces
2242                .len(),
2243            2
2244        );
2245        assert_eq!(
2246            dimension
2247                .to_edge_reference
2248                .as_ref()
2249                .expect("expected to_edge_reference")
2250                .side_faces
2251                .len(),
2252            2
2253        );
2254        Ok(())
2255    }
2256
2257    const GDT_DATUM_KCL: &str = r#"
2258blockProfile = sketch(on = XY) {
2259  edge1 = line(start = [var 0mm, var 0mm], end = [var 8mm, var 0mm])
2260  edge2 = line(start = [var 8mm, var 0mm], end = [var 8mm, var 5mm])
2261  edge3 = line(start = [var 8mm, var 5mm], end = [var 0mm, var 5mm])
2262  edge4 = line(start = [var 0mm, var 5mm], end = [var 0mm, var 0mm])
2263  coincident([edge1.end, edge2.start])
2264  coincident([edge2.end, edge3.start])
2265  coincident([edge3.end, edge4.start])
2266  coincident([edge4.end, edge1.start])
2267  horizontal(edge1)
2268  vertical(edge2)
2269  horizontal(edge3)
2270  vertical(edge4)
2271}
2272
2273block = extrude(region(point = [4mm, 2mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
2274
2275gdt::datum(face = top, name = "A", framePosition = [10mm, 0mm], framePlane = XZ)
2276"#;
2277
2278    async fn gdt_artifact_count(skip_artifact_graph: bool) -> usize {
2279        let settings = ExecutorSettings {
2280            skip_artifact_graph,
2281            ..Default::default()
2282        };
2283        let ctx = ExecutorContext::new_mock(Some(settings)).await;
2284        let program = crate::Program::parse_no_errs(GDT_DATUM_KCL).unwrap();
2285        let mock_config = MockConfig {
2286            use_prev_memory: false,
2287            ..Default::default()
2288        };
2289        let outcome = ctx.run_mock(&program, &mock_config).await.unwrap();
2290        ctx.close().await;
2291
2292        outcome
2293            .artifact_graph
2294            .values()
2295            .filter(|artifact| matches!(artifact, Artifact::GdtAnnotation(_)))
2296            .count()
2297    }
2298
2299    #[tokio::test(flavor = "multi_thread")]
2300    async fn gdt_annotations_do_not_follow_runtime_artifact_graph_setting() {
2301        assert_eq!(gdt_artifact_count(false).await, 1);
2302        assert_eq!(gdt_artifact_count(true).await, 1);
2303    }
2304
2305    const GDT_ANGULARITY_FACE_KCL: &str = r#"
2306@settings(defaultLengthUnit = mm, kclVersion = 2)
2307
2308basicAngle = 30deg
2309thickness = 3.5mm
2310flangeLength = 24mm
2311bendStartX = 5mm
2312legLength = 30mm
2313legRun = legLength * cos(basicAngle)
2314legRise = legLength * sin(basicAngle)
2315normalRun = thickness * sin(basicAngle)
2316normalRise = thickness * cos(basicAngle)
2317annotationFont = 2mm
2318
2319stampedProfile = sketch(on = XY) {
2320  datumFace = line(start = [var 0mm, var 0mm], end = [var 24mm, var 0mm])
2321  flangeEnd = line(start = [var 24mm, var 0mm], end = [var 24mm, var 3.5mm])
2322  innerFlange = line(start = [var 24mm, var 3.5mm], end = [var 5mm, var 3.5mm])
2323  controlledSurface = line(start = [var 5mm, var 3.5mm], end = [var 30.98mm, var 18.5mm])
2324  tabEnd = line(start = [var 30.98mm, var 18.5mm], end = [var 29.23mm, var 21.53mm])
2325  outerSurface = line(start = [var 29.23mm, var 21.53mm], end = [var 3.25mm, var 6.53mm])
2326  outsideBend = line(start = [var 3.25mm, var 6.53mm], end = [var 0mm, var 0mm])
2327  coincident([datumFace.end, flangeEnd.start])
2328  coincident([flangeEnd.end, innerFlange.start])
2329  coincident([innerFlange.end, controlledSurface.start])
2330  coincident([controlledSurface.end, tabEnd.start])
2331  coincident([tabEnd.end, outerSurface.start])
2332  coincident([outerSurface.end, outsideBend.start])
2333  coincident([outsideBend.end, datumFace.start])
2334  coincident([datumFace.start, ORIGIN])
2335  horizontal(datumFace)
2336  horizontal(innerFlange)
2337  vertical(flangeEnd)
2338  distance([datumFace.start, datumFace.end]) == flangeLength
2339  distance([flangeEnd.start, flangeEnd.end]) == thickness
2340  distance([innerFlange.start, innerFlange.end]) == flangeLength - bendStartX
2341  distance([controlledSurface.start, controlledSurface.end]) == legLength
2342  distance([tabEnd.start, tabEnd.end]) == thickness
2343  distance([outerSurface.start, outerSurface.end]) == legLength
2344  parallel([controlledSurface, outerSurface])
2345  perpendicular([controlledSurface, tabEnd])
2346  angle([datumFace, controlledSurface]) == basicAngle
2347}
2348
2349stampedPart = extrude(region(point = [12mm, 2mm], sketch = stampedProfile), length = 0.8mm)
2350
2351gdt::datum(face = stampedPart.sketch.tags.datumFace, name = "A", framePosition = [6mm, -4mm], framePlane = XY, fontSize = annotationFont)
2352gdt::angularity(faces = [stampedPart.sketch.tags.controlledSurface], tolerance = 0.1mm, datums = ["A"], framePosition = [-12mm, 11mm], framePlane = XZ, fontSize = annotationFont)
2353"#;
2354
2355    const GDT_ANGULARITY_EDGE_KCL: &str = r#"
2356@settings(defaultLengthUnit = mm, kclVersion = 2)
2357
2358basicAngle = 30deg
2359thickness = 3.5mm
2360flangeLength = 24mm
2361bendStartX = 5mm
2362legLength = 30mm
2363legRun = legLength * cos(basicAngle)
2364legRise = legLength * sin(basicAngle)
2365normalRun = thickness * sin(basicAngle)
2366normalRise = thickness * cos(basicAngle)
2367annotationFont = 2mm
2368
2369stampedProfile = sketch(on = XY) {
2370  datumFace = line(start = [var 0mm, var 0mm], end = [var 24mm, var 0mm])
2371  flangeEnd = line(start = [var 24mm, var 0mm], end = [var 24mm, var 3.5mm])
2372  innerFlange = line(start = [var 24mm, var 3.5mm], end = [var 5mm, var 3.5mm])
2373  controlledSurface = line(start = [var 5mm, var 3.5mm], end = [var 30.98mm, var 18.5mm])
2374  tabEnd = line(start = [var 30.98mm, var 18.5mm], end = [var 29.23mm, var 21.53mm])
2375  outerSurface = line(start = [var 29.23mm, var 21.53mm], end = [var 3.25mm, var 6.53mm])
2376  outsideBend = line(start = [var 3.25mm, var 6.53mm], end = [var 0mm, var 0mm])
2377  coincident([datumFace.end, flangeEnd.start])
2378  coincident([flangeEnd.end, innerFlange.start])
2379  coincident([innerFlange.end, controlledSurface.start])
2380  coincident([controlledSurface.end, tabEnd.start])
2381  coincident([tabEnd.end, outerSurface.start])
2382  coincident([outerSurface.end, outsideBend.start])
2383  coincident([outsideBend.end, datumFace.start])
2384  coincident([datumFace.start, ORIGIN])
2385  horizontal(datumFace)
2386  horizontal(innerFlange)
2387  vertical(flangeEnd)
2388  distance([datumFace.start, datumFace.end]) == flangeLength
2389  distance([flangeEnd.start, flangeEnd.end]) == thickness
2390  distance([innerFlange.start, innerFlange.end]) == flangeLength - bendStartX
2391  distance([controlledSurface.start, controlledSurface.end]) == legLength
2392  distance([tabEnd.start, tabEnd.end]) == thickness
2393  distance([outerSurface.start, outerSurface.end]) == legLength
2394  parallel([controlledSurface, outerSurface])
2395  perpendicular([controlledSurface, tabEnd])
2396  angle([datumFace, controlledSurface]) == basicAngle
2397}
2398
2399stampedRegion = region(point = [12mm, 2mm], sketch = stampedProfile)
2400hide(stampedProfile)
2401stampedPart = extrude(stampedRegion, length = 0.8mm)
2402
2403gdt::datum(face = stampedPart.sketch.tags.datumFace, name = "A", framePosition = [6mm, -4mm], framePlane = XY, fontSize = annotationFont)
2404gdt::angularity(edges = [stampedRegion.tags.controlledSurface], tolerance = 0.1mm, datums = ["A"], framePosition = [-12mm, 11mm], framePlane = XZ, fontSize = annotationFont)
2405"#;
2406
2407    #[tokio::test(flavor = "multi_thread")]
2408    async fn gdt_angularity_uses_angularity_symbol_with_datums() -> Result<(), KclError> {
2409        let cases = [
2410            ("angled face", GDT_ANGULARITY_FACE_KCL, 0.1),
2411            ("angled edge", GDT_ANGULARITY_EDGE_KCL, 0.1),
2412        ];
2413
2414        for (label, code, expected_tolerance) in cases {
2415            let commands = gdt_commands(code).await;
2416            let control_frame = find_control_frame_with_symbol(&commands, MbdSymbol::Angularity)?;
2417
2418            assert_close(control_frame.tolerance, expected_tolerance);
2419            assert_eq!(control_frame.primary_datum, Some('A'), "case: {label}");
2420            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2421            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2422        }
2423        Ok(())
2424    }
2425
2426    const GDT_PROFILE_LINE_KCL: &str = r#"
2427@settings(defaultLengthUnit = mm, kclVersion = 2)
2428
2429blockProfile = sketch(on = XY) {
2430  edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
2431  edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
2432  edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
2433  edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
2434  coincident([edge1.end, edge2.start])
2435  coincident([edge2.end, edge3.start])
2436  coincident([edge3.end, edge4.start])
2437  coincident([edge4.end, edge1.start])
2438  horizontal(edge1)
2439  vertical(edge2)
2440  horizontal(edge3)
2441  vertical(edge4)
2442}
2443
2444block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
2445profileEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
2446gdt::profileLine(edges = [profileEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
2447"#;
2448
2449    const GDT_PROFILE_GENERIC_LINE_KCL: &str = r#"
2450@settings(defaultLengthUnit = mm, kclVersion = 2)
2451
2452blockProfile = sketch(on = XY) {
2453  edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
2454  edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
2455  edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
2456  edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
2457  coincident([edge1.end, edge2.start])
2458  coincident([edge2.end, edge3.start])
2459  coincident([edge3.end, edge4.start])
2460  coincident([edge4.end, edge1.start])
2461  horizontal(edge1)
2462  vertical(edge2)
2463  horizontal(edge3)
2464  vertical(edge4)
2465}
2466
2467block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
2468profileEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
2469gdt::profile(edges = [profileEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
2470"#;
2471
2472    const GDT_PROFILE_SURFACE_KCL: &str = r#"
2473@settings(defaultLengthUnit = mm, kclVersion = 2)
2474
2475cylinderSketch = sketch(on = XY) {
2476  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2477}
2478
2479cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
2480gdt::profileSurface(faces = [top], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
2481"#;
2482
2483    const GDT_PROFILE_GENERIC_SURFACE_KCL: &str = r#"
2484@settings(defaultLengthUnit = mm, kclVersion = 2)
2485
2486cylinderSketch = sketch(on = XY) {
2487  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2488}
2489
2490cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
2491gdt::profile(faces = [top], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
2492"#;
2493
2494    const GDT_PROFILE_BOTH_KCL: &str = r#"
2495@settings(defaultLengthUnit = mm, kclVersion = 2)
2496
2497blockProfile = sketch(on = XY) {
2498  edge1 = line(start = [var 0mm, var 0mm], end = [var 10mm, var 0mm])
2499  edge2 = line(start = [var 10mm, var 0mm], end = [var 10mm, var 6mm])
2500  edge3 = line(start = [var 10mm, var 6mm], end = [var 0mm, var 6mm])
2501  edge4 = line(start = [var 0mm, var 6mm], end = [var 0mm, var 0mm])
2502  coincident([edge1.end, edge2.start])
2503  coincident([edge2.end, edge3.start])
2504  coincident([edge3.end, edge4.start])
2505  coincident([edge4.end, edge1.start])
2506  horizontal(edge1)
2507  vertical(edge2)
2508  horizontal(edge3)
2509  vertical(edge4)
2510}
2511
2512block = extrude(region(point = [5mm, 3mm], sketch = blockProfile), length = 4mm, tagEnd = $top)
2513profileEdge = getCommonEdge(faces = [block.sketch.tags.edge1, top])
2514gdt::profile(edges = [profileEdge], faces = [top], tolerance = 0.05mm)
2515"#;
2516
2517    const GDT_PROFILE_MISSING_ENTITIES_KCL: &str = r#"
2518@settings(defaultLengthUnit = mm, kclVersion = 2)
2519
2520gdt::profile(tolerance = 0.05mm)
2521"#;
2522
2523    #[tokio::test(flavor = "multi_thread")]
2524    async fn gdt_profile_line_uses_profile_of_line_symbol() -> Result<(), KclError> {
2525        let cases = [
2526            ("specific profileLine", GDT_PROFILE_LINE_KCL),
2527            ("generic profile with edges", GDT_PROFILE_GENERIC_LINE_KCL),
2528        ];
2529
2530        for (label, code) in cases {
2531            let commands = gdt_commands(code).await;
2532            let control_frame = find_control_frame_with_symbol(&commands, MbdSymbol::ProfileOfLine)?;
2533
2534            assert_close(control_frame.tolerance, 0.05);
2535            assert!(control_frame.primary_datum.is_none(), "case: {label}");
2536            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2537            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2538        }
2539        Ok(())
2540    }
2541
2542    #[tokio::test(flavor = "multi_thread")]
2543    async fn gdt_profile_surface_uses_surface_profile_symbol() -> Result<(), KclError> {
2544        let cases = [
2545            ("specific profileSurface", GDT_PROFILE_SURFACE_KCL),
2546            ("generic profile with faces", GDT_PROFILE_GENERIC_SURFACE_KCL),
2547        ];
2548
2549        for (label, code) in cases {
2550            let commands = gdt_commands(code).await;
2551            let control_frame = find_control_frame_with_symbol(&commands, MbdSymbol::SurfaceProfile)?;
2552
2553            assert_close(control_frame.tolerance, 0.05);
2554            assert!(control_frame.primary_datum.is_none(), "case: {label}");
2555            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2556            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2557        }
2558        Ok(())
2559    }
2560
2561    #[tokio::test(flavor = "multi_thread")]
2562    async fn gdt_profile_requires_edges_or_faces() {
2563        assert_eq!(
2564            parse_execute(GDT_PROFILE_MISSING_ENTITIES_KCL)
2565                .await
2566                .unwrap_err()
2567                .message(),
2568            "Profile requires either `edges` for `profileLine` or `faces` for `profileSurface`.",
2569        );
2570    }
2571
2572    #[tokio::test(flavor = "multi_thread")]
2573    async fn gdt_profile_rejects_combined_edges_and_faces() {
2574        assert_eq!(
2575            parse_execute(GDT_PROFILE_BOTH_KCL).await.unwrap_err().message(),
2576            "Profile cannot combine `edges` and `faces`. Use `profileLine` for edges or `profileSurface` for faces.",
2577        );
2578    }
2579
2580    // Mirrors the gdt::circularity doc examples: annotate a cylinder's circular
2581    // edge and its curved wall. Runs in mock mode, so it validates parsing, name
2582    // resolution, and that the control frame uses the Roundness (circularity)
2583    // symbol without datums. The doc examples additionally render against the
2584    // engine in kcl_test_examples.
2585    const GDT_CIRCULARITY_EDGE_KCL: &str = r#"
2586@settings(defaultLengthUnit = mm, kclVersion = 2)
2587
2588cylinderSketch = sketch(on = XY) {
2589  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2590}
2591
2592cylinderRegion = region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch)
2593hide(cylinderSketch)
2594cylinder = extrude(cylinderRegion, length = 10mm)
2595gdt::circularity(edges = [cylinderRegion.tags.perimeter], tolerance = 0.05mm)
2596"#;
2597
2598    const GDT_CIRCULARITY_WALL_KCL: &str = r#"
2599@settings(defaultLengthUnit = mm, kclVersion = 2)
2600
2601cylinderSketch = sketch(on = XY) {
2602  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2603}
2604
2605cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm)
2606gdt::circularity(faces = [cylinder.sketch.tags.perimeter], tolerance = 0.02mm, framePosition = [12mm, 8mm], framePlane = XZ)
2607"#;
2608
2609    const GDT_CIRCULARITY_COMMON_EDGE_KCL: &str = r#"
2610@settings(defaultLengthUnit = mm, kclVersion = 2)
2611
2612cylinderSketch = sketch(on = XY) {
2613  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2614}
2615
2616cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
2617topEdge = getCommonEdge(faces = [cylinder.sketch.tags.perimeter, top])
2618gdt::circularity(edges = [topEdge], tolerance = 0.05mm, framePosition = [12mm, 8mm], framePlane = XZ)
2619"#;
2620
2621    #[tokio::test(flavor = "multi_thread")]
2622    async fn gdt_circularity_uses_roundness_symbol_without_datums() -> Result<(), KclError> {
2623        let cases = [
2624            ("circular edge", GDT_CIRCULARITY_EDGE_KCL, 0.05),
2625            ("cylinder wall", GDT_CIRCULARITY_WALL_KCL, 0.02),
2626            ("common edge", GDT_CIRCULARITY_COMMON_EDGE_KCL, 0.05),
2627        ];
2628
2629        for (label, code, expected_tolerance) in cases {
2630            let commands = gdt_commands(code).await;
2631            let annotation_index = new_annotation_command_index(&commands)?;
2632            let feature_control = feature_control(&commands[annotation_index])?;
2633            let control_frame = feature_control.control_frame.as_ref().ok_or_else(|| {
2634                KclError::new_internal(KclErrorDetails::new(
2635                    format!("expected {label} feature_control to have a control_frame"),
2636                    vec![SourceRange::default()],
2637                ))
2638            })?;
2639
2640            assert_eq!(control_frame.symbol, MbdSymbol::Roundness, "case: {label}");
2641            assert_close(control_frame.tolerance, expected_tolerance);
2642            // Circularity is a form tolerance and never references datums.
2643            assert!(control_frame.primary_datum.is_none(), "case: {label}");
2644            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2645            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2646        }
2647        Ok(())
2648    }
2649
2650    // Mirrors the gdt::cylindricity doc examples: annotate a cylinder's curved
2651    // wall and its circular edge. Runs in mock mode, so it validates parsing,
2652    // name resolution, and that the control frame uses the Cylindricity symbol
2653    // without datums. The doc examples additionally render against the engine in
2654    // kcl_test_examples.
2655    const GDT_CYLINDRICITY_WALL_KCL: &str = r#"
2656@settings(defaultLengthUnit = mm, kclVersion = 2)
2657
2658cylinderSketch = sketch(on = XY) {
2659  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2660}
2661
2662cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm)
2663gdt::cylindricity(faces = [cylinder.sketch.tags.perimeter], tolerance = 0.02mm, framePosition = [-12mm, 8mm], framePlane = XZ)
2664"#;
2665
2666    const GDT_CYLINDRICITY_EDGE_KCL: &str = r#"
2667@settings(defaultLengthUnit = mm, kclVersion = 2)
2668
2669cylinderSketch = sketch(on = XY) {
2670  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2671}
2672
2673cylinderRegion = region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch)
2674hide(cylinderSketch)
2675cylinder = extrude(cylinderRegion, length = 10mm)
2676gdt::cylindricity(edges = [cylinderRegion.tags.perimeter], tolerance = 0.05mm, framePosition = [-12mm, 8mm])
2677"#;
2678
2679    const GDT_CYLINDRICITY_COMMON_EDGE_KCL: &str = r#"
2680@settings(defaultLengthUnit = mm, kclVersion = 2)
2681
2682cylinderSketch = sketch(on = XY) {
2683  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2684}
2685
2686cylinder = extrude(region(point = cylinderSketch.perimeter.center, sketch = cylinderSketch), length = 10mm, tagEnd = $top)
2687topEdge = getCommonEdge(faces = [cylinder.sketch.tags.perimeter, top])
2688gdt::cylindricity(edges = [topEdge], tolerance = 0.05mm, framePosition = [-12mm, 8mm], framePlane = XZ)
2689"#;
2690
2691    #[tokio::test(flavor = "multi_thread")]
2692    async fn gdt_cylindricity_uses_cylindricity_symbol_without_datums() -> Result<(), KclError> {
2693        let cases = [
2694            ("cylinder wall", GDT_CYLINDRICITY_WALL_KCL, 0.02),
2695            ("circular edge", GDT_CYLINDRICITY_EDGE_KCL, 0.05),
2696            ("common edge", GDT_CYLINDRICITY_COMMON_EDGE_KCL, 0.05),
2697        ];
2698
2699        for (label, code, expected_tolerance) in cases {
2700            let commands = gdt_commands(code).await;
2701            let annotation_index = new_annotation_command_index(&commands)?;
2702            let feature_control = feature_control(&commands[annotation_index])?;
2703            let control_frame = feature_control.control_frame.as_ref().ok_or_else(|| {
2704                KclError::new_internal(KclErrorDetails::new(
2705                    format!("expected {label} feature_control to have a control_frame"),
2706                    vec![SourceRange::default()],
2707                ))
2708            })?;
2709
2710            assert_eq!(control_frame.symbol, MbdSymbol::Cylindricity, "case: {label}");
2711            assert_close(control_frame.tolerance, expected_tolerance);
2712            // Cylindricity is a form tolerance and never references datums.
2713            assert!(control_frame.primary_datum.is_none(), "case: {label}");
2714            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2715            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2716        }
2717        Ok(())
2718    }
2719
2720    // Uses the GD&T Basics stepped-shaft example: reference feature B is
2721    // controlled relative to datum feature A. Runs in mock mode, so it validates
2722    // parsing, name resolution, and that the control frame uses the
2723    // Concentricity symbol with a diameter tolerance zone and datum reference.
2724    const GDT_CONCENTRICITY_REFERENCE_FEATURE_B_FACE_KCL: &str = r#"
2725@settings(defaultLengthUnit = mm, kclVersion = 2)
2726
2727datumASketch = sketch(on = XY) {
2728  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2729}
2730
2731datumA = extrude(region(point = datumASketch.perimeter.center, sketch = datumASketch), length = 16mm)
2732
2733referenceFeatureBSketch = sketch(on = XY) {
2734  perimeter = circle(start = [var 2.5mm, var 0mm], center = [var 0mm, var 0mm])
2735}
2736
2737referenceFeatureB = extrude(region(point = referenceFeatureBSketch.perimeter.center, sketch = referenceFeatureBSketch), length = 12mm)
2738  |> translate(z = -12mm)
2739
2740gdt::datum(face = datumA.sketch.tags.perimeter, name = "A", framePosition = [10mm, -12mm], framePlane = XZ)
2741gdt::concentricity(faces = [referenceFeatureB.sketch.tags.perimeter], tolerance = 0.2mm, datums = ["A"], framePosition = [-18mm, 12mm], framePlane = XZ)
2742"#;
2743
2744    const GDT_CONCENTRICITY_REFERENCE_FEATURE_B_EDGE_KCL: &str = r#"
2745@settings(defaultLengthUnit = mm, kclVersion = 2)
2746
2747datumASketch = sketch(on = XY) {
2748  perimeter = circle(start = [var 5mm, var 0mm], center = [var 0mm, var 0mm])
2749}
2750
2751datumA = extrude(region(point = datumASketch.perimeter.center, sketch = datumASketch), length = 16mm)
2752
2753referenceFeatureBSketch = sketch(on = XY) {
2754  perimeter = circle(start = [var 2.5mm, var 0mm], center = [var 0mm, var 0mm])
2755}
2756
2757referenceFeatureB = extrude(region(point = referenceFeatureBSketch.perimeter.center, sketch = referenceFeatureBSketch), length = 12mm, tagEnd = $endB)
2758  |> translate(z = -12mm)
2759endEdgeB = getCommonEdge(faces = [referenceFeatureB.sketch.tags.perimeter, endB])
2760
2761gdt::datum(face = datumA.sketch.tags.perimeter, name = "A", framePosition = [10mm, -12mm], framePlane = XZ)
2762gdt::concentricity(edges = [endEdgeB], tolerance = 0.2mm, datums = ["A"], framePosition = [-18mm, 12mm], framePlane = XZ)
2763"#;
2764
2765    #[tokio::test(flavor = "multi_thread")]
2766    async fn gdt_concentricity_uses_concentricity_symbol_with_diameter_zone_and_datums() -> Result<(), KclError> {
2767        let cases = [
2768            (
2769                "reference feature B face",
2770                GDT_CONCENTRICITY_REFERENCE_FEATURE_B_FACE_KCL,
2771                0.2,
2772            ),
2773            (
2774                "reference feature B edge",
2775                GDT_CONCENTRICITY_REFERENCE_FEATURE_B_EDGE_KCL,
2776                0.2,
2777            ),
2778        ];
2779
2780        for (label, code, expected_tolerance) in cases {
2781            let commands = gdt_commands(code).await;
2782            let control_frame = find_control_frame_with_symbol(&commands, MbdSymbol::Concentricity)?;
2783
2784            assert_eq!(
2785                control_frame.diameter_symbol,
2786                Some(MbdSymbol::Diameter),
2787                "case: {label}"
2788            );
2789            assert_close(control_frame.tolerance, expected_tolerance);
2790            assert_eq!(control_frame.primary_datum, Some('A'), "case: {label}");
2791            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
2792            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
2793        }
2794        Ok(())
2795    }
2796
2797    // Models the GD&T Basics latch-block groove example as closely as the
2798    // current datum API allows. Each test annotates one groove floor target
2799    // so KCL emits one symmetry feature control frame.
2800    const GDT_SYMMETRY_LATCH_BLOCK_GROOVE_FACE_KCL: &str = r#"
2801@settings(defaultLengthUnit = mm, kclVersion = 2)
2802
2803latchProfile = sketch(on = XZ) {
2804  bottom = line(start = [var -20mm, var -10mm], end = [var 20mm, var -10mm])
2805  datumWidthFace = line(start = [var 20mm, var -10mm], end = [var 20mm, var 10mm])
2806  topRight = line(start = [var 20mm, var 10mm], end = [var 5mm, var 10mm])
2807  rightGrooveWall = line(start = [var 5mm, var 10mm], end = [var 5mm, var 3mm])
2808  grooveFloor = line(start = [var 5mm, var 3mm], end = [var -5mm, var 3mm])
2809  leftGrooveWall = line(start = [var -5mm, var 3mm], end = [var -5mm, var 10mm])
2810  topLeft = line(start = [var -5mm, var 10mm], end = [var -20mm, var 10mm])
2811  leftSide = line(start = [var -20mm, var 10mm], end = [var -20mm, var -10mm])
2812  coincident([bottom.end, datumWidthFace.start])
2813  coincident([datumWidthFace.end, topRight.start])
2814  coincident([topRight.end, rightGrooveWall.start])
2815  coincident([rightGrooveWall.end, grooveFloor.start])
2816  coincident([grooveFloor.end, leftGrooveWall.start])
2817  coincident([leftGrooveWall.end, topLeft.start])
2818  coincident([topLeft.end, leftSide.start])
2819  coincident([leftSide.end, bottom.start])
2820  horizontal(bottom)
2821  vertical(datumWidthFace)
2822  horizontal(topRight)
2823  vertical(rightGrooveWall)
2824  horizontal(grooveFloor)
2825  vertical(leftGrooveWall)
2826  horizontal(topLeft)
2827  vertical(leftSide)
2828}
2829
2830latchBlockRegion = region(point = [0mm, 0mm], sketch = latchProfile)
2831latchBlock = extrude(latchBlockRegion, length = 12mm)
2832
2833gdt::datum(face = latchBlock.sketch.tags.bottom, name = "A", framePosition = [0mm, -16mm], framePlane = XZ)
2834gdt::symmetry(faces = [latchBlock.sketch.tags.grooveFloor], tolerance = 0.2mm, datums = ["A"], framePosition = [-24mm, 14mm], framePlane = XZ)
2835"#;
2836
2837    const GDT_SYMMETRY_LATCH_BLOCK_GROOVE_EDGE_KCL: &str = r#"
2838@settings(defaultLengthUnit = mm, kclVersion = 2)
2839
2840latchProfile = sketch(on = XZ) {
2841  bottom = line(start = [var -20mm, var -10mm], end = [var 20mm, var -10mm])
2842  datumWidthFace = line(start = [var 20mm, var -10mm], end = [var 20mm, var 10mm])
2843  topRight = line(start = [var 20mm, var 10mm], end = [var 5mm, var 10mm])
2844  rightGrooveWall = line(start = [var 5mm, var 10mm], end = [var 5mm, var 3mm])
2845  grooveFloor = line(start = [var 5mm, var 3mm], end = [var -5mm, var 3mm])
2846  leftGrooveWall = line(start = [var -5mm, var 3mm], end = [var -5mm, var 10mm])
2847  topLeft = line(start = [var -5mm, var 10mm], end = [var -20mm, var 10mm])
2848  leftSide = line(start = [var -20mm, var 10mm], end = [var -20mm, var -10mm])
2849  coincident([bottom.end, datumWidthFace.start])
2850  coincident([datumWidthFace.end, topRight.start])
2851  coincident([topRight.end, rightGrooveWall.start])
2852  coincident([rightGrooveWall.end, grooveFloor.start])
2853  coincident([grooveFloor.end, leftGrooveWall.start])
2854  coincident([leftGrooveWall.end, topLeft.start])
2855  coincident([topLeft.end, leftSide.start])
2856  coincident([leftSide.end, bottom.start])
2857  horizontal(bottom)
2858  vertical(datumWidthFace)
2859  horizontal(topRight)
2860  vertical(rightGrooveWall)
2861  horizontal(grooveFloor)
2862  vertical(leftGrooveWall)
2863  horizontal(topLeft)
2864  vertical(leftSide)
2865}
2866
2867latchBlockRegion = region(point = [0mm, 0mm], sketch = latchProfile)
2868latchBlock = extrude(latchBlockRegion, length = 12mm, tagEnd = $frontFace)
2869grooveFloorFrontEdge = getCommonEdge(faces = [latchBlock.sketch.tags.grooveFloor, frontFace])
2870
2871gdt::datum(face = latchBlock.sketch.tags.bottom, name = "A", framePosition = [0mm, -16mm], framePlane = XZ)
2872gdt::symmetry(edges = [grooveFloorFrontEdge], tolerance = 0.2mm, datums = ["A"], framePosition = [-24mm, 14mm], framePlane = XZ)
2873"#;
2874
2875    #[tokio::test(flavor = "multi_thread")]
2876    async fn gdt_symmetry_uses_symmetry_symbol_with_datums_for_face() -> Result<(), KclError> {
2877        let commands = gdt_commands(GDT_SYMMETRY_LATCH_BLOCK_GROOVE_FACE_KCL).await;
2878        let control_frames: Vec<_> = commands
2879            .iter()
2880            .filter_map(|command| {
2881                feature_control(command)
2882                    .ok()
2883                    .and_then(|feature_control| feature_control.control_frame.as_ref())
2884                    .filter(|control_frame| control_frame.symbol == MbdSymbol::Symmetry)
2885            })
2886            .collect();
2887
2888        assert_eq!(control_frames.len(), 1);
2889        let control_frame = control_frames[0];
2890        assert_eq!(control_frame.diameter_symbol, None);
2891        assert_close(control_frame.tolerance, 0.2);
2892        assert_eq!(control_frame.primary_datum, Some('A'));
2893        assert!(control_frame.secondary_datum.is_none());
2894        assert!(control_frame.tertiary_datum.is_none());
2895        Ok(())
2896    }
2897
2898    #[tokio::test(flavor = "multi_thread")]
2899    async fn gdt_symmetry_uses_symmetry_symbol_with_datums_for_edge() -> Result<(), KclError> {
2900        let commands = gdt_commands(GDT_SYMMETRY_LATCH_BLOCK_GROOVE_EDGE_KCL).await;
2901        let control_frames: Vec<_> = commands
2902            .iter()
2903            .filter_map(|command| {
2904                feature_control(command)
2905                    .ok()
2906                    .and_then(|feature_control| feature_control.control_frame.as_ref())
2907                    .filter(|control_frame| control_frame.symbol == MbdSymbol::Symmetry)
2908            })
2909            .collect();
2910
2911        assert_eq!(control_frames.len(), 1);
2912        let control_frame = control_frames[0];
2913        assert_eq!(control_frame.diameter_symbol, None);
2914        assert_close(control_frame.tolerance, 0.2);
2915        assert_eq!(control_frame.primary_datum, Some('A'));
2916        assert!(control_frame.secondary_datum.is_none());
2917        assert!(control_frame.tertiary_datum.is_none());
2918        Ok(())
2919    }
2920
2921    // Covers the gdt::runout doc example plus a face-based variant. Runs in mock mode, so it validates
2922    // parsing, name resolution, and that the control frame uses the Runout
2923    // symbol with a datum reference and no diameter symbol.
2924    const GDT_RUNOUT_STEPPED_SHAFT_KCL: &str = r#"
2925@settings(defaultLengthUnit = mm, kclVersion = 2)
2926
2927annotationPlane = offsetPlane(XZ, offset = 24mm)
2928
2929controlledSketch = sketch(on = YZ) {
2930  upperPerimeter = arc(start = [var 10mm, var 0mm], end = [var -10mm, var 0mm], center = [var 0mm, var 0mm])
2931  lowerPerimeter = arc(start = [var -10mm, var 0mm], end = [var 10mm, var 0mm], center = [var 0mm, var 0mm])
2932  coincident([upperPerimeter.end, lowerPerimeter.start])
2933  coincident([lowerPerimeter.end, upperPerimeter.start])
2934}
2935
2936controlledShaft = extrude(
2937  region(point = [0mm, 1mm], sketch = controlledSketch),
2938  length = -58mm,
2939  tagStart = $controlledShoulder,
2940  tagEnd = $controlledFreeEnd
2941)
2942
2943controlledUpperShoulderEdge = getCommonEdge(faces = [
2944  controlledShaft.sketch.tags.upperPerimeter,
2945  controlledShoulder
2946])
2947
2948datumSketch = sketch(on = YZ) {
2949  perimeter = circle(start = [var 18mm, var 0mm], center = [var 0mm, var 0mm])
2950}
2951
2952datumShaft = extrude(
2953  region(point = datumSketch.perimeter.center, sketch = datumSketch),
2954  length = 36mm,
2955  tagEnd = $datumEnd
2956)
2957
2958gdt::datum(
2959  face = datumShaft.sketch.tags.perimeter,
2960  name = "A",
2961  framePosition = [18mm, -28mm],
2962  framePlane = annotationPlane,
2963  leaderScale = 1.15,
2964  fontSize = 6mm
2965)
2966
2967gdt::runout(
2968  edges = [controlledUpperShoulderEdge],
2969  tolerance = 0.2mm,
2970  datums = ["A"],
2971  precision = 1,
2972  framePosition = [12mm, 48mm],
2973  framePlane = annotationPlane,
2974  leaderScale = 1.15,
2975  fontSize = 6mm
2976)
2977"#;
2978
2979    const GDT_RUNOUT_FACE_KCL: &str = r#"
2980@settings(defaultLengthUnit = mm, kclVersion = 2)
2981
2982datumSketch = sketch(on = XY) {
2983  perimeter = circle(start = [var 6mm, var 0mm], center = [var 0mm, var 0mm])
2984}
2985
2986datumShaft = extrude(region(point = datumSketch.perimeter.center, sketch = datumSketch), length = 18mm)
2987
2988controlledSketch = sketch(on = XY) {
2989  perimeter = circle(start = [var 3mm, var 0mm], center = [var 0mm, var 0mm])
2990}
2991
2992controlledShaft = extrude(region(point = controlledSketch.perimeter.center, sketch = controlledSketch), length = 16mm)
2993  |> translate(z = -16mm)
2994
2995gdt::datum(face = datumShaft.sketch.tags.perimeter, name = "A", framePosition = [12mm, -14mm], framePlane = XZ)
2996gdt::runout(faces = [controlledShaft.sketch.tags.perimeter], tolerance = 0.2mm, datums = ["A"], framePosition = [-18mm, 12mm], framePlane = XZ)
2997"#;
2998
2999    #[tokio::test(flavor = "multi_thread")]
3000    async fn gdt_runout_uses_runout_symbol_with_axis_datum() -> Result<(), KclError> {
3001        let cases = [
3002            ("stepped shaft", GDT_RUNOUT_STEPPED_SHAFT_KCL, 0.2),
3003            ("controlled face", GDT_RUNOUT_FACE_KCL, 0.2),
3004        ];
3005
3006        for (label, code, expected_tolerance) in cases {
3007            let commands = gdt_commands(code).await;
3008            let control_frame = find_control_frame_with_symbol(&commands, MbdSymbol::Runout)?;
3009
3010            assert!(control_frame.diameter_symbol.is_none(), "case: {label}");
3011            assert_close(control_frame.tolerance, expected_tolerance);
3012            assert_eq!(control_frame.primary_datum, Some('A'), "case: {label}");
3013            assert!(control_frame.secondary_datum.is_none(), "case: {label}");
3014            assert!(control_frame.tertiary_datum.is_none(), "case: {label}");
3015        }
3016        Ok(())
3017    }
3018}