Non-destructive, partial extrudes/revolves/sweeps etc

This proposes a new way to surface extrude/revolve/sweep for sketch 2.

Instead of extruding an entire sketch (solid2D) at once, we instead
take a list of segments and extrude each of those separately.

Each segment has a (segment ID, new body ID) pair, so the segment IDs
are NOT absorbed into new body IDs. The sketch and all its segments are
not modified.

Author: adamchalmers

modeling-cmds/openapi/api.json

@@ -2288,6 +2288,11 @@
                   }
                 ]
               },
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two separate surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+              },
               "merge_coplanar_faces": {
                 "nullable": true,
                 "description": "Only used if the extrusion is created from a face and extrude_method = Merge If true, coplanar faces will be merged and seams will be hidden. Otherwise, seams between the extrusion and original body will be shown.",
@@ -2302,8 +2307,17 @@
                   }
                 ]
               },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
-                "description": "Which sketch to extrude. Must be a closed 2D solid.",
+                "description": "Which sketch to extrude. Must be a 2D sketch.",
                 "allOf": [
                   {
                     "$ref": "#/components/schemas/ModelingCmdId"
@@ -2355,6 +2369,11 @@
                   }
                 ]
               },
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+              },
               "reference": {
                 "description": "Reference to extrude to. Extrusion occurs along the target's normal until it is as close to the reference as possible.",
                 "allOf": [
@@ -2363,6 +2382,15 @@
                   }
                 ]
               },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
                 "description": "Which sketch to extrude. Must be a closed 2D solid.",
                 "allOf": [
@@ -2439,6 +2467,20 @@
                   }
                 ]
               },
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+              },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
                 "description": "Which sketch to extrude. Must be a closed 2D solid.",
                 "allOf": [
@@ -2491,6 +2533,11 @@
                   }
                 ]
               },
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+              },
               "relative_to": {
                 "description": "What is this sweep relative to?",
                 "default": "sketch_plane",
@@ -2504,6 +2551,15 @@
                 "description": "If true, the sweep will be broken up into sub-sweeps (extrusions, revolves, sweeps) based on the trajectory path components.",
                 "type": "boolean"
               },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
                 "description": "Which sketch to sweep. Must be a closed 2D solid.",
                 "allOf": [
@@ -2583,6 +2639,11 @@
                   }
                 ]
               },
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+              },
               "opposite": {
                 "description": "Should the revolution also revolve in the opposite direction along the given axis? If so, this specifies its angle.",
                 "default": "None",
@@ -2600,6 +2661,15 @@
                   }
                 ]
               },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
                 "description": "Which sketch to revolve. Must be a closed 2D solid.",
                 "allOf": [
@@ -2869,6 +2939,7 @@
                 "type": "string",
                 "format": "uuid"
               },
+<<<<<<< HEAD
               "edge_reference": {
                 "nullable": true,
                 "description": "Edge reference to use as the axis of revolution (new API). If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence.",
@@ -2877,6 +2948,13 @@
                     "$ref": "#/components/schemas/EdgeSpecifier"
                   }
                 ]
+||||||| parent of 3cb4bff (Configurable seams)
+=======
+              "keep_seams": {
+                "description": "When two collinear segments are extruded, what should happen? If true, creates a body with two surfaces. If false, creates a body with one surface, spanning both collinear segments.",
+                "default": false,
+                "type": "boolean"
+>>>>>>> 3cb4bff (Configurable seams)
               },
               "opposite": {
                 "description": "Should the revolution also revolve in the opposite direction along the given axis? If so, this specifies its angle.",
@@ -2887,6 +2965,15 @@
                   }
                 ]
               },
+              "segments": {
+                "nullable": true,
+                "description": "If given, extrude each of these segments into a separate body with the given ID.",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
               "target": {
                 "description": "Which sketch to revolve. Must be a closed 2D solid.",
                 "allOf": [

modeling-cmds/src/def_enum.rs

@@ -128,8 +128,17 @@ define_modeling_cmd_enum! {
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct Extrude {
             /// Which sketch to extrude.
-            /// Must be a closed 2D solid.
+            /// Must be a 2D sketch.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two separate surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// How far off the plane to extrude
             pub distance: LengthUnit,
             /// Which IDs should the new faces have?
@@ -169,6 +178,15 @@ define_modeling_cmd_enum! {
             /// Which sketch to extrude.
             /// Must be a closed 2D solid.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// Reference to extrude to.
             /// Extrusion occurs along the target's normal until it is as close to the reference as possible.
             pub reference: ExtrudeReference,
@@ -202,6 +220,15 @@ define_modeling_cmd_enum! {
             /// Which sketch to extrude.
             /// Must be a closed 2D solid.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// How far off the plane to extrude
             pub distance: LengthUnit,
             /// Which IDs should the new faces have?
@@ -239,6 +266,15 @@ define_modeling_cmd_enum! {
             /// Which sketch to sweep.
             /// Must be a closed 2D solid.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// Path along which to sweep.
             pub trajectory: ModelingCmdId,
             /// If true, the sweep will be broken up into sub-sweeps (extrusions, revolves, sweeps) based on the trajectory path components.
@@ -271,6 +307,15 @@ define_modeling_cmd_enum! {
             /// Which sketch to revolve.
             /// Must be a closed 2D solid.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// The origin of the extrusion axis
             pub origin: Point3d<LengthUnit>,
             /// The axis of the extrusion (taken from the origin)
@@ -422,6 +467,15 @@ define_modeling_cmd_enum! {
             /// Which sketch to revolve.
             /// Must be a closed 2D solid.
             pub target: ModelingCmdId,
+            /// If given, extrude each of these segments into a separate body with the given ID.
+            #[serde(default, skip_serializing_if = "Option::is_none")]
+            pub segments: Option<Vec<Uuid>>,
+            /// When two collinear segments are extruded, what should happen?
+            /// If true, creates a body with two surfaces.
+            /// If false, creates a body with one surface, spanning both collinear segments.
+            #[serde(default)]
+            #[builder(default)]
+            pub keep_seams: bool,
             /// The edge to use as the axis of revolution, must be linear and lie in the plane of the solid
             #[serde(default, skip_serializing_if = "Option::is_none")]
             pub edge_id: Option<Uuid>,

modeling-cmds/src/ok_response.rs

@@ -24,7 +24,7 @@ define_ok_modeling_cmd_response_enum! {
             base64::Base64Data,
             id::ModelingCmdId,
             length_unit::LengthUnit,
-            shared::{CurveType, EntityType, ExportFile, ExtrusionFaceCapType, PathCommand, Point2d, Point3d},
+            shared::{CurveType, EntityType, ExportFile, ExtrusionFaceCapType, PathCommand, Point2d, Point3d, BodiesCreated},
             units,
         };
 
@@ -58,30 +58,40 @@ define_ok_modeling_cmd_response_enum! {
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct Extrude {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `ExtrudeToReference` endpoint.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct ExtrudeToReference {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `TwistExtrude` endpoint.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct TwistExtrude {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `Sweep` endpoint.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct Sweep {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `Revolve` endpoint.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct Revolve {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `Solid3dShellFace` endpoint.
@@ -135,6 +145,8 @@ define_ok_modeling_cmd_response_enum! {
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
         pub struct RevolveAboutEdge {
+            /// Any new bodies created by the request.
+            pub bodies: BodiesCreated,
         }
 
         /// The response from the `CameraDragStart` endpoint.

modeling-cmds/src/shared.rs

@@ -1910,6 +1910,45 @@ pub struct SurfaceEdgeReference {
     pub edges: Vec<FractionOfEdge>,
 }
 
+/// List of bodies that were created by an operation.
+#[derive(Builder, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+pub struct BodiesCreated {
+    /// All bodies created by this operation.
+    pub bodies: Vec<BodyCreated>,
+}
+
+/// Details of a body that was created.
+#[derive(Builder, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+pub struct BodyCreated {
+    /// The body's ID.
+    pub id: Uuid,
+    /// Surfaces this body contains.
+    pub surfaces: Vec<SurfaceCreated>,
+}
+
+/// Details of a surface that was created under some body.
+#[derive(Builder, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+#[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+pub struct SurfaceCreated {
+    /// The surface's ID.
+    pub id: Uuid,
+    /// Which number face of the parent body is this?
+    pub primitive_face_index: u32,
+    /// Which segment IDs was this surface swept from?
+    pub from_segments: Vec<Uuid>,
+}
+
 fn one() -> f32 {
     1.0
 }