SolidCraft: an open-source parametric 3D CAD application built in pure Rust. Desktop, web, and automation through MCP.
//! Contracts and result types for the commands in `cmd/features.rs`.
//!
//! Field doc comments are the schemas' descriptions. Keys the handlers read only in some
//! situations (`sketch` without `face`, the thin-wall keys with `thin: true`) are optional
//! fields whose descriptions say so; the contracts don't check the combinations, and the
//! handlers ignore those keys otherwise.
use schemars::{JsonSchema, Schema, SchemaGenerator, json_schema};
use serde::de::Error as _;
use serde::{Deserialize, Deserializer, Serialize};
use serde_json::Value;
use super::check::whole;
use super::config::NameList;
use super::types::{
AngleExpr, AxisDir, AxisLine, CombineOperation, ConventionParam, DirectionParam, EdgeRefs, ExtentKeyword, ExtrudeOperation, FacesParam,
FeatureCommon, FilletCornerParam, FilletFitParam, FilletTurnParam, FilletTypeParam, FromPoint, GeoRefParam, IdOrName, LengthExpr, NumberExpr,
OperationParam, PlaneCommon, PlaneOrFace, Point3, PointExpr3, ProfilesParam, ScaleFactors, SketchRef, StringList, ThinSideParam, ToPoint,
TouchingParam, feature_common, present,
};
use crate::params::MAX_STRING_LIST;
/// Add a box primitive.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct BoxParams {
/// Size along X.
pub length: LengthExpr,
/// Size along Y.
pub width: LengthExpr,
/// Size along Z.
pub height: LengthExpr,
/// The box's minimum corner. Default: the origin. When both `corner` and `center` are given,
/// `corner` is used.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "PointExpr3")]
pub corner: Option<PointExpr3>,
/// The box's centre, instead of `corner`.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "PointExpr3")]
pub center: Option<PointExpr3>,
/// How the box combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on. Default: every body in the active
/// component (an intersect removes those the box doesn't meet). Ignored when
/// `participants` lists bodies.
#[serde(default)]
pub targets: Option<StringList>,
/// What a join makes of pieces that share no face. Default: separate.
#[serde(default)]
pub touching: Option<TouchingParam>,
/// The bodies a join, cut or intersect works on, in place of `targets`.
#[serde(default)]
pub participants: Option<StringList>,
/// The feature's name in the timeline.
#[serde(default)]
pub name: Option<String>,
/// The new body's name.
#[serde(default)]
pub body_name: Option<String>,
/// Names for the new bodies, in order.
#[serde(default)]
pub body_names: Option<StringList>,
}
/// Extrude sketch profiles (or a planar body face) into a solid.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct ExtrudeParams {
/// How far: the length one way; with `direction: symmetric`, the total thickness (per side
/// with `convention: legacy_per_side`); with `distance2`, the first side's length. Required
/// unless `through_all` or `to` is given.
#[serde(default)]
pub distance: Option<LengthExpr>,
/// The sketch to extrude, by id or name. Default: the active sketch, else the last one.
/// Ignored when `face` is given.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "IdOrName")]
pub sketch: Option<IdOrName>,
/// Which of the sketch's profiles to extrude. Default: all of them. Ignored when `face` is
/// given; not allowed with `thin`.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "ProfilesParam")]
pub profiles: Option<ProfilesParam>,
/// Each index or point pick is exactly the region it names. Without it, a pick on a drawn
/// profile that reference geometry (a face's projected outline) cuts into regions takes the
/// whole drawn profile. The dialogs send `true`: they highlight the regions they pick.
#[serde(default)]
pub exact_regions: Option<bool>,
/// A point on a planar body face to extrude instead of a sketch profile.
#[serde(default)]
pub face: Option<Point3>,
/// Several coplanar faces of one body to extrude together, by a point on each. Not with
/// `face`, `sketch` or `profiles`.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "FacesParam")]
pub faces: Option<FacesParam>,
/// The body whose face to use, where faces of several bodies meet at `face` (or `faces`).
#[serde(default)]
pub face_body: Option<String>,
/// With `face`, among placed instances: the body whose placement `face` is read in (read by
/// the engine's frame mapping, before the command runs). Default: `face_body`, else the
/// body nearest the point.
#[serde(default)]
pub body: Option<String>,
/// Extrude through everything in the way.
#[serde(default)]
pub through_all: Option<bool>,
/// `"through_all"`, the same as `through_all: true`.
#[serde(default)]
pub extent: Option<ExtentKeyword>,
/// Draft angle of the side walls (positive: outward, so the far end is larger along the
/// extrusion direction; negative: inward, so the far end is smaller).
#[serde(default)]
pub taper: Option<AngleExpr>,
/// Which way to extrude. Default: positive.
#[serde(default)]
pub direction: Option<DirectionParam>,
/// Two Sides: a second distance on the side `direction` leaves free; the first side may be
/// `through_all` or `to`. With `direction: negative` the first side goes against the normal
/// and `distance2` along it. A negative distance only turns its own side over.
#[serde(default)]
pub distance2: Option<LengthExpr>,
/// Start this far from the sketch plane, along its normal.
#[serde(default)]
pub start_offset: Option<LengthExpr>,
/// How a symmetric distance is read. Default: total_distance.
#[serde(default, deserialize_with = "present")]
#[schemars(with = "ConventionParam")]
pub convention: Option<ConventionParam>,
/// Extrude up to this face, vertex or point (To Object).
#[serde(default, deserialize_with = "present")]
#[schemars(with = "ToPoint")]
pub to: Option<ToPoint>,
/// How far past `to` to go.
#[serde(default)]
pub to_offset: Option<LengthExpr>,
/// Start at this face or point (From Object).
#[serde(default, deserialize_with = "present")]
#[schemars(with = "FromPoint")]
pub from: Option<FromPoint>,
/// How the extrusion combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<ExtrudeOperation>,
/// The bodies a join, cut or intersect works on. Default for a join from a body's face:
/// that body.
#[serde(default)]
pub targets: Option<StringList>,
/// What a join makes of pieces that share no face. Default: separate.
#[serde(default)]
pub touching: Option<TouchingParam>,
/// The bodies taking part; overrides the default scope.
#[serde(default)]
pub participants: Option<StringList>,
/// The feature's name in the timeline.
#[serde(default)]
pub name: Option<String>,
/// The new body's name.
#[serde(default)]
pub body_name: Option<String>,
/// Names for the new bodies, in order.
#[serde(default)]
pub body_names: Option<StringList>,
/// A thin wall along sketch curves instead of solid profiles.
// `skip_serializing_if` keeps schemars from writing `default: null`, which `bool` refuses.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "bool")]
pub thin: Option<bool>,
/// With `thin`: the curves the wall follows. Default: every drawn curve of the sketch.
#[serde(default)]
pub curves: Option<StringList>,
/// With `thin`: the wall's thickness.
#[serde(default)]
pub thickness: Option<LengthExpr>,
/// With `thin`: which side of the curves the wall lies on. Default: center.
#[serde(default)]
pub side: Option<ThinSideParam>,
/// With `thin` and `side: two_sides`: the thickness outside.
#[serde(default)]
pub thickness2: Option<LengthExpr>,
}
/// Something a feature's result tells the user without stopping them, with an action to take.
#[derive(Debug, Serialize, JsonSchema)]
pub struct FeatureNotice {
/// The text to show.
pub message: String,
/// How the bodies split off touched the others: `along_edge`, `at_point` or `touching` (along
/// a line or at a point their boundaries don't hold).
pub contact: String,
/// The command that changes the feature as the notice offers.
pub action: NoticeAction,
}
/// A command a notice offers to run.
#[derive(Debug, Serialize, JsonSchema)]
pub struct NoticeAction {
/// The action's label.
pub label: String,
/// The command's id.
pub command: String,
/// Its parameters.
pub params: Value,
}
/// Add a cylinder primitive.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct CylinderParams {
/// The radius. Give it or `diameter`; when both are given, `radius` is used.
#[serde(default)]
pub radius: Option<LengthExpr>,
/// The diameter, instead of `radius`.
#[serde(default)]
pub diameter: Option<LengthExpr>,
/// The height, along `axis`.
pub height: LengthExpr,
/// The centre of the bottom face. Default: the origin.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "PointExpr3")]
pub base: Option<PointExpr3>,
/// The direction from the bottom to the top. Default: Z.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "AxisDir")]
pub axis: Option<AxisDir>,
/// Up to two straight edges of the face it stands on, each `{edge: [x, y, z], distance: expr}`
/// (as `solid.hole`'s): the base centre goes that far from each edge's line, in the face's
/// plane, and follows the edges. With a numeric `base` only.
#[serde(default)]
#[schemars(with = "Option<Vec<serde_json::Value>>")]
pub references: Option<serde_json::Value>,
/// How the cylinder combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on. Default: every body in the active
/// component (an intersect removes those the cylinder doesn't meet).
/// Ignored when `participants` lists bodies.
#[serde(default)]
pub targets: Option<StringList>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Add a sphere primitive.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct SphereParams {
/// The radius. Give it or `diameter`; when both are given, `radius` is used.
#[serde(default)]
pub radius: Option<LengthExpr>,
/// The diameter, instead of `radius`.
#[serde(default)]
pub diameter: Option<LengthExpr>,
/// The centre. Default: the origin.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "PointExpr3")]
pub center: Option<PointExpr3>,
/// How the sphere combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on. Default: every body in the active
/// component (an intersect removes those the sphere doesn't meet).
/// Ignored when `participants` lists bodies.
#[serde(default)]
pub targets: Option<StringList>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Add a torus primitive, around the Z axis.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct TorusParams {
/// The major radius: from the centre to the middle of the ring.
pub major: LengthExpr,
/// The minor radius: of the ring's cross-section, above 0 and less than `major`.
pub minor: LengthExpr,
/// The centre. Default: the origin.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "PointExpr3")]
pub center: Option<PointExpr3>,
/// How the torus combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on. Default: every body in the active
/// component (an intersect removes those the torus doesn't meet).
/// Ignored when `participants` lists bodies.
#[serde(default)]
pub targets: Option<StringList>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Add a cone or truncated cone: the base circle and, `height` along `axis`, the top circle (a
/// point when its radius is 1e-6 mm or less). Its radii, height and base are within 1e7 mm.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct ConeParams {
/// The base circle's radius, above 1e-6 mm. Give it or `diameter`; when both are given,
/// `radius` is used.
#[serde(default)]
pub radius: Option<LengthExpr>,
/// The base circle's diameter, instead of `radius`.
#[serde(default)]
pub diameter: Option<LengthExpr>,
/// The top circle's radius, 0 or more; up to 1e-6 mm makes a full cone ending in a point.
/// When both are given, `top_radius` is used. Default: 0.
#[serde(default)]
pub top_radius: Option<LengthExpr>,
/// The top circle's diameter, instead of `top_radius`.
#[serde(default)]
pub top_diameter: Option<LengthExpr>,
/// The top's distance from the base along `axis`, more than 1e-6 mm either way; a negative
/// height goes the other way.
pub height: LengthExpr,
/// The centre of the base circle. Default: the origin.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "PointExpr3")]
pub base: Option<PointExpr3>,
/// The direction `height` is measured along: from the base towards the top when `height` is
/// positive. Default: Z.
#[serde(default, deserialize_with = "present", skip_serializing_if = "Option::is_none")]
#[schemars(with = "AxisDir")]
pub axis: Option<AxisDir>,
/// How the cone combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on. Default: every body in the active
/// component (an intersect removes those the cone doesn't meet).
/// Ignored when `participants` lists bodies.
#[serde(default)]
pub targets: Option<StringList>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Add a solid tube along a path of sketch curves.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct PipeParams {
/// The sketch holding the path, by id or name.
pub path_sketch: SketchRef,
/// The path's curve ids, in order along the path.
pub path: StringList,
/// The tube's outside diameter.
pub diameter: LengthExpr,
/// The wall thickness, for a hollow tube: above 0 and less than half `diameter`. Default:
/// solid.
#[serde(default)]
pub wall: Option<LengthExpr>,
/// How the pipe combines with existing bodies. Default: new.
#[serde(default)]
pub operation: Option<OperationParam>,
/// The bodies a join, cut or intersect works on; given, they win over `participants`.
/// Default: `participants`, else every body in the active component (an intersect removes
/// those the pipe doesn't meet), or for a cut or intersect where it has none, every body.
#[serde(default)]
pub targets: Option<StringList>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Add a box around bodies, larger by a margin on every side.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct BoundingSolidParams {
/// The bodies to enclose (`participants` doesn't change which). Default: all of them.
#[serde(default)]
pub bodies: Option<StringList>,
/// How much larger than the bodies on every side. Default: 0.
#[serde(default)]
pub margin: Option<LengthExpr>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// Scale bodies about a point.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct ScaleParams {
/// The bodies to scale.
pub bodies: StringList,
/// The same factor in every direction, above 1e-9 and below 1e6. Give it or `factors`.
#[serde(default)]
pub factor: Option<NumberExpr>,
/// Different factors along X, Y and Z, each above 1e-9 and below 1e6. When given, these set
/// the scale; a `factor` given too has no effect but must still evaluate.
#[serde(default)]
pub factors: Option<ScaleFactors>,
/// The point that stays where it is, in mm. Default: the origin.
#[serde(default)]
pub origin: Option<Point3>,
// Not `FeatureCommon`: a scale makes no body, so `body_name` and `body_names` would do nothing.
// `participants` stays because `timeline.redefine` passes a feature's own back.
/// The feature's name in the timeline.
#[serde(default)]
pub name: Option<String>,
/// The bodies taking part, which every feature records; each an existing body or `*`. A
/// scale changes only `bodies`, whatever this lists.
#[serde(default)]
pub participants: Option<StringList>,
}
/// Combine bodies: join the tool bodies to the target, cut them from it, or keep only the space
/// the target shares with them. Whether each body exists stays the handler's to check.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct CombineParams {
/// The body the tools combine with, by name.
#[serde(deserialize_with = "target_body")]
#[schemars(with = "String")]
pub target: String,
#[serde(deserialize_with = "tool_bodies")]
#[schemars(schema_with = "tool_bodies_schema")]
pub tools: NameList,
/// What the tools do to the target. Default: join.
#[serde(default)]
pub operation: Option<CombineOperation>,
/// What a join makes of pieces that share no face. Default: separate.
#[serde(default)]
pub touching: Option<TouchingParam>,
/// Keep the tool bodies as they are. Default: false (the combine uses them up).
#[serde(default)]
pub keep_tools: Option<bool>,
/// Move the result into a new component, made for it. Default: false.
#[serde(default)]
pub new_component: Option<bool>,
/// With `new_component`: the new component's name. Default: the target's name and
/// " Combined".
#[serde(default)]
pub component_name: Option<String>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// `target`: a body name, with the handler's message for anything else, `null` included.
fn target_body<'de, D: Deserializer<'de>>(d: D) -> Result<String, D::Error> {
match Value::deserialize(d)? {
Value::String(name) => Ok(name),
_ => Err(D::Error::custom(whole("`target` must be a body name"))),
}
}
/// The handler's message for no tools.
const NO_TOOLS: &str = "`tools` must list bodies";
/// `tools`: a name or a list of names, as `params::string_list` reads it and with its messages,
/// and at least one. An empty list, and `null` (which the reader reads as none), get the
/// handler's message for no tools.
fn tool_bodies<'de, D: Deserializer<'de>>(d: D) -> Result<NameList, D::Error> {
match Value::deserialize(d)? {
Value::Null => Err(D::Error::custom(whole(NO_TOOLS))),
v => match NameList::deserialize(v).map_err(D::Error::custom)? {
NameList(names) if names.is_empty() => Err(D::Error::custom(whole(NO_TOOLS))),
names => Ok(names),
},
}
}
fn tool_bodies_schema(_: &mut SchemaGenerator) -> Schema {
json_schema!({
"description": "The bodies combined with the target, by name: a name, or a list of one or more names (at most 10000).",
"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": MAX_STRING_LIST}]
})
}
/// What `solid.combine` returns: a feature command's reply, with the new component's id when
/// `new_component` moved the result into one.
#[derive(Debug, Serialize, JsonSchema)]
pub struct CombineResult {
#[serde(flatten)]
pub feature: FeatureResult,
/// With `new_component`: the id of the component the result went into.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub component: Option<u64>,
}
/// Add a construction plane parallel to `base`: `offset` away along its normal, or through a
/// point.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct OffsetPlaneParams {
/// The plane it is parallel to.
pub base: PlaneOrFace,
/// How far from `base`, along its normal (negative: the other way). Required unless
/// `through` is given; not with `through` (`null` counts as not given).
#[serde(default)]
pub offset: Option<LengthExpr>,
/// A point the plane goes through instead: a vertex, a construction point, a sketch point, a
/// fixed point, or the centre of a circular edge, a sketch circle or arc, or a spherical or
/// toroidal face. `null` counts as not given.
#[serde(default)]
pub through: Option<GeoRefParam>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: PlaneCommon,
}
/// Add a construction plane: `base` turned by `angle` about an axis.
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct PlaneAtAngleParams {
/// The plane to turn.
pub base: PlaneOrFace,
/// The axis it turns about. A picked edge's or face's axis points the way its largest
/// component is positive.
pub axis: AxisLine,
/// How far to turn, counterclockwise looking back along `axis`'s direction.
pub angle: AngleExpr,
/// Use only the axis direction (projected onto `base`), not the axis as a full line.
/// When true, the plane turns about the line through `pivot` (or the base origin).
#[serde(default)]
pub direction_only: Option<bool>,
/// Pivot for `direction_only`: a vertex, sketch point, construction point or fixed point.
/// Omit to use the base plane's origin. `null` counts as not given.
#[serde(default)]
pub pivot: Option<GeoRefParam>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: PlaneCommon,
}
/// Round edges of a body: a constant radius by default, or a chord, a curvature-continuous
/// section or a radius varying along each edge (`type`).
#[derive(Debug, Deserialize, JsonSchema)]
#[schemars(deny_unknown_fields)]
pub struct FilletParams {
/// The edges to round: a point on each, or `{body, index}`.
pub edges: EdgeRefs,
/// The radius; the chord's width with `type: chord`, the equivalent circular setback with
/// `type: curvature`, the start radius with `type: variable` or `spline`.
pub radius: LengthExpr,
/// The body whose edges the points pick. Default: each point is looked up on every placed
/// body, shown or hidden, and a point on edges of 2 bodies is refused, naming them.
#[serde(default)]
pub body: Option<String>,
/// Round each picked edge's tangent chain with it. Default: true; false rounds exactly the
/// picked edges.
#[serde(default)]
pub tangent_chain: Option<bool>,
#[serde(default, rename = "type")]
pub kind: Option<FilletTypeParam>,
/// `type: variable`: the radius at the end away from `start`; it or `radius` may be 0, where
/// the round closes to the corner.
#[serde(default)]
pub radius2: Option<LengthExpr>,
/// `type: variable` or `spline`: a point near the end the radius starts from.
#[serde(default)]
pub start: Option<Point3>,
/// `type: variable`: radii between the ends, each `[position, radius]`, the position between 0
/// and 1 from the start end. At most 100 are read.
#[serde(default)]
pub mid: Option<Vec<(f64, LengthExpr)>>,
/// `type: variable`: smooth instead of straight between the radii. Default: false.
#[serde(default)]
pub smooth: Option<bool>,
/// `type: spline`: the control radii after `radius`. At most 100 are read.
#[serde(default)]
pub radii: Option<Vec<LengthExpr>>,
/// `type: spline`: the knot vector from 0 to 1, as many knots as all control radii, the
/// degree (1 to 3) and one more.
#[serde(default)]
pub knots: Option<Vec<f64>>,
#[serde(default)]
pub fit: Option<FilletFitParam>,
#[serde(default)]
pub corner: Option<FilletCornerParam>,
/// Corner setbacks: the corner at the vertex nearest each `vertex`, where every edge meeting it
/// is rounded, starts its patch `distance` along each of those edges from the vertex, past
/// where the rounds would meet. Constant-radius exact fillets only.
#[serde(default)]
pub setbacks: Option<Vec<SetbackParam>>,
#[serde(default)]
pub turn: Option<FilletTurnParam>,
#[serde(flatten, deserialize_with = "feature_common")]
pub common: FeatureCommon,
}
/// A fillet corner set back.
#[derive(Debug, Deserialize, JsonSchema)]
pub struct SetbackParam {
/// A point at the corner's vertex.
pub vertex: Point3,
/// How far along each edge there the corner's patch starts.
pub distance: LengthExpr,
}
/// The radius `fit: reduce` gave one edge.
#[derive(Debug, Serialize, JsonSchema)]
pub struct AppliedRadius {
/// A point on the edge.
pub edge: [f64; 3],
/// The radius it was rounded at.
pub radius: f64,
}
/// What `solid.fillet` returns: a feature command's reply, with the radii `fit: reduce` used.
#[derive(Debug, Serialize, JsonSchema)]
pub struct FilletResult {
#[serde(flatten)]
pub feature: FeatureResult,
/// With `fit: reduce` where it reduced the radius: the smallest radius used.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub radius_applied: Option<f64>,
/// With `fit: reduce` where it reduced the radius: each edge's radius.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub radii_applied: Option<Vec<AppliedRadius>>,
}
/// What a feature command returns.
#[derive(Debug, Serialize, JsonSchema)]
pub struct FeatureResult {
/// The new feature's id.
pub feature: u64,
/// The new feature's name.
pub name: String,
/// Every body after the feature.
pub bodies: Vec<String>,
/// The bodies the feature made.
pub created_bodies: Vec<String>,
/// Bodies that were there before and now have other geometry.
pub changed_bodies: Vec<String>,
/// Bodies that are gone.
pub removed_bodies: Vec<String>,
/// A warning from the evaluation (a Boolean that needed a retry, a reference found again
/// elsewhere), or `null`.
pub warning: Option<String>,
/// A join that split pieces into bodies of their own because they touch the others only along
/// an edge or at a point (its `touching: separate`): what to tell the user, and the edit that
/// makes them one body instead. Left out otherwise, also when the join kept pieces that touch
/// nothing in one body.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub notice: Option<FeatureNotice>,
/// How long the feature took to evaluate, in milliseconds.
pub ms: Option<f64>,
/// In the warn parameter-check mode: what the call's parameters got wrong.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub param_warnings: Vec<String>,
}
#[cfg(test)]
#[path = "features_tests.rs"]
mod tests;