use std::collections::HashMap;
use std::f64;
use anyhow::Result;
use indexmap::IndexMap;
use itertools::Itertools;
use kcl_error::SourceRange;
use kcmc::ModelingCmd;
use kcmc::each_cmd as mcmd;
use kcmc::length_unit::LengthUnit;
use kcmc::shared::Angle;
use kcmc::shared::Point2d as KPoint2d; use kcmc::shared::Point3d as KPoint3d; use kcmc::websocket::ModelingCmdReq;
use kittycad_modeling_cmds as kcmc;
use kittycad_modeling_cmds::shared::PathSegment;
use kittycad_modeling_cmds::units::UnitLength;
use parse_display::Display;
use parse_display::FromStr;
use serde::Deserialize;
use serde::Serialize;
use uuid::Uuid;
use super::shapes::get_radius;
use super::shapes::get_radius_labelled;
use super::utils::untype_array;
use crate::ExecutorContext;
use crate::NodePath;
use crate::errors::KclError;
use crate::errors::KclErrorDetails;
use crate::exec::PlaneKind;
#[cfg(feature = "artifact-graph")]
use crate::execution::Artifact;
#[cfg(feature = "artifact-graph")]
use crate::execution::ArtifactId;
use crate::execution::BasePath;
#[cfg(feature = "artifact-graph")]
use crate::execution::CodeRef;
use crate::execution::ExecState;
use crate::execution::GeoMeta;
use crate::execution::Geometry;
use crate::execution::KclValue;
use crate::execution::ModelingCmdMeta;
use crate::execution::Path;
use crate::execution::Plane;
use crate::execution::PlaneInfo;
use crate::execution::Point2d;
use crate::execution::Point3d;
use crate::execution::ProfileClosed;
use crate::execution::SKETCH_OBJECT_META;
use crate::execution::SKETCH_OBJECT_META_SKETCH;
use crate::execution::Segment;
use crate::execution::SegmentKind;
use crate::execution::Sketch;
use crate::execution::SketchSurface;
use crate::execution::Solid;
#[cfg(feature = "artifact-graph")]
use crate::execution::StartSketchOnFace;
#[cfg(feature = "artifact-graph")]
use crate::execution::StartSketchOnPlane;
use crate::execution::TagIdentifier;
use crate::execution::annotations;
use crate::execution::types::ArrayLen;
use crate::execution::types::NumericType;
use crate::execution::types::PrimitiveType;
use crate::execution::types::RuntimeType;
use crate::parsing::ast::types::TagNode;
use crate::std::CircularDirection;
use crate::std::EQUAL_POINTS_DIST_EPSILON;
use crate::std::args::Args;
use crate::std::args::FromKclValue;
use crate::std::args::TyF64;
use crate::std::axis_or_reference::Axis2dOrEdgeReference;
use crate::std::faces::FaceSpecifier;
use crate::std::faces::make_face;
use crate::std::planes::inner_plane_of;
use crate::std::utils::TangentialArcInfoInput;
use crate::std::utils::arc_center_and_end;
use crate::std::utils::get_tangential_arc_to_info;
use crate::std::utils::get_x_component;
use crate::std::utils::get_y_component;
use crate::std::utils::intersection_with_parallel_line;
use crate::std::utils::point_to_len_unit;
use crate::std::utils::point_to_mm;
use crate::std::utils::untyped_point_to_mm;
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS)]
#[ts(export)]
#[serde(rename_all = "snake_case", untagged)]
pub enum FaceTag {
StartOrEnd(StartOrEnd),
Tag(Box<TagIdentifier>),
}
impl std::fmt::Display for FaceTag {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
FaceTag::Tag(t) => write!(f, "{t}"),
FaceTag::StartOrEnd(StartOrEnd::Start) => write!(f, "start"),
FaceTag::StartOrEnd(StartOrEnd::End) => write!(f, "end"),
}
}
}
impl FaceTag {
pub async fn get_face_id(
&self,
solid: &Solid,
exec_state: &mut ExecState,
args: &Args,
must_be_planar: bool,
) -> Result<uuid::Uuid, KclError> {
match self {
FaceTag::Tag(t) => args.get_adjacent_face_to_tag(exec_state, t, must_be_planar).await,
FaceTag::StartOrEnd(StartOrEnd::Start) => solid.start_cap_id.ok_or_else(|| {
KclError::new_type(KclErrorDetails::new(
"Expected a start face".to_string(),
vec![args.source_range],
))
}),
FaceTag::StartOrEnd(StartOrEnd::End) => solid.end_cap_id.ok_or_else(|| {
KclError::new_type(KclErrorDetails::new(
"Expected an end face".to_string(),
vec![args.source_range],
))
}),
}
}
pub async fn get_face_id_from_tag(
&self,
exec_state: &mut ExecState,
args: &Args,
must_be_planar: bool,
) -> Result<uuid::Uuid, KclError> {
match self {
FaceTag::Tag(t) => args.get_adjacent_face_to_tag(exec_state, t, must_be_planar).await,
_ => Err(KclError::new_type(KclErrorDetails::new(
"Could not find the face corresponding to this tag".to_string(),
vec![args.source_range],
))),
}
}
pub fn geometry(&self) -> Option<Geometry> {
match self {
FaceTag::Tag(t) => t.geometry(),
_ => None,
}
}
}
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, FromStr, Display)]
#[ts(export)]
#[serde(rename_all = "snake_case")]
#[display(style = "snake_case")]
pub enum StartOrEnd {
#[serde(rename = "start", alias = "START")]
Start,
#[serde(rename = "end", alias = "END")]
End,
}
pub const NEW_TAG_KW: &str = "tag";
pub async fn involute_circular(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::sketch(), exec_state)?;
let start_radius: Option<TyF64> = args.get_kw_arg_opt("startRadius", &RuntimeType::length(), exec_state)?;
let end_radius: Option<TyF64> = args.get_kw_arg_opt("endRadius", &RuntimeType::length(), exec_state)?;
let start_diameter: Option<TyF64> = args.get_kw_arg_opt("startDiameter", &RuntimeType::length(), exec_state)?;
let end_diameter: Option<TyF64> = args.get_kw_arg_opt("endDiameter", &RuntimeType::length(), exec_state)?;
let angle: TyF64 = args.get_kw_arg("angle", &RuntimeType::angle(), exec_state)?;
let reverse = args.get_kw_arg_opt("reverse", &RuntimeType::bool(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_involute_circular(
sketch,
start_radius,
end_radius,
start_diameter,
end_diameter,
angle,
reverse,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
fn involute_curve(radius: f64, angle: f64) -> (f64, f64) {
(
radius * (libm::cos(angle) + angle * libm::sin(angle)),
radius * (libm::sin(angle) - angle * libm::cos(angle)),
)
}
#[allow(clippy::too_many_arguments)]
async fn inner_involute_circular(
sketch: Sketch,
start_radius: Option<TyF64>,
end_radius: Option<TyF64>,
start_diameter: Option<TyF64>,
end_diameter: Option<TyF64>,
angle: TyF64,
reverse: Option<bool>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let id = exec_state.next_uuid();
let angle_deg = angle.to_degrees(exec_state, args.source_range);
let angle_rad = angle.to_radians(exec_state, args.source_range);
let longer_args_dot_source_range = args.source_range;
let start_radius = get_radius_labelled(
start_radius,
start_diameter,
args.source_range,
"startRadius",
"startDiameter",
)?;
let end_radius = get_radius_labelled(
end_radius,
end_diameter,
longer_args_dot_source_range,
"endRadius",
"endDiameter",
)?;
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::CircularInvolute {
start_radius: LengthUnit(start_radius.to_mm()),
end_radius: LengthUnit(end_radius.to_mm()),
angle: Angle::from_degrees(angle_deg),
reverse: reverse.unwrap_or_default(),
})
.build(),
),
)
.await?;
let from = sketch.current_pen_position()?;
let start_radius = start_radius.to_length_units(from.units);
let end_radius = end_radius.to_length_units(from.units);
let mut end: KPoint3d<f64> = Default::default(); let theta = f64::sqrt(end_radius * end_radius - start_radius * start_radius) / start_radius;
let (x, y) = involute_curve(start_radius, theta);
end.x = x * libm::cos(angle_rad) - y * libm::sin(angle_rad);
end.y = x * libm::sin(angle_rad) + y * libm::cos(angle_rad);
end.x -= start_radius * libm::cos(angle_rad);
end.y -= start_radius * libm::sin(angle_rad);
if reverse.unwrap_or_default() {
end.x = -end.x;
}
end.x += from.x;
end.y += from.y;
let current_path = Path::ToPoint {
base: BasePath {
from: from.ignore_units(),
to: [end.x, end.y],
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn line(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::sketch(), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_line(sketch, end_absolute, end, tag, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
async fn inner_line(
sketch: Sketch,
end_absolute: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
straight_line_with_new_id(
StraightLineParams {
sketch,
end_absolute,
end,
tag,
relative_name: "end",
},
exec_state,
&args.ctx,
args.source_range,
)
.await
}
pub(super) struct StraightLineParams {
sketch: Sketch,
end_absolute: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
tag: Option<TagNode>,
relative_name: &'static str,
}
impl StraightLineParams {
fn relative(p: [TyF64; 2], sketch: Sketch, tag: Option<TagNode>) -> Self {
Self {
sketch,
tag,
end: Some(p),
end_absolute: None,
relative_name: "end",
}
}
pub(super) fn absolute(p: [TyF64; 2], sketch: Sketch, tag: Option<TagNode>) -> Self {
Self {
sketch,
tag,
end: None,
end_absolute: Some(p),
relative_name: "end",
}
}
}
pub(super) async fn straight_line_with_new_id(
straight_line_params: StraightLineParams,
exec_state: &mut ExecState,
ctx: &ExecutorContext,
source_range: SourceRange,
) -> Result<Sketch, KclError> {
let id = exec_state.next_uuid();
straight_line(id, straight_line_params, true, exec_state, ctx, source_range).await
}
pub(super) async fn straight_line(
id: Uuid,
StraightLineParams {
sketch,
end,
end_absolute,
tag,
relative_name,
}: StraightLineParams,
send_to_engine: bool,
exec_state: &mut ExecState,
ctx: &ExecutorContext,
source_range: SourceRange,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
let (point, is_absolute) = match (end_absolute, end) {
(Some(_), Some(_)) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"You cannot give both `end` and `endAbsolute` params, you have to choose one or the other".to_owned(),
vec![source_range],
)));
}
(Some(end_absolute), None) => (end_absolute, true),
(None, Some(end)) => (end, false),
(None, None) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
format!("You must supply either `{relative_name}` or `endAbsolute` arguments"),
vec![source_range],
)));
}
};
if send_to_engine {
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::with_id(exec_state, ctx, source_range, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Line {
end: KPoint2d::from(point_to_mm(point.clone())).with_z(0.0).map(LengthUnit),
relative: !is_absolute,
})
.build(),
),
)
.await?;
}
let end = if is_absolute {
point_to_len_unit(point, from.units)
} else {
let from = sketch.current_pen_position()?;
let point = point_to_len_unit(point, from.units);
[from.x + point[0], from.y + point[1]]
};
let loops_back_to_start = does_segment_close_sketch(end, sketch.start.from);
let current_path = Path::ToPoint {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
fn does_segment_close_sketch(end: [f64; 2], from: [f64; 2]) -> bool {
let same_x = (end[0] - from[0]).abs() < EQUAL_POINTS_DIST_EPSILON;
let same_y = (end[1] - from[1]).abs() < EQUAL_POINTS_DIST_EPSILON;
same_x && same_y
}
pub async fn x_line(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let length: Option<TyF64> = args.get_kw_arg_opt("length", &RuntimeType::length(), exec_state)?;
let end_absolute: Option<TyF64> = args.get_kw_arg_opt("endAbsolute", &RuntimeType::length(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_x_line(sketch, length, end_absolute, tag, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
async fn inner_x_line(
sketch: Sketch,
length: Option<TyF64>,
end_absolute: Option<TyF64>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
straight_line_with_new_id(
StraightLineParams {
sketch,
end_absolute: end_absolute.map(|x| [x, from.into_y()]),
end: length.map(|x| [x, TyF64::new(0.0, NumericType::mm())]),
tag,
relative_name: "length",
},
exec_state,
&args.ctx,
args.source_range,
)
.await
}
pub async fn y_line(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let length: Option<TyF64> = args.get_kw_arg_opt("length", &RuntimeType::length(), exec_state)?;
let end_absolute: Option<TyF64> = args.get_kw_arg_opt("endAbsolute", &RuntimeType::length(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_y_line(sketch, length, end_absolute, tag, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
async fn inner_y_line(
sketch: Sketch,
length: Option<TyF64>,
end_absolute: Option<TyF64>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
straight_line_with_new_id(
StraightLineParams {
sketch,
end_absolute: end_absolute.map(|y| [from.into_x(), y]),
end: length.map(|y| [TyF64::new(0.0, NumericType::mm()), y]),
tag,
relative_name: "length",
},
exec_state,
&args.ctx,
args.source_range,
)
.await
}
pub async fn angled_line(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::sketch(), exec_state)?;
let angle: TyF64 = args.get_kw_arg("angle", &RuntimeType::degrees(), exec_state)?;
let length: Option<TyF64> = args.get_kw_arg_opt("length", &RuntimeType::length(), exec_state)?;
let length_x: Option<TyF64> = args.get_kw_arg_opt("lengthX", &RuntimeType::length(), exec_state)?;
let length_y: Option<TyF64> = args.get_kw_arg_opt("lengthY", &RuntimeType::length(), exec_state)?;
let end_absolute_x: Option<TyF64> = args.get_kw_arg_opt("endAbsoluteX", &RuntimeType::length(), exec_state)?;
let end_absolute_y: Option<TyF64> = args.get_kw_arg_opt("endAbsoluteY", &RuntimeType::length(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_angled_line(
sketch,
angle.n,
length,
length_x,
length_y,
end_absolute_x,
end_absolute_y,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
async fn inner_angled_line(
sketch: Sketch,
angle: f64,
length: Option<TyF64>,
length_x: Option<TyF64>,
length_y: Option<TyF64>,
end_absolute_x: Option<TyF64>,
end_absolute_y: Option<TyF64>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let options_given = [&length, &length_x, &length_y, &end_absolute_x, &end_absolute_y]
.iter()
.filter(|x| x.is_some())
.count();
if options_given > 1 {
return Err(KclError::new_type(KclErrorDetails::new(
" one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given".to_string(),
vec![args.source_range],
)));
}
if let Some(length_x) = length_x {
return inner_angled_line_of_x_length(angle, length_x, sketch, tag, exec_state, args).await;
}
if let Some(length_y) = length_y {
return inner_angled_line_of_y_length(angle, length_y, sketch, tag, exec_state, args).await;
}
let angle_degrees = angle;
match (length, length_x, length_y, end_absolute_x, end_absolute_y) {
(Some(length), None, None, None, None) => {
inner_angled_line_length(sketch, angle_degrees, length, tag, exec_state, args).await
}
(None, Some(length_x), None, None, None) => {
inner_angled_line_of_x_length(angle_degrees, length_x, sketch, tag, exec_state, args).await
}
(None, None, Some(length_y), None, None) => {
inner_angled_line_of_y_length(angle_degrees, length_y, sketch, tag, exec_state, args).await
}
(None, None, None, Some(end_absolute_x), None) => {
inner_angled_line_to_x(angle_degrees, end_absolute_x, sketch, tag, exec_state, args).await
}
(None, None, None, None, Some(end_absolute_y)) => {
inner_angled_line_to_y(angle_degrees, end_absolute_y, sketch, tag, exec_state, args).await
}
(None, None, None, None, None) => Err(KclError::new_type(KclErrorDetails::new(
"One of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` must be given".to_string(),
vec![args.source_range],
))),
_ => Err(KclError::new_type(KclErrorDetails::new(
"Only One of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given".to_owned(),
vec![args.source_range],
))),
}
}
async fn inner_angled_line_length(
sketch: Sketch,
angle_degrees: f64,
length: TyF64,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
let length = length.to_length_units(from.units);
let delta: [f64; 2] = [
length * libm::cos(angle_degrees.to_radians()),
length * libm::sin(angle_degrees.to_radians()),
];
let relative = true;
let to: [f64; 2] = [from.x + delta[0], from.y + delta[1]];
let loops_back_to_start = does_segment_close_sketch(to, sketch.start.from);
let id = exec_state.next_uuid();
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Line {
end: KPoint2d::from(untyped_point_to_mm(delta, from.units))
.with_z(0.0)
.map(LengthUnit),
relative,
})
.build(),
),
)
.await?;
let current_path = Path::ToPoint {
base: BasePath {
from: from.ignore_units(),
to,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
async fn inner_angled_line_of_x_length(
angle_degrees: f64,
length: TyF64,
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
if angle_degrees.abs() == 270.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have an x constrained angle of 270 degrees".to_string(),
vec![args.source_range],
)));
}
if angle_degrees.abs() == 90.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have an x constrained angle of 90 degrees".to_string(),
vec![args.source_range],
)));
}
let to = get_y_component(Angle::from_degrees(angle_degrees), length.n);
let to = [TyF64::new(to[0], length.ty), TyF64::new(to[1], length.ty)];
let new_sketch = straight_line_with_new_id(
StraightLineParams::relative(to, sketch, tag),
exec_state,
&args.ctx,
args.source_range,
)
.await?;
Ok(new_sketch)
}
async fn inner_angled_line_to_x(
angle_degrees: f64,
x_to: TyF64,
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
if angle_degrees.abs() == 270.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have an x constrained angle of 270 degrees".to_string(),
vec![args.source_range],
)));
}
if angle_degrees.abs() == 90.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have an x constrained angle of 90 degrees".to_string(),
vec![args.source_range],
)));
}
let x_component = x_to.to_length_units(from.units) - from.x;
let y_component = x_component * libm::tan(angle_degrees.to_radians());
let y_to = from.y + y_component;
let new_sketch = straight_line_with_new_id(
StraightLineParams::absolute([x_to, TyF64::new(y_to, from.units.into())], sketch, tag),
exec_state,
&args.ctx,
args.source_range,
)
.await?;
Ok(new_sketch)
}
async fn inner_angled_line_of_y_length(
angle_degrees: f64,
length: TyF64,
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
if angle_degrees.abs() == 0.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have a y constrained angle of 0 degrees".to_string(),
vec![args.source_range],
)));
}
if angle_degrees.abs() == 180.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have a y constrained angle of 180 degrees".to_string(),
vec![args.source_range],
)));
}
let to = get_x_component(Angle::from_degrees(angle_degrees), length.n);
let to = [TyF64::new(to[0], length.ty), TyF64::new(to[1], length.ty)];
let new_sketch = straight_line_with_new_id(
StraightLineParams::relative(to, sketch, tag),
exec_state,
&args.ctx,
args.source_range,
)
.await?;
Ok(new_sketch)
}
async fn inner_angled_line_to_y(
angle_degrees: f64,
y_to: TyF64,
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
if angle_degrees.abs() == 0.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have a y constrained angle of 0 degrees".to_string(),
vec![args.source_range],
)));
}
if angle_degrees.abs() == 180.0 {
return Err(KclError::new_type(KclErrorDetails::new(
"Cannot have a y constrained angle of 180 degrees".to_string(),
vec![args.source_range],
)));
}
let y_component = y_to.to_length_units(from.units) - from.y;
let x_component = y_component / libm::tan(angle_degrees.to_radians());
let x_to = from.x + x_component;
let new_sketch = straight_line_with_new_id(
StraightLineParams::absolute([TyF64::new(x_to, from.units.into()), y_to], sketch, tag),
exec_state,
&args.ctx,
args.source_range,
)
.await?;
Ok(new_sketch)
}
pub async fn angled_line_that_intersects(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let angle: TyF64 = args.get_kw_arg("angle", &RuntimeType::angle(), exec_state)?;
let intersect_tag: TagIdentifier = args.get_kw_arg("intersectTag", &RuntimeType::tagged_edge(), exec_state)?;
let offset = args.get_kw_arg_opt("offset", &RuntimeType::length(), exec_state)?;
let tag: Option<TagNode> = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch =
inner_angled_line_that_intersects(sketch, angle, intersect_tag, offset, tag, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
pub async fn inner_angled_line_that_intersects(
sketch: Sketch,
angle: TyF64,
intersect_tag: TagIdentifier,
offset: Option<TyF64>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let intersect_path = args.get_tag_engine_info(exec_state, &intersect_tag)?;
let path = intersect_path.path.clone().ok_or_else(|| {
KclError::new_type(KclErrorDetails::new(
format!("Expected an intersect path with a path, found `{intersect_path:?}`"),
vec![args.source_range],
))
})?;
let from = sketch.current_pen_position()?;
let to = intersection_with_parallel_line(
&[
point_to_len_unit(path.get_from(), from.units),
point_to_len_unit(path.get_to(), from.units),
],
offset.map(|t| t.to_length_units(from.units)).unwrap_or_default(),
angle.to_degrees(exec_state, args.source_range),
from.ignore_units(),
);
let to = [
TyF64::new(to[0], from.units.into()),
TyF64::new(to[1], from.units.into()),
];
straight_line_with_new_id(
StraightLineParams::absolute(to, sketch, tag),
exec_state,
&args.ctx,
args.source_range,
)
.await
}
#[derive(Debug, Clone, Serialize, PartialEq, ts_rs::TS)]
#[ts(export)]
#[serde(rename_all = "camelCase", untagged)]
#[allow(clippy::large_enum_variant)]
pub enum SketchData {
PlaneOrientation(PlaneData),
Plane(Box<Plane>),
Solid(Box<Solid>),
}
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS)]
#[ts(export)]
#[serde(rename_all = "camelCase")]
#[allow(clippy::large_enum_variant)]
pub enum PlaneData {
#[serde(rename = "XY", alias = "xy")]
XY,
#[serde(rename = "-XY", alias = "-xy")]
NegXY,
#[serde(rename = "XZ", alias = "xz")]
XZ,
#[serde(rename = "-XZ", alias = "-xz")]
NegXZ,
#[serde(rename = "YZ", alias = "yz")]
YZ,
#[serde(rename = "-YZ", alias = "-yz")]
NegYZ,
Plane(PlaneInfo),
}
pub async fn start_sketch_on(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let data = args.get_unlabeled_kw_arg(
"planeOrSolid",
&RuntimeType::Union(vec![RuntimeType::solid(), RuntimeType::plane()]),
exec_state,
)?;
let face = args.get_kw_arg_opt("face", &RuntimeType::tagged_face_or_segment(), exec_state)?;
let normal_to_face = args.get_kw_arg_opt("normalToFace", &RuntimeType::tagged_face(), exec_state)?;
let align_axis = args.get_kw_arg_opt("alignAxis", &RuntimeType::Primitive(PrimitiveType::Axis2d), exec_state)?;
let normal_offset = args.get_kw_arg_opt("normalOffset", &RuntimeType::length(), exec_state)?;
match inner_start_sketch_on(data, face, normal_to_face, align_axis, normal_offset, exec_state, &args).await? {
SketchSurface::Plane(value) => Ok(KclValue::Plane { value }),
SketchSurface::Face(value) => Ok(KclValue::Face { value }),
}
}
async fn inner_start_sketch_on(
plane_or_solid: SketchData,
face: Option<FaceSpecifier>,
normal_to_face: Option<FaceSpecifier>,
align_axis: Option<Axis2dOrEdgeReference>,
normal_offset: Option<TyF64>,
exec_state: &mut ExecState,
args: &Args,
) -> Result<SketchSurface, KclError> {
let face = match (face, normal_to_face, &align_axis, &normal_offset) {
(Some(_), Some(_), _, _) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"You cannot give both `face` and `normalToFace` params, you have to choose one or the other."
.to_owned(),
vec![args.source_range],
)));
}
(Some(face), None, None, None) => Some(face),
(_, Some(_), None, _) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"`alignAxis` is required if `normalToFace` is specified.".to_owned(),
vec![args.source_range],
)));
}
(_, None, Some(_), _) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"`normalToFace` is required if `alignAxis` is specified.".to_owned(),
vec![args.source_range],
)));
}
(_, None, _, Some(_)) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"`normalToFace` is required if `normalOffset` is specified.".to_owned(),
vec![args.source_range],
)));
}
(_, Some(face), Some(_), _) => Some(face),
(None, None, None, None) => None,
};
match plane_or_solid {
SketchData::PlaneOrientation(plane_data) => {
let plane = make_sketch_plane_from_orientation(plane_data, exec_state, args).await?;
Ok(SketchSurface::Plane(plane))
}
SketchData::Plane(plane) => {
if plane.is_uninitialized() {
let plane = make_sketch_plane_from_orientation(plane.info.into_plane_data(), exec_state, args).await?;
Ok(SketchSurface::Plane(plane))
} else {
#[cfg(feature = "artifact-graph")]
{
let id = exec_state.next_uuid();
exec_state.add_artifact(Artifact::StartSketchOnPlane(StartSketchOnPlane {
id: ArtifactId::from(id),
plane_id: plane.artifact_id,
code_ref: CodeRef::placeholder(args.source_range),
}));
}
Ok(SketchSurface::Plane(plane))
}
}
SketchData::Solid(solid) => {
let Some(tag) = face else {
return Err(KclError::new_type(KclErrorDetails::new(
"Expected a tag for the face to sketch on".to_string(),
vec![args.source_range],
)));
};
if let Some(align_axis) = align_axis {
let plane_of = inner_plane_of(*solid, tag, exec_state, args).await?;
let offset = normal_offset.map_or(0.0, |x| x.to_mm());
let (x_axis, y_axis, normal_offset) = match align_axis {
Axis2dOrEdgeReference::Axis { direction, origin: _ } => {
if (direction[0].n - 1.0).abs() < f64::EPSILON {
(
plane_of.info.x_axis,
plane_of.info.z_axis,
plane_of.info.y_axis * offset,
)
} else if (direction[0].n + 1.0).abs() < f64::EPSILON {
(
plane_of.info.x_axis.negated(),
plane_of.info.z_axis,
plane_of.info.y_axis * offset,
)
} else if (direction[1].n - 1.0).abs() < f64::EPSILON {
(
plane_of.info.y_axis,
plane_of.info.z_axis,
plane_of.info.x_axis * offset,
)
} else if (direction[1].n + 1.0).abs() < f64::EPSILON {
(
plane_of.info.y_axis.negated(),
plane_of.info.z_axis,
plane_of.info.x_axis * offset,
)
} else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Unsupported axis detected. This function only supports using X, -X, Y and -Y."
.to_owned(),
vec![args.source_range],
)));
}
}
Axis2dOrEdgeReference::Edge(_) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Use of an edge here is unsupported, please specify an `Axis2d` (e.g. `X`) instead."
.to_owned(),
vec![args.source_range],
)));
}
};
let origin = Point3d::new(0.0, 0.0, 0.0, plane_of.info.origin.units);
let plane_data = PlaneData::Plane(PlaneInfo {
origin: plane_of.project(origin) + normal_offset,
x_axis,
y_axis,
z_axis: x_axis.axes_cross_product(&y_axis),
});
let plane = make_sketch_plane_from_orientation(plane_data, exec_state, args).await?;
#[cfg(feature = "artifact-graph")]
{
let id = exec_state.next_uuid();
exec_state.add_artifact(Artifact::StartSketchOnPlane(StartSketchOnPlane {
id: ArtifactId::from(id),
plane_id: plane.artifact_id,
code_ref: CodeRef::placeholder(args.source_range),
}));
}
Ok(SketchSurface::Plane(plane))
} else {
let face = make_face(solid, tag, exec_state, args).await?;
#[cfg(feature = "artifact-graph")]
{
let id = exec_state.next_uuid();
exec_state.add_artifact(Artifact::StartSketchOnFace(StartSketchOnFace {
id: ArtifactId::from(id),
face_id: face.artifact_id,
code_ref: CodeRef::placeholder(args.source_range),
}));
}
Ok(SketchSurface::Face(face))
}
}
}
}
pub async fn make_sketch_plane_from_orientation(
data: PlaneData,
exec_state: &mut ExecState,
args: &Args,
) -> Result<Box<Plane>, KclError> {
let id = exec_state.next_uuid();
let kind = PlaneKind::from(&data);
let mut plane = Plane {
id,
artifact_id: id.into(),
object_id: None,
kind,
info: PlaneInfo::try_from(data)?,
meta: vec![args.source_range.into()],
};
ensure_sketch_plane_in_engine(
&mut plane,
exec_state,
&args.ctx,
args.source_range,
args.node_path.clone(),
)
.await?;
Ok(Box::new(plane))
}
pub async fn ensure_sketch_plane_in_engine(
plane: &mut Plane,
exec_state: &mut ExecState,
ctx: &ExecutorContext,
source_range: SourceRange,
node_path: Option<NodePath>,
) -> Result<(), KclError> {
if plane.is_initialized() {
return Ok(());
}
#[cfg(feature = "artifact-graph")]
{
if let Some(existing_object_id) = exec_state.scene_object_id_by_artifact_id(ArtifactId::new(plane.id)) {
plane.object_id = Some(existing_object_id);
return Ok(());
}
}
let id = exec_state.next_uuid();
plane.id = id;
plane.artifact_id = id.into();
let clobber = false;
let size = LengthUnit(60.0);
let hide = Some(true);
let cmd = if let Some(hide) = hide {
mcmd::MakePlane::builder()
.clobber(clobber)
.origin(plane.info.origin.into())
.size(size)
.x_axis(plane.info.x_axis.into())
.y_axis(plane.info.y_axis.into())
.hide(hide)
.build()
} else {
mcmd::MakePlane::builder()
.clobber(clobber)
.origin(plane.info.origin.into())
.size(size)
.x_axis(plane.info.x_axis.into())
.y_axis(plane.info.y_axis.into())
.build()
};
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::with_id(exec_state, ctx, source_range, plane.id),
ModelingCmd::from(cmd),
)
.await?;
let plane_object_id = exec_state.next_object_id();
#[cfg(not(feature = "artifact-graph"))]
let _ = node_path;
#[cfg(feature = "artifact-graph")]
{
use crate::front::SourceRef;
let plane_object = crate::front::Object {
id: plane_object_id,
kind: crate::front::ObjectKind::Plane(crate::front::Plane::Object(plane_object_id)),
label: Default::default(),
comments: Default::default(),
artifact_id: ArtifactId::new(plane.id),
source: SourceRef::new(source_range, node_path.clone()),
};
exec_state.add_scene_object(plane_object, source_range);
}
plane.object_id = Some(plane_object_id);
Ok(())
}
pub async fn start_profile(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch_surface = args.get_unlabeled_kw_arg(
"startProfileOn",
&RuntimeType::Union(vec![RuntimeType::plane(), RuntimeType::face()]),
exec_state,
)?;
let start: [TyF64; 2] = args.get_kw_arg("at", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let sketch = inner_start_profile(sketch_surface, start, tag, exec_state, &args.ctx, args.source_range).await?;
Ok(KclValue::Sketch {
value: Box::new(sketch),
})
}
pub(crate) async fn inner_start_profile(
sketch_surface: SketchSurface,
at: [TyF64; 2],
tag: Option<TagNode>,
exec_state: &mut ExecState,
ctx: &ExecutorContext,
source_range: SourceRange,
) -> Result<Sketch, KclError> {
let id = exec_state.next_uuid();
create_sketch(id, sketch_surface, at, tag, true, exec_state, ctx, source_range).await
}
#[expect(clippy::too_many_arguments)]
pub(crate) async fn create_sketch(
id: Uuid,
sketch_surface: SketchSurface,
at: [TyF64; 2],
tag: Option<TagNode>,
send_to_engine: bool,
exec_state: &mut ExecState,
ctx: &ExecutorContext,
source_range: SourceRange,
) -> Result<Sketch, KclError> {
match &sketch_surface {
SketchSurface::Face(face) => {
exec_state
.flush_batch_for_solids(
ModelingCmdMeta::new(exec_state, ctx, source_range),
&[(*face.solid).clone()],
)
.await?;
}
SketchSurface::Plane(plane) if !plane.is_standard() => {
exec_state
.batch_end_cmd(
ModelingCmdMeta::new(exec_state, ctx, source_range),
ModelingCmd::from(mcmd::ObjectVisible::builder().object_id(plane.id).hidden(true).build()),
)
.await?;
}
_ => {}
}
let path_id = id;
let enable_sketch_id = exec_state.next_uuid();
let move_pen_id = exec_state.next_uuid();
let disable_sketch_id = exec_state.next_uuid();
if send_to_engine {
exec_state
.batch_modeling_cmds(
ModelingCmdMeta::new(exec_state, ctx, source_range),
&[
ModelingCmdReq {
cmd: ModelingCmd::from(if let SketchSurface::Plane(plane) = &sketch_surface {
let normal = plane.info.x_axis.axes_cross_product(&plane.info.y_axis);
mcmd::EnableSketchMode::builder()
.animated(false)
.ortho(false)
.entity_id(sketch_surface.id())
.adjust_camera(false)
.planar_normal(normal.into())
.build()
} else {
mcmd::EnableSketchMode::builder()
.animated(false)
.ortho(false)
.entity_id(sketch_surface.id())
.adjust_camera(false)
.build()
}),
cmd_id: enable_sketch_id.into(),
},
ModelingCmdReq {
cmd: ModelingCmd::from(mcmd::StartPath::default()),
cmd_id: path_id.into(),
},
ModelingCmdReq {
cmd: ModelingCmd::from(
mcmd::MovePathPen::builder()
.path(path_id.into())
.to(KPoint2d::from(point_to_mm(at.clone())).with_z(0.0).map(LengthUnit))
.build(),
),
cmd_id: move_pen_id.into(),
},
ModelingCmdReq {
cmd: ModelingCmd::SketchModeDisable(mcmd::SketchModeDisable::default()),
cmd_id: disable_sketch_id.into(),
},
],
)
.await?;
}
let units = exec_state.length_unit();
let to = point_to_len_unit(at, units);
let current_path = BasePath {
from: to,
to,
tag: tag.clone(),
units,
geo_meta: GeoMeta {
id: move_pen_id,
metadata: source_range.into(),
},
};
let mut sketch = Sketch {
id: path_id,
original_id: path_id,
artifact_id: path_id.into(),
on: sketch_surface,
paths: vec![],
inner_paths: vec![],
units,
mirror: Default::default(),
clone: Default::default(),
synthetic_jump_path_ids: vec![],
meta: vec![source_range.into()],
tags: Default::default(),
start: current_path.clone(),
is_closed: ProfileClosed::No,
};
if let Some(tag) = &tag {
let path = Path::Base { base: current_path };
sketch.add_tag(tag, &path, exec_state, None);
}
Ok(sketch)
}
pub async fn profile_start_x(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch: Sketch = args.get_unlabeled_kw_arg("profile", &RuntimeType::sketch(), exec_state)?;
let ty = sketch.units.into();
let x = inner_profile_start_x(sketch)?;
Ok(args.make_user_val_from_f64_with_type(TyF64::new(x, ty)))
}
pub(crate) fn inner_profile_start_x(profile: Sketch) -> Result<f64, KclError> {
Ok(profile.start.to[0])
}
pub async fn profile_start_y(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch: Sketch = args.get_unlabeled_kw_arg("profile", &RuntimeType::sketch(), exec_state)?;
let ty = sketch.units.into();
let x = inner_profile_start_y(sketch)?;
Ok(args.make_user_val_from_f64_with_type(TyF64::new(x, ty)))
}
pub(crate) fn inner_profile_start_y(profile: Sketch) -> Result<f64, KclError> {
Ok(profile.start.to[1])
}
pub async fn profile_start(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch: Sketch = args.get_unlabeled_kw_arg("profile", &RuntimeType::sketch(), exec_state)?;
let ty = sketch.units.into();
let point = inner_profile_start(sketch)?;
Ok(KclValue::from_point2d(point, ty, args.into()))
}
pub(crate) fn inner_profile_start(profile: Sketch) -> Result<[f64; 2], KclError> {
Ok(profile.start.to)
}
pub async fn close(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_close(sketch, tag, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
pub(crate) async fn inner_close(
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
if matches!(sketch.is_closed, ProfileClosed::Explicitly) {
exec_state.warn(
crate::CompilationIssue {
source_range: args.source_range,
message: "This sketch is already closed. Remove this unnecessary `close()` call".to_string(),
suggestion: None,
severity: crate::errors::Severity::Warning,
tag: crate::errors::Tag::Unnecessary,
},
annotations::WARN_UNNECESSARY_CLOSE,
);
return Ok(sketch);
}
let from = sketch.current_pen_position()?;
let to = point_to_len_unit(sketch.start.get_from(), from.units);
let id = exec_state.next_uuid();
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(mcmd::ClosePath::builder().path_id(sketch.id).build()),
)
.await?;
let mut new_sketch = sketch;
let distance = ((from.x - to[0]).powi(2) + (from.y - to[1]).powi(2)).sqrt();
if distance > super::EQUAL_POINTS_DIST_EPSILON {
let current_path = Path::ToPoint {
base: BasePath {
from: from.ignore_units(),
to,
tag: tag.clone(),
units: new_sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
new_sketch.paths.push(current_path);
} else if tag.is_some() {
exec_state.warn(
crate::CompilationIssue {
source_range: args.source_range,
message: "A tag declarator was specified, but no segment was created".to_string(),
suggestion: None,
severity: crate::errors::Severity::Warning,
tag: crate::errors::Tag::Unnecessary,
},
annotations::WARN_UNUSED_TAGS,
);
}
new_sketch.is_closed = ProfileClosed::Explicitly;
Ok(new_sketch)
}
pub async fn arc(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let angle_start: Option<TyF64> = args.get_kw_arg_opt("angleStart", &RuntimeType::degrees(), exec_state)?;
let angle_end: Option<TyF64> = args.get_kw_arg_opt("angleEnd", &RuntimeType::degrees(), exec_state)?;
let radius: Option<TyF64> = args.get_kw_arg_opt("radius", &RuntimeType::length(), exec_state)?;
let diameter: Option<TyF64> = args.get_kw_arg_opt("diameter", &RuntimeType::length(), exec_state)?;
let end_absolute: Option<[TyF64; 2]> = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let interior_absolute: Option<[TyF64; 2]> =
args.get_kw_arg_opt("interiorAbsolute", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_arc(
sketch,
angle_start,
angle_end,
radius,
diameter,
interior_absolute,
end_absolute,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
pub(crate) async fn inner_arc(
sketch: Sketch,
angle_start: Option<TyF64>,
angle_end: Option<TyF64>,
radius: Option<TyF64>,
diameter: Option<TyF64>,
interior_absolute: Option<[TyF64; 2]>,
end_absolute: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from: Point2d = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
match (angle_start, angle_end, radius, diameter, interior_absolute, end_absolute) {
(Some(angle_start), Some(angle_end), radius, diameter, None, None) => {
let radius = get_radius(radius, diameter, args.source_range)?;
relative_arc(id, exec_state, sketch, from, angle_start, angle_end, radius, tag, true, &args.ctx, args.source_range).await
}
(None, None, None, None, Some(interior_absolute), Some(end_absolute)) => {
absolute_arc(&args, id, exec_state, sketch, from, interior_absolute, end_absolute, tag).await
}
_ => {
Err(KclError::new_type(KclErrorDetails::new(
"Invalid combination of arguments. Either provide (angleStart, angleEnd, radius) or (endAbsolute, interiorAbsolute)".to_owned(),
vec![args.source_range],
)))
}
}
}
#[allow(clippy::too_many_arguments)]
pub async fn absolute_arc(
args: &Args,
id: uuid::Uuid,
exec_state: &mut ExecState,
sketch: Sketch,
from: Point2d,
interior_absolute: [TyF64; 2],
end_absolute: [TyF64; 2],
tag: Option<TagNode>,
) -> Result<Sketch, KclError> {
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::ArcTo {
end: kcmc::shared::Point3d {
x: LengthUnit(end_absolute[0].to_mm()),
y: LengthUnit(end_absolute[1].to_mm()),
z: LengthUnit(0.0),
},
interior: kcmc::shared::Point3d {
x: LengthUnit(interior_absolute[0].to_mm()),
y: LengthUnit(interior_absolute[1].to_mm()),
z: LengthUnit(0.0),
},
relative: false,
})
.build(),
),
)
.await?;
let start = [from.x, from.y];
let end = point_to_len_unit(end_absolute, from.units);
let loops_back_to_start = does_segment_close_sketch(end, sketch.start.from);
let current_path = Path::ArcThreePoint {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
p1: start,
p2: point_to_len_unit(interior_absolute, from.units),
p3: end,
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
#[allow(clippy::too_many_arguments)]
pub async fn relative_arc(
id: uuid::Uuid,
exec_state: &mut ExecState,
sketch: Sketch,
from: Point2d,
angle_start: TyF64,
angle_end: TyF64,
radius: TyF64,
tag: Option<TagNode>,
send_to_engine: bool,
ctx: &ExecutorContext,
source_range: SourceRange,
) -> Result<Sketch, KclError> {
let a_start = Angle::from_degrees(angle_start.to_degrees(exec_state, source_range));
let a_end = Angle::from_degrees(angle_end.to_degrees(exec_state, source_range));
let radius = radius.to_length_units(from.units);
let (center, end) = arc_center_and_end(from.ignore_units(), a_start, a_end, radius);
if a_start == a_end {
return Err(KclError::new_type(KclErrorDetails::new(
"Arc start and end angles must be different".to_string(),
vec![source_range],
)));
}
let ccw = a_start < a_end;
if send_to_engine {
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::with_id(exec_state, ctx, source_range, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Arc {
start: a_start,
end: a_end,
center: KPoint2d::from(untyped_point_to_mm(center, from.units)).map(LengthUnit),
radius: LengthUnit(
crate::execution::types::adjust_length(from.units, radius, UnitLength::Millimeters).0,
),
relative: false,
})
.build(),
),
)
.await?;
}
let loops_back_to_start = does_segment_close_sketch(end, sketch.start.from);
let current_path = Path::Arc {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: from.units,
geo_meta: GeoMeta {
id,
metadata: source_range.into(),
},
},
center,
radius,
ccw,
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn tangential_arc(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let radius = args.get_kw_arg_opt("radius", &RuntimeType::length(), exec_state)?;
let diameter = args.get_kw_arg_opt("diameter", &RuntimeType::length(), exec_state)?;
let angle = args.get_kw_arg_opt("angle", &RuntimeType::angle(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_tangential_arc(
sketch,
end_absolute,
end,
radius,
diameter,
angle,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
async fn inner_tangential_arc(
sketch: Sketch,
end_absolute: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
radius: Option<TyF64>,
diameter: Option<TyF64>,
angle: Option<TyF64>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
match (end_absolute, end, radius, diameter, angle) {
(Some(point), None, None, None, None) => {
inner_tangential_arc_to_point(sketch, point, true, tag, exec_state, args).await
}
(None, Some(point), None, None, None) => {
inner_tangential_arc_to_point(sketch, point, false, tag, exec_state, args).await
}
(None, None, radius, diameter, Some(angle)) => {
let radius = get_radius(radius, diameter, args.source_range)?;
let data = TangentialArcData::RadiusAndOffset { radius, offset: angle };
inner_tangential_arc_radius_angle(data, sketch, tag, exec_state, args).await
}
(Some(_), Some(_), None, None, None) => Err(KclError::new_semantic(KclErrorDetails::new(
"You cannot give both `end` and `endAbsolute` params, you have to choose one or the other".to_owned(),
vec![args.source_range],
))),
(_, _, _, _, _) => Err(KclError::new_semantic(KclErrorDetails::new(
"You must supply `end`, `endAbsolute`, or both `angle` and `radius`/`diameter` arguments".to_owned(),
vec![args.source_range],
))),
}
}
#[derive(Debug, Clone, Serialize, PartialEq, ts_rs::TS)]
#[ts(export)]
#[serde(rename_all = "camelCase", untagged)]
pub enum TangentialArcData {
RadiusAndOffset {
radius: TyF64,
offset: TyF64,
},
}
async fn inner_tangential_arc_radius_angle(
data: TangentialArcData,
sketch: Sketch,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from: Point2d = sketch.current_pen_position()?;
let tangent_info = sketch.get_tangential_info_from_paths(); let tan_previous_point = tangent_info.tan_previous_point(from.ignore_units());
let id = exec_state.next_uuid();
let (center, to, ccw) = match data {
TangentialArcData::RadiusAndOffset { radius, offset } => {
let offset = Angle::from_degrees(offset.to_degrees(exec_state, args.source_range));
let previous_end_tangent = Angle::from_radians(libm::atan2(
from.y - tan_previous_point[1],
from.x - tan_previous_point[0],
));
let ccw = offset.to_degrees() > 0.0;
let tangent_to_arc_start_angle = if ccw {
Angle::from_degrees(-90.0)
} else {
Angle::from_degrees(90.0)
};
let start_angle = previous_end_tangent + tangent_to_arc_start_angle;
let end_angle = start_angle + offset;
let (center, to) = arc_center_and_end(
from.ignore_units(),
start_angle,
end_angle,
radius.to_length_units(from.units),
);
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::TangentialArc {
radius: LengthUnit(radius.to_mm()),
offset,
})
.build(),
),
)
.await?;
(center, to, ccw)
}
};
let loops_back_to_start = does_segment_close_sketch(to, sketch.start.from);
let current_path = Path::TangentialArc {
ccw,
center,
base: BasePath {
from: from.ignore_units(),
to,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
fn tan_arc_to(sketch: &Sketch, to: [f64; 2]) -> ModelingCmd {
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::TangentialArcTo {
angle_snap_increment: None,
to: KPoint2d::from(untyped_point_to_mm(to, sketch.units))
.with_z(0.0)
.map(LengthUnit),
})
.build(),
)
}
async fn inner_tangential_arc_to_point(
sketch: Sketch,
point: [TyF64; 2],
is_absolute: bool,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from: Point2d = sketch.current_pen_position()?;
let tangent_info = sketch.get_tangential_info_from_paths();
let tan_previous_point = tangent_info.tan_previous_point(from.ignore_units());
let point = point_to_len_unit(point, from.units);
let to = if is_absolute {
point
} else {
[from.x + point[0], from.y + point[1]]
};
let loops_back_to_start = does_segment_close_sketch(to, sketch.start.from);
let [to_x, to_y] = to;
let result = get_tangential_arc_to_info(TangentialArcInfoInput {
arc_start_point: [from.x, from.y],
arc_end_point: [to_x, to_y],
tan_previous_point,
obtuse: true,
});
if result.center[0].is_infinite() {
return Err(KclError::new_semantic(KclErrorDetails::new(
"could not sketch tangential arc, because its center would be infinitely far away in the X direction"
.to_owned(),
vec![args.source_range],
)));
} else if result.center[1].is_infinite() {
return Err(KclError::new_semantic(KclErrorDetails::new(
"could not sketch tangential arc, because its center would be infinitely far away in the Y direction"
.to_owned(),
vec![args.source_range],
)));
}
let delta = if is_absolute {
[to_x - from.x, to_y - from.y]
} else {
point
};
let id = exec_state.next_uuid();
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
tan_arc_to(&sketch, delta),
)
.await?;
let current_path = Path::TangentialArcTo {
base: BasePath {
from: from.ignore_units(),
to,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
center: result.center,
ccw: result.ccw > 0,
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn bezier_curve(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let control1 = args.get_kw_arg_opt("control1", &RuntimeType::point2d(), exec_state)?;
let control2 = args.get_kw_arg_opt("control2", &RuntimeType::point2d(), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let control1_absolute = args.get_kw_arg_opt("control1Absolute", &RuntimeType::point2d(), exec_state)?;
let control2_absolute = args.get_kw_arg_opt("control2Absolute", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_bezier_curve(
sketch,
control1,
control2,
end,
control1_absolute,
control2_absolute,
end_absolute,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
async fn inner_bezier_curve(
sketch: Sketch,
control1: Option<[TyF64; 2]>,
control2: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
control1_absolute: Option<[TyF64; 2]>,
control2_absolute: Option<[TyF64; 2]>,
end_absolute: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
let (to, control1_abs, control2_abs) = match (
control1,
control2,
end,
control1_absolute,
control2_absolute,
end_absolute,
) {
(Some(control1), Some(control2), Some(end), None, None, None) => {
let delta = end.clone();
let to = [
from.x + end[0].to_length_units(from.units),
from.y + end[1].to_length_units(from.units),
];
let control1_abs = [
from.x + control1[0].to_length_units(from.units),
from.y + control1[1].to_length_units(from.units),
];
let control2_abs = [
from.x + control2[0].to_length_units(from.units),
from.y + control2[1].to_length_units(from.units),
];
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Bezier {
control1: KPoint2d::from(point_to_mm(control1)).with_z(0.0).map(LengthUnit),
control2: KPoint2d::from(point_to_mm(control2)).with_z(0.0).map(LengthUnit),
end: KPoint2d::from(point_to_mm(delta)).with_z(0.0).map(LengthUnit),
relative: true,
})
.build(),
),
)
.await?;
(to, control1_abs, control2_abs)
}
(None, None, None, Some(control1), Some(control2), Some(end)) => {
let to = [end[0].to_length_units(from.units), end[1].to_length_units(from.units)];
let control1_abs = control1.clone().map(|v| v.to_length_units(from.units));
let control2_abs = control2.clone().map(|v| v.to_length_units(from.units));
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Bezier {
control1: KPoint2d::from(point_to_mm(control1)).with_z(0.0).map(LengthUnit),
control2: KPoint2d::from(point_to_mm(control2)).with_z(0.0).map(LengthUnit),
end: KPoint2d::from(point_to_mm(end)).with_z(0.0).map(LengthUnit),
relative: false,
})
.build(),
),
)
.await?;
(to, control1_abs, control2_abs)
}
_ => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"You must either give `control1`, `control2` and `end`, or `control1Absolute`, `control2Absolute` and `endAbsolute`.".to_owned(),
vec![args.source_range],
)));
}
};
let loops_back_to_start = does_segment_close_sketch(to, sketch.start.from);
let current_path = Path::Bezier {
base: BasePath {
from: from.ignore_units(),
to,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
control1: control1_abs,
control2: control2_abs,
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn subtract_2d(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let tool: Vec<Sketch> = args.get_kw_arg(
"tool",
&RuntimeType::Array(
Box::new(RuntimeType::Primitive(PrimitiveType::Sketch)),
ArrayLen::Minimum(1),
),
exec_state,
)?;
let new_sketch = inner_subtract_2d(sketch, tool, exec_state, args).await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
async fn inner_subtract_2d(
mut sketch: Sketch,
tool: Vec<Sketch>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
for hole_sketch in tool {
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args(exec_state, &args),
ModelingCmd::from(
mcmd::Solid2dAddHole::builder()
.object_id(sketch.id)
.hole_id(hole_sketch.id)
.build(),
),
)
.await?;
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args(exec_state, &args),
ModelingCmd::from(
mcmd::ObjectVisible::builder()
.object_id(hole_sketch.id)
.hidden(true)
.build(),
),
)
.await?;
sketch.inner_paths.extend_from_slice(&hole_sketch.paths);
}
Ok(sketch)
}
pub async fn elliptic_point(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let x = args.get_kw_arg_opt("x", &RuntimeType::length(), exec_state)?;
let y = args.get_kw_arg_opt("y", &RuntimeType::length(), exec_state)?;
let major_radius = args.get_kw_arg("majorRadius", &RuntimeType::num_any(), exec_state)?;
let minor_radius = args.get_kw_arg("minorRadius", &RuntimeType::num_any(), exec_state)?;
let elliptic_point = inner_elliptic_point(x, y, major_radius, minor_radius, &args).await?;
args.make_kcl_val_from_point(elliptic_point, exec_state.length_unit().into())
}
async fn inner_elliptic_point(
x: Option<TyF64>,
y: Option<TyF64>,
major_radius: TyF64,
minor_radius: TyF64,
args: &Args,
) -> Result<[f64; 2], KclError> {
let major_radius = major_radius.n;
let minor_radius = minor_radius.n;
if let Some(x) = x {
if x.n.abs() > major_radius {
Err(KclError::Type {
details: KclErrorDetails::new(
format!(
"Invalid input. The x value, {}, cannot be larger than the major radius {}.",
x.n, major_radius
),
vec![args.source_range],
),
})
} else {
Ok((
x.n,
minor_radius * (1.0 - x.n.powf(2.0) / major_radius.powf(2.0)).sqrt(),
)
.into())
}
} else if let Some(y) = y {
if y.n > minor_radius {
Err(KclError::Type {
details: KclErrorDetails::new(
format!(
"Invalid input. The y value, {}, cannot be larger than the minor radius {}.",
y.n, minor_radius
),
vec![args.source_range],
),
})
} else {
Ok((
major_radius * (1.0 - y.n.powf(2.0) / minor_radius.powf(2.0)).sqrt(),
y.n,
)
.into())
}
} else {
Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid input. Must have either x or y, you cannot have both or neither.".to_owned(),
vec![args.source_range],
),
})
}
}
pub async fn elliptic(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let center = args.get_kw_arg("center", &RuntimeType::point2d(), exec_state)?;
let angle_start = args.get_kw_arg("angleStart", &RuntimeType::degrees(), exec_state)?;
let angle_end = args.get_kw_arg("angleEnd", &RuntimeType::degrees(), exec_state)?;
let major_radius = args.get_kw_arg_opt("majorRadius", &RuntimeType::length(), exec_state)?;
let major_axis = args.get_kw_arg_opt("majorAxis", &RuntimeType::point2d(), exec_state)?;
let minor_radius = args.get_kw_arg("minorRadius", &RuntimeType::length(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_elliptic(
sketch,
center,
angle_start,
angle_end,
major_radius,
major_axis,
minor_radius,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
pub(crate) async fn inner_elliptic(
sketch: Sketch,
center: [TyF64; 2],
angle_start: TyF64,
angle_end: TyF64,
major_radius: Option<TyF64>,
major_axis: Option<[TyF64; 2]>,
minor_radius: TyF64,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from: Point2d = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
let center_u = point_to_len_unit(center, from.units);
let major_axis = match (major_axis, major_radius) {
(Some(_), Some(_)) | (None, None) => {
return Err(KclError::new_type(KclErrorDetails::new(
"Provide either `majorAxis` or `majorRadius`.".to_string(),
vec![args.source_range],
)));
}
(Some(major_axis), None) => major_axis,
(None, Some(major_radius)) => [
major_radius.clone(),
TyF64 {
n: 0.0,
ty: major_radius.ty,
},
],
};
let start_angle = Angle::from_degrees(angle_start.to_degrees(exec_state, args.source_range));
let end_angle = Angle::from_degrees(angle_end.to_degrees(exec_state, args.source_range));
let major_axis_magnitude = (major_axis[0].to_length_units(from.units) * major_axis[0].to_length_units(from.units)
+ major_axis[1].to_length_units(from.units) * major_axis[1].to_length_units(from.units))
.sqrt();
let to = [
major_axis_magnitude * libm::cos(end_angle.to_radians()),
minor_radius.to_length_units(from.units) * libm::sin(end_angle.to_radians()),
];
let loops_back_to_start = does_segment_close_sketch(to, sketch.start.from);
let major_axis_angle = libm::atan2(major_axis[1].n, major_axis[0].n);
let point = [
center_u[0] + to[0] * libm::cos(major_axis_angle) - to[1] * libm::sin(major_axis_angle),
center_u[1] + to[0] * libm::sin(major_axis_angle) + to[1] * libm::cos(major_axis_angle),
];
let axis = major_axis.map(|x| x.to_mm());
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::Ellipse {
center: KPoint2d::from(untyped_point_to_mm(center_u, from.units)).map(LengthUnit),
major_axis: axis.map(LengthUnit).into(),
minor_radius: LengthUnit(minor_radius.to_mm()),
start_angle,
end_angle,
})
.build(),
),
)
.await?;
let current_path = Path::Ellipse {
ccw: start_angle < end_angle,
center: center_u,
major_axis: axis,
minor_radius: minor_radius.to_mm(),
base: BasePath {
from: from.ignore_units(),
to: point,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn hyperbolic_point(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let x = args.get_kw_arg_opt("x", &RuntimeType::length(), exec_state)?;
let y = args.get_kw_arg_opt("y", &RuntimeType::length(), exec_state)?;
let semi_major = args.get_kw_arg("semiMajor", &RuntimeType::num_any(), exec_state)?;
let semi_minor = args.get_kw_arg("semiMinor", &RuntimeType::num_any(), exec_state)?;
let hyperbolic_point = inner_hyperbolic_point(x, y, semi_major, semi_minor, &args).await?;
args.make_kcl_val_from_point(hyperbolic_point, exec_state.length_unit().into())
}
async fn inner_hyperbolic_point(
x: Option<TyF64>,
y: Option<TyF64>,
semi_major: TyF64,
semi_minor: TyF64,
args: &Args,
) -> Result<[f64; 2], KclError> {
let semi_major = semi_major.n;
let semi_minor = semi_minor.n;
if let Some(x) = x {
if x.n.abs() < semi_major {
Err(KclError::Type {
details: KclErrorDetails::new(
format!(
"Invalid input. The x value, {}, cannot be less than the semi major value, {}.",
x.n, semi_major
),
vec![args.source_range],
),
})
} else {
Ok((x.n, semi_minor * (x.n.powf(2.0) / semi_major.powf(2.0) - 1.0).sqrt()).into())
}
} else if let Some(y) = y {
Ok((semi_major * (y.n.powf(2.0) / semi_minor.powf(2.0) + 1.0).sqrt(), y.n).into())
} else {
Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid input. Must have either x or y, cannot have both or neither.".to_owned(),
vec![args.source_range],
),
})
}
}
pub async fn hyperbolic(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let semi_major = args.get_kw_arg("semiMajor", &RuntimeType::length(), exec_state)?;
let semi_minor = args.get_kw_arg("semiMinor", &RuntimeType::length(), exec_state)?;
let interior = args.get_kw_arg_opt("interior", &RuntimeType::point2d(), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let interior_absolute = args.get_kw_arg_opt("interiorAbsolute", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_hyperbolic(
sketch,
semi_major,
semi_minor,
interior,
end,
interior_absolute,
end_absolute,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
fn hyperbolic_tangent(point: Point2d, semi_major: f64, semi_minor: f64) -> [f64; 2] {
(point.y * semi_major.powf(2.0), point.x * semi_minor.powf(2.0)).into()
}
#[allow(clippy::too_many_arguments)]
pub(crate) async fn inner_hyperbolic(
sketch: Sketch,
semi_major: TyF64,
semi_minor: TyF64,
interior: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
interior_absolute: Option<[TyF64; 2]>,
end_absolute: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
let (interior, end, relative) = match (interior, end, interior_absolute, end_absolute) {
(Some(interior), Some(end), None, None) => (interior, end, true),
(None, None, Some(interior_absolute), Some(end_absolute)) => (interior_absolute, end_absolute, false),
_ => return Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid combination of arguments. Either provide (end, interior) or (endAbsolute, interiorAbsolute)"
.to_owned(),
vec![args.source_range],
),
}),
};
let interior = point_to_len_unit(interior, from.units);
let end = point_to_len_unit(end, from.units);
let end_point = Point2d {
x: end[0],
y: end[1],
units: from.units,
};
let loops_back_to_start = does_segment_close_sketch(end, sketch.start.from);
let semi_major_u = semi_major.to_length_units(from.units);
let semi_minor_u = semi_minor.to_length_units(from.units);
let start_tangent = hyperbolic_tangent(from, semi_major_u, semi_minor_u);
let end_tangent = hyperbolic_tangent(end_point, semi_major_u, semi_minor_u);
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::ConicTo {
start_tangent: KPoint2d::from(untyped_point_to_mm(start_tangent, from.units)).map(LengthUnit),
end_tangent: KPoint2d::from(untyped_point_to_mm(end_tangent, from.units)).map(LengthUnit),
end: KPoint2d::from(untyped_point_to_mm(end, from.units)).map(LengthUnit),
interior: KPoint2d::from(untyped_point_to_mm(interior, from.units)).map(LengthUnit),
relative,
})
.build(),
),
)
.await?;
let current_path = Path::Conic {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
if loops_back_to_start {
new_sketch.is_closed = ProfileClosed::Implicitly;
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub async fn parabolic_point(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let x = args.get_kw_arg_opt("x", &RuntimeType::length(), exec_state)?;
let y = args.get_kw_arg_opt("y", &RuntimeType::length(), exec_state)?;
let coefficients = args.get_kw_arg(
"coefficients",
&RuntimeType::Array(Box::new(RuntimeType::num_any()), ArrayLen::Known(3)),
exec_state,
)?;
let parabolic_point = inner_parabolic_point(x, y, &coefficients, &args).await?;
args.make_kcl_val_from_point(parabolic_point, exec_state.length_unit().into())
}
async fn inner_parabolic_point(
x: Option<TyF64>,
y: Option<TyF64>,
coefficients: &[TyF64; 3],
args: &Args,
) -> Result<[f64; 2], KclError> {
let a = coefficients[0].n;
let b = coefficients[1].n;
let c = coefficients[2].n;
if let Some(x) = x {
Ok((x.n, a * x.n.powf(2.0) + b * x.n + c).into())
} else if let Some(y) = y {
let det = (b.powf(2.0) - 4.0 * a * (c - y.n)).sqrt();
Ok(((-b + det) / (2.0 * a), y.n).into())
} else {
Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid input. Must have either x or y, cannot have both or neither.".to_owned(),
vec![args.source_range],
),
})
}
}
pub async fn parabolic(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let coefficients = args.get_kw_arg_opt(
"coefficients",
&RuntimeType::Array(Box::new(RuntimeType::num_any()), ArrayLen::Known(3)),
exec_state,
)?;
let interior = args.get_kw_arg_opt("interior", &RuntimeType::point2d(), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let interior_absolute = args.get_kw_arg_opt("interiorAbsolute", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_parabolic(
sketch,
coefficients,
interior,
end,
interior_absolute,
end_absolute,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
fn parabolic_tangent(point: Point2d, a: f64, b: f64) -> [f64; 2] {
(1.0, 2.0 * a * point.x + b).into()
}
#[allow(clippy::too_many_arguments)]
pub(crate) async fn inner_parabolic(
sketch: Sketch,
coefficients: Option<[TyF64; 3]>,
interior: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
interior_absolute: Option<[TyF64; 2]>,
end_absolute: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
if (coefficients.is_some() && interior.is_some()) || (coefficients.is_none() && interior.is_none()) {
return Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid combination of arguments. Either provide (a, b, c) or (interior)".to_owned(),
vec![args.source_range],
),
});
}
let (interior, end, relative) = match (coefficients.clone(), interior, end, interior_absolute, end_absolute) {
(None, Some(interior), Some(end), None, None) => {
let interior = point_to_len_unit(interior, from.units);
let end = point_to_len_unit(end, from.units);
(interior,end, true)
},
(None, None, None, Some(interior_absolute), Some(end_absolute)) => {
let interior_absolute = point_to_len_unit(interior_absolute, from.units);
let end_absolute = point_to_len_unit(end_absolute, from.units);
(interior_absolute, end_absolute, false)
}
(Some(coefficients), _, Some(end), _, _) => {
let end = point_to_len_unit(end, from.units);
let interior =
inner_parabolic_point(
Some(TyF64::count(0.5 * (from.x + end[0]))),
None,
&coefficients,
&args,
)
.await?;
(interior, end, true)
}
(Some(coefficients), _, _, _, Some(end)) => {
let end = point_to_len_unit(end, from.units);
let interior =
inner_parabolic_point(
Some(TyF64::count(0.5 * (from.x + end[0]))),
None,
&coefficients,
&args,
)
.await?;
(interior, end, false)
}
_ => return
Err(KclError::Type{details: KclErrorDetails::new(
"Invalid combination of arguments. Either provide (end, interior) or (endAbsolute, interiorAbsolute) if coefficients are not provided."
.to_owned(),
vec![args.source_range],
)}),
};
let end_point = Point2d {
x: end[0],
y: end[1],
units: from.units,
};
let (a, b, _c) = if let Some([a, b, c]) = coefficients {
(a.n, b.n, c.n)
} else {
let denom = (from.x - interior[0]) * (from.x - end_point.x) * (interior[0] - end_point.x);
let a = (end_point.x * (interior[1] - from.y)
+ interior[0] * (from.y - end_point.y)
+ from.x * (end_point.y - interior[1]))
/ denom;
let b = (end_point.x.powf(2.0) * (from.y - interior[1])
+ interior[0].powf(2.0) * (end_point.y - from.y)
+ from.x.powf(2.0) * (interior[1] - end_point.y))
/ denom;
let c = (interior[0] * end_point.x * (interior[0] - end_point.x) * from.y
+ end_point.x * from.x * (end_point.x - from.x) * interior[1]
+ from.x * interior[0] * (from.x - interior[0]) * end_point.y)
/ denom;
(a, b, c)
};
let start_tangent = parabolic_tangent(from, a, b);
let end_tangent = parabolic_tangent(end_point, a, b);
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::ConicTo {
start_tangent: KPoint2d::from(untyped_point_to_mm(start_tangent, from.units)).map(LengthUnit),
end_tangent: KPoint2d::from(untyped_point_to_mm(end_tangent, from.units)).map(LengthUnit),
end: KPoint2d::from(untyped_point_to_mm(end, from.units)).map(LengthUnit),
interior: KPoint2d::from(untyped_point_to_mm(interior, from.units)).map(LengthUnit),
relative,
})
.build(),
),
)
.await?;
let current_path = Path::Conic {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
fn conic_tangent(coefficients: [f64; 6], point: [f64; 2]) -> [f64; 2] {
let [a, b, c, d, e, _] = coefficients;
(
c * point[0] + 2.0 * b * point[1] + e,
-(2.0 * a * point[0] + c * point[1] + d),
)
.into()
}
pub async fn conic(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let sketch = args.get_unlabeled_kw_arg("sketch", &RuntimeType::Primitive(PrimitiveType::Sketch), exec_state)?;
let start_tangent = args.get_kw_arg_opt("startTangent", &RuntimeType::point2d(), exec_state)?;
let end_tangent = args.get_kw_arg_opt("endTangent", &RuntimeType::point2d(), exec_state)?;
let end = args.get_kw_arg_opt("end", &RuntimeType::point2d(), exec_state)?;
let interior = args.get_kw_arg_opt("interior", &RuntimeType::point2d(), exec_state)?;
let end_absolute = args.get_kw_arg_opt("endAbsolute", &RuntimeType::point2d(), exec_state)?;
let interior_absolute = args.get_kw_arg_opt("interiorAbsolute", &RuntimeType::point2d(), exec_state)?;
let coefficients = args.get_kw_arg_opt(
"coefficients",
&RuntimeType::Array(Box::new(RuntimeType::num_any()), ArrayLen::Known(6)),
exec_state,
)?;
let tag = args.get_kw_arg_opt("tag", &RuntimeType::tag_decl(), exec_state)?;
let new_sketch = inner_conic(
sketch,
start_tangent,
end,
end_tangent,
interior,
coefficients,
interior_absolute,
end_absolute,
tag,
exec_state,
args,
)
.await?;
Ok(KclValue::Sketch {
value: Box::new(new_sketch),
})
}
#[allow(clippy::too_many_arguments)]
pub(crate) async fn inner_conic(
sketch: Sketch,
start_tangent: Option<[TyF64; 2]>,
end: Option<[TyF64; 2]>,
end_tangent: Option<[TyF64; 2]>,
interior: Option<[TyF64; 2]>,
coefficients: Option<[TyF64; 6]>,
interior_absolute: Option<[TyF64; 2]>,
end_absolute: Option<[TyF64; 2]>,
tag: Option<TagNode>,
exec_state: &mut ExecState,
args: Args,
) -> Result<Sketch, KclError> {
let from: Point2d = sketch.current_pen_position()?;
let id = exec_state.next_uuid();
if (coefficients.is_some() && (start_tangent.is_some() || end_tangent.is_some()))
|| (coefficients.is_none() && (start_tangent.is_none() && end_tangent.is_none()))
{
return Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid combination of arguments. Either provide coefficients or (startTangent, endTangent)"
.to_owned(),
vec![args.source_range],
),
});
}
let (interior, end, relative) = match (interior, end, interior_absolute, end_absolute) {
(Some(interior), Some(end), None, None) => (interior, end, true),
(None, None, Some(interior_absolute), Some(end_absolute)) => (interior_absolute, end_absolute, false),
_ => return Err(KclError::Type {
details: KclErrorDetails::new(
"Invalid combination of arguments. Either provide (end, interior) or (endAbsolute, interiorAbsolute)"
.to_owned(),
vec![args.source_range],
),
}),
};
let end = point_to_len_unit(end, from.units);
let interior = point_to_len_unit(interior, from.units);
let (start_tangent, end_tangent) = if let Some(coeffs) = coefficients {
let (coeffs, _) = untype_array(coeffs);
(conic_tangent(coeffs, [from.x, from.y]), conic_tangent(coeffs, end))
} else {
let start = if let Some(start_tangent) = start_tangent {
point_to_len_unit(start_tangent, from.units)
} else {
let previous_point = sketch
.get_tangential_info_from_paths()
.tan_previous_point(from.ignore_units());
let from = from.ignore_units();
[from[0] - previous_point[0], from[1] - previous_point[1]]
};
let Some(end_tangent) = end_tangent else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"You must either provide either `coefficients` or `endTangent`.".to_owned(),
vec![args.source_range],
)));
};
let end_tan = point_to_len_unit(end_tangent, from.units);
(start, end_tan)
};
exec_state
.batch_modeling_cmd(
ModelingCmdMeta::from_args_id(exec_state, &args, id),
ModelingCmd::from(
mcmd::ExtendPath::builder()
.path(sketch.id.into())
.segment(PathSegment::ConicTo {
start_tangent: KPoint2d::from(untyped_point_to_mm(start_tangent, from.units)).map(LengthUnit),
end_tangent: KPoint2d::from(untyped_point_to_mm(end_tangent, from.units)).map(LengthUnit),
end: KPoint2d::from(untyped_point_to_mm(end, from.units)).map(LengthUnit),
interior: KPoint2d::from(untyped_point_to_mm(interior, from.units)).map(LengthUnit),
relative,
})
.build(),
),
)
.await?;
let current_path = Path::Conic {
base: BasePath {
from: from.ignore_units(),
to: end,
tag: tag.clone(),
units: sketch.units,
geo_meta: GeoMeta {
id,
metadata: args.source_range.into(),
},
},
};
let mut new_sketch = sketch;
if let Some(tag) = &tag {
new_sketch.add_tag(tag, ¤t_path, exec_state, None);
}
new_sketch.paths.push(current_path);
Ok(new_sketch)
}
pub(super) async fn region(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
let point = args.get_kw_arg_opt(
"point",
&RuntimeType::Union(vec![RuntimeType::point2d(), RuntimeType::segment()]),
exec_state,
)?;
let segments = args.get_kw_arg_opt(
"segments",
&RuntimeType::Array(Box::new(RuntimeType::segment()), ArrayLen::Minimum(1)),
exec_state,
)?;
let intersection_index = args.get_kw_arg_opt("intersectionIndex", &RuntimeType::count(), exec_state)?;
let direction = args.get_kw_arg_opt("direction", &RuntimeType::string(), exec_state)?;
let sketch = args.get_kw_arg_opt("sketch", &RuntimeType::any(), exec_state)?;
inner_region(point, segments, intersection_index, direction, sketch, exec_state, args).await
}
#[expect(clippy::large_enum_variant)]
enum SketchOrSegment {
Sketch(Sketch),
Segment(Segment),
}
impl SketchOrSegment {
fn sketch(&self) -> Result<&Sketch, KclError> {
match self {
SketchOrSegment::Sketch(sketch) => Ok(sketch),
SketchOrSegment::Segment(segment) => segment.sketch.as_ref().ok_or_else(|| {
KclError::new_semantic(KclErrorDetails::new(
"Segment should have an associated sketch".to_owned(),
vec![],
))
}),
}
}
}
async fn inner_region(
point: Option<KclValue>,
segments: Option<Vec<KclValue>>,
intersection_index: Option<TyF64>,
direction: Option<CircularDirection>,
sketch: Option<KclValue>,
exec_state: &mut ExecState,
args: Args,
) -> Result<KclValue, KclError> {
let region_id = exec_state.next_uuid();
let (sketch_or_segment, region_mapping) = match (point, segments) {
(Some(point), None) => {
let (sketch, pt) = region_from_point(point, sketch, &args)?;
let meta = ModelingCmdMeta::from_args_id(exec_state, &args, region_id);
let response = exec_state
.send_modeling_cmd(
meta,
ModelingCmd::from(
mcmd::CreateRegionFromQueryPoint::builder()
.object_id(sketch.sketch()?.id)
.query_point(KPoint2d::from(point_to_mm(pt.clone())).map(LengthUnit))
.build(),
),
)
.await?;
let region_mapping = if let kcmc::websocket::OkWebSocketResponseData::Modeling {
modeling_response: kcmc::ok_response::OkModelingCmdResponse::CreateRegionFromQueryPoint(data),
} = response
{
data.region_mapping
} else {
Default::default()
};
(sketch, region_mapping)
}
(None, Some(segments)) => {
if sketch.is_some() {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Sketch parameter must not be provided when segments parameters is provided".to_owned(),
vec![args.source_range],
)));
}
let segments_len = segments.len();
let mut segments = segments.into_iter();
let Some(seg0_value) = segments.next() else {
return Err(KclError::new_argument(KclErrorDetails::new(
format!("Expected at least 1 segment to create a region, but got {segments_len}"),
vec![args.source_range],
)));
};
let seg1_value = segments.next().unwrap_or_else(|| seg0_value.clone());
let Some(seg0) = seg0_value.into_segment() else {
return Err(KclError::new_argument(KclErrorDetails::new(
"Expected first segment to be a Segment".to_owned(),
vec![args.source_range],
)));
};
let Some(seg1) = seg1_value.into_segment() else {
return Err(KclError::new_argument(KclErrorDetails::new(
"Expected second segment to be a Segment".to_owned(),
vec![args.source_range],
)));
};
let intersection_index = intersection_index.map(|n| n.n as i32).unwrap_or(-1);
let direction = direction.unwrap_or(CircularDirection::Counterclockwise);
let Some(sketch) = &seg0.sketch else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected first segment to have an associated sketch. The sketch must be solved to create a region from it.".to_owned(),
vec![args.source_range],
)));
};
let meta = ModelingCmdMeta::from_args_id(exec_state, &args, region_id);
let response = exec_state
.send_modeling_cmd(
meta,
ModelingCmd::from(
mcmd::CreateRegion::builder()
.object_id(sketch.id)
.segment(seg0.id)
.intersection_segment(seg1.id)
.intersection_index(intersection_index)
.curve_clockwise(direction.is_clockwise())
.build(),
),
)
.await?;
let region_mapping = if let kcmc::websocket::OkWebSocketResponseData::Modeling {
modeling_response: kcmc::ok_response::OkModelingCmdResponse::CreateRegion(data),
} = response
{
data.region_mapping
} else {
Default::default()
};
(SketchOrSegment::Segment(seg0), region_mapping)
}
(Some(_), Some(_)) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Cannot provide both point and segments parameters. Choose one.".to_owned(),
vec![args.source_range],
)));
}
(None, None) => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Either point or segments parameter must be provided".to_owned(),
vec![args.source_range],
)));
}
};
let units = exec_state.length_unit();
let to = [0.0, 0.0];
let first_path = Path::ToPoint {
base: BasePath {
from: to,
to,
units,
tag: None,
geo_meta: GeoMeta {
id: match &sketch_or_segment {
SketchOrSegment::Sketch(sketch) => sketch.id,
SketchOrSegment::Segment(segment) => segment.id,
},
metadata: args.source_range.into(),
},
},
};
let start_base_path = BasePath {
from: to,
to,
tag: None,
units,
geo_meta: GeoMeta {
id: region_id,
metadata: args.source_range.into(),
},
};
let mut sketch = match sketch_or_segment {
SketchOrSegment::Sketch(sketch) => sketch,
SketchOrSegment::Segment(segment) => {
if let Some(sketch) = segment.sketch {
sketch
} else {
Sketch {
id: region_id,
original_id: region_id,
artifact_id: region_id.into(),
on: segment.surface.clone(),
paths: vec![first_path],
inner_paths: vec![],
units,
mirror: Default::default(),
clone: Default::default(),
synthetic_jump_path_ids: vec![],
meta: vec![args.source_range.into()],
tags: Default::default(),
start: start_base_path,
is_closed: ProfileClosed::Explicitly,
}
}
}
};
sketch.id = region_id;
sketch.original_id = region_id;
sketch.artifact_id = region_id.into();
let mut region_mapping = region_mapping;
if args.ctx.no_engine_commands().await && region_mapping.is_empty() {
let mut mock_mapping = HashMap::new();
for path in &sketch.paths {
mock_mapping.insert(exec_state.next_uuid(), path.get_id());
}
region_mapping = mock_mapping;
}
let original_segment_ids = sketch.paths.iter().map(|p| p.get_id()).collect::<Vec<_>>();
let original_seg_to_region = build_reverse_region_mapping(®ion_mapping, &original_segment_ids);
{
let mut new_paths = Vec::new();
for path in &sketch.paths {
let original_id = path.get_id();
if let Some(region_ids) = original_seg_to_region.get(&original_id) {
for region_id in region_ids {
let mut new_path = path.clone();
new_path.set_id(*region_id);
new_paths.push(new_path);
}
}
}
if new_paths.is_empty() && !region_mapping.is_empty() {
for region_edge_id in region_mapping.keys().sorted_unstable() {
new_paths.push(Path::ToPoint {
base: BasePath {
from: [0.0, 0.0],
to: [0.0, 0.0],
units,
tag: None,
geo_meta: GeoMeta {
id: *region_edge_id,
metadata: args.source_range.into(),
},
},
});
}
}
sketch.paths = new_paths;
for (_tag_name, tag) in &mut sketch.tags {
let Some(info) = tag.get_cur_info().cloned() else {
continue;
};
let original_id = info.id;
if let Some(region_ids) = original_seg_to_region.get(&original_id) {
let epoch = tag.info.last().map(|(e, _)| *e).unwrap_or(0);
for (i, region_id) in region_ids.iter().enumerate() {
if i == 0 {
if let Some((_, existing)) = tag.info.last_mut() {
existing.id = *region_id;
}
} else {
let mut new_info = info.clone();
new_info.id = *region_id;
tag.info.push((epoch, new_info));
}
}
}
}
}
if sketch.mirror.is_some() {
sketch.mirror = sketch.paths.first().map(|p| p.get_id());
}
sketch.meta.push(args.source_range.into());
sketch.is_closed = ProfileClosed::Explicitly;
Ok(KclValue::Sketch {
value: Box::new(sketch),
})
}
pub(crate) fn build_reverse_region_mapping(
region_mapping: &HashMap<Uuid, Uuid>,
original_segments: &[Uuid],
) -> IndexMap<Uuid, Vec<Uuid>> {
let mut reverse: HashMap<Uuid, Vec<Uuid>> = HashMap::default();
#[expect(
clippy::iter_over_hash_type,
reason = "This is bad since we're storing in an ordered Vec, but modeling-cmds gives us an unordered HashMap, so we don't really have a choice. This function exists to work around that."
)]
for (region_id, original_id) in region_mapping {
reverse.entry(*original_id).or_default().push(*region_id);
}
#[expect(
clippy::iter_over_hash_type,
reason = "This is safe since we're just sorting values."
)]
for values in reverse.values_mut() {
values.sort_unstable();
}
let mut ordered = IndexMap::with_capacity(original_segments.len());
for original_id in original_segments {
let mut region_ids = Vec::new();
reverse.entry(*original_id).and_modify(|entry_value| {
region_ids = std::mem::take(entry_value);
});
if !region_ids.is_empty() {
ordered.insert(*original_id, region_ids);
}
}
ordered
}
fn region_from_point(
point: KclValue,
sketch: Option<KclValue>,
args: &Args,
) -> Result<(SketchOrSegment, [TyF64; 2]), KclError> {
match point {
KclValue::HomArray { .. } | KclValue::Tuple { .. } => {
let Some(pt) = <[TyF64; 2]>::from_kcl_val(&point) else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected 2D point for point parameter".to_owned(),
vec![args.source_range],
)));
};
let Some(sketch_value) = sketch else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Sketch must be provided when point is a 2D point".to_owned(),
vec![args.source_range],
)));
};
let sketch = match sketch_value {
KclValue::Sketch { value } => *value,
KclValue::Object { value, .. } => {
let Some(meta_value) = value.get(SKETCH_OBJECT_META) else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected sketch to be of type Sketch with a meta field. Sketch must not be empty to create a region.".to_owned(),
vec![args.source_range],
)));
};
let meta_map = match meta_value {
KclValue::Object { value, .. } => value,
_ => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected sketch to be of type Sketch with a meta field that's an object".to_owned(),
vec![args.source_range],
)));
}
};
let Some(sketch_value) = meta_map.get(SKETCH_OBJECT_META_SKETCH) else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected sketch meta to have a sketch field. Sketch must not be empty to create a region."
.to_owned(),
vec![args.source_range],
)));
};
let Some(sketch) = sketch_value.as_sketch() else {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected sketch meta to have a sketch field of type Sketch. Sketch must not be empty to create a region.".to_owned(),
vec![args.source_range],
)));
};
sketch.clone()
}
_ => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected sketch to be of type Sketch".to_owned(),
vec![args.source_range],
)));
}
};
Ok((SketchOrSegment::Sketch(sketch), pt))
}
KclValue::Segment { value } => match value.repr {
crate::execution::SegmentRepr::Unsolved { .. } => Err(KclError::new_semantic(KclErrorDetails::new(
"Segment provided to point parameter is unsolved; segments must be solved to be used as points"
.to_owned(),
vec![args.source_range],
))),
crate::execution::SegmentRepr::Solved { segment } => {
let pt = match &segment.kind {
SegmentKind::Point { position, .. } => position.clone(),
_ => {
return Err(KclError::new_semantic(KclErrorDetails::new(
"Expected segment to be a point segment".to_owned(),
vec![args.source_range],
)));
}
};
Ok((SketchOrSegment::Segment(*segment), pt))
}
},
_ => Err(KclError::new_semantic(KclErrorDetails::new(
"Expected point to be either a 2D point like `[0, 0]` or a point segment created from `point()`".to_owned(),
vec![args.source_range],
))),
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use crate::execution::TagIdentifier;
use crate::std::sketch::PlaneData;
use crate::std::utils::calculate_circle_center;
#[test]
fn test_deserialize_plane_data() {
let data = PlaneData::XY;
let mut str_json = serde_json::to_string(&data).unwrap();
assert_eq!(str_json, "\"XY\"");
str_json = "\"YZ\"".to_string();
let data: PlaneData = serde_json::from_str(&str_json).unwrap();
assert_eq!(data, PlaneData::YZ);
str_json = "\"-YZ\"".to_string();
let data: PlaneData = serde_json::from_str(&str_json).unwrap();
assert_eq!(data, PlaneData::NegYZ);
str_json = "\"-xz\"".to_string();
let data: PlaneData = serde_json::from_str(&str_json).unwrap();
assert_eq!(data, PlaneData::NegXZ);
}
#[test]
fn test_deserialize_sketch_on_face_tag() {
let data = "start";
let mut str_json = serde_json::to_string(&data).unwrap();
assert_eq!(str_json, "\"start\"");
str_json = "\"end\"".to_string();
let data: crate::std::sketch::FaceTag = serde_json::from_str(&str_json).unwrap();
assert_eq!(
data,
crate::std::sketch::FaceTag::StartOrEnd(crate::std::sketch::StartOrEnd::End)
);
str_json = serde_json::to_string(&TagIdentifier {
value: "thing".to_string(),
info: Vec::new(),
meta: Default::default(),
})
.unwrap();
let data: crate::std::sketch::FaceTag = serde_json::from_str(&str_json).unwrap();
assert_eq!(
data,
crate::std::sketch::FaceTag::Tag(Box::new(TagIdentifier {
value: "thing".to_string(),
info: Vec::new(),
meta: Default::default()
}))
);
str_json = "\"END\"".to_string();
let data: crate::std::sketch::FaceTag = serde_json::from_str(&str_json).unwrap();
assert_eq!(
data,
crate::std::sketch::FaceTag::StartOrEnd(crate::std::sketch::StartOrEnd::End)
);
str_json = "\"start\"".to_string();
let data: crate::std::sketch::FaceTag = serde_json::from_str(&str_json).unwrap();
assert_eq!(
data,
crate::std::sketch::FaceTag::StartOrEnd(crate::std::sketch::StartOrEnd::Start)
);
str_json = "\"START\"".to_string();
let data: crate::std::sketch::FaceTag = serde_json::from_str(&str_json).unwrap();
assert_eq!(
data,
crate::std::sketch::FaceTag::StartOrEnd(crate::std::sketch::StartOrEnd::Start)
);
}
#[test]
fn test_circle_center() {
let actual = calculate_circle_center([0.0, 0.0], [5.0, 5.0], [10.0, 0.0]);
assert_eq!(actual[0], 5.0);
assert_eq!(actual[1], 0.0);
}
}