New APIs for primitive indexing (#1046)

This lets you look up the index of a face or edge, and translate between indices and IDs (UUIDs).

Part of KittyCAD/engine#4089

Author: mlfarrell

modeling-cmds/openapi/api.json

@@ -2296,6 +2296,62 @@
               "type"
             ]
           },
+          {
+            "description": "What is the UUID of this body's n-th edge?",
+            "type": "object",
+            "properties": {
+              "edge_index": {
+                "description": "The primitive index of the edge being queried.",
+                "type": "integer",
+                "format": "uint32",
+                "minimum": 0
+              },
+              "object_id": {
+                "description": "The Solid3D parent who owns the edge",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "solid3d_get_edge_uuid"
+                ]
+              }
+            },
+            "required": [
+              "edge_index",
+              "object_id",
+              "type"
+            ]
+          },
+          {
+            "description": "What is the UUID of this body's n-th face?",
+            "type": "object",
+            "properties": {
+              "face_index": {
+                "description": "The primitive index of the face being queried.",
+                "type": "integer",
+                "format": "uint32",
+                "minimum": 0
+              },
+              "object_id": {
+                "description": "The Solid3D parent who owns the face",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "solid3d_get_face_uuid"
+                ]
+              }
+            },
+            "required": [
+              "face_index",
+              "object_id",
+              "type"
+            ]
+          },
           {
             "description": "Retrieves the body type.",
             "type": "object",
@@ -2931,6 +2987,48 @@
               "type"
             ]
           },
+          {
+            "description": "What is this entity's child index within its parent",
+            "type": "object",
+            "properties": {
+              "entity_id": {
+                "description": "ID of the entity being queried.",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "entity_get_index"
+                ]
+              }
+            },
+            "required": [
+              "entity_id",
+              "type"
+            ]
+          },
+          {
+            "description": "What is this edge or face entity's primitive index within its parent body's edges or faces array respectively",
+            "type": "object",
+            "properties": {
+              "entity_id": {
+                "description": "ID of the entity being queried.",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "entity_get_primitive_index"
+                ]
+              }
+            },
+            "required": [
+              "entity_id",
+              "type"
+            ]
+          },
           {
             "description": "Attempts to delete children entity from an entity. Note that this API may change the body type of certain entities from Solid to Surface.",
             "type": "object",

modeling-cmds/src/def_enum.rs

@@ -303,6 +303,36 @@ define_modeling_cmd_enum! {
             pub object_id: Uuid,
         }
 
+        /// What is the UUID of this body's n-th edge?
+        #[derive(
+            Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder
+        )]
+        #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+        #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+        pub struct Solid3dGetEdgeUuid {
+            /// The Solid3D parent who owns the edge
+            pub object_id: Uuid,
+
+            /// The primitive index of the edge being queried.
+            pub edge_index: u32,
+        }
+
+        /// What is the UUID of this body's n-th face?
+        #[derive(
+            Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder
+        )]
+        #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+        #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+        pub struct Solid3dGetFaceUuid {
+            /// The Solid3D parent who owns the face
+            pub object_id: Uuid,
+
+            /// The primitive index of the face being queried.
+            pub face_index: u32,
+        }
+
         /// Retrieves the body type.
         #[derive(
             Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder
@@ -573,6 +603,26 @@ define_modeling_cmd_enum! {
             pub child_index: u32,
         }
 
+        /// What is this entity's child index within its parent
+        #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder)]
+        #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+        #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+        pub struct EntityGetIndex {
+            /// ID of the entity being queried.
+            pub entity_id: Uuid,
+        }
+
+        /// What is this edge or face entity's primitive index within its parent body's edges or faces array respectively
+        #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder)]
+        #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+        #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        #[cfg_attr(not(feature = "unstable_exhaustive"), non_exhaustive)]
+        pub struct EntityGetPrimitiveIndex {
+            /// ID of the entity being queried.
+            pub entity_id: Uuid,
+        }
+
         /// Attempts to delete children entity from an entity.
         /// Note that this API may change the body type of certain entities from Solid to Surface.
         #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema, ModelingCmdVariant, Builder)]

modeling-cmds/src/ok_response.rs

@@ -82,6 +82,20 @@ define_ok_modeling_cmd_response_enum! {
         pub struct Solid3dJoin {
         }
 
+        /// The response from the `Solid3dGetEdgeUuid` endpoint.
+        #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
+        pub struct Solid3dGetEdgeUuid {
+            /// The UUID of the edge.
+            pub edge_id: Uuid,
+        }
+
+        /// The response from the `Solid3dGetFaceUuid` endpoint.
+        #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
+        pub struct Solid3dGetFaceUuid {
+            /// The UUID of the face.
+            pub face_id: Uuid,
+        }
+
         /// The response from the `Solid3dGetBodyType` endpoint.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         pub struct Solid3dGetBodyType {
@@ -365,6 +379,21 @@ define_ok_modeling_cmd_response_enum! {
             /// The UUID of the child entity.
             pub entity_id: Uuid,
         }
+        /// The response from the `EntityGetIndex` command.
+        #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
+        pub struct EntityGetIndex {
+            /// The child index of the entity.
+            pub entity_index: u32,
+        }
+        /// The response from the `EntityGetPrimitiveIndex` command.
+        #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
+        pub struct EntityGetPrimitiveIndex {
+            /// The primitive index of the entity.
+            pub primitive_index: u32,
+
+            /// The type of this entity.  Helps infer whether this is an edge or a face index.
+            pub entity_type: EntityType,
+        }
         /// The response from the `EntityDeleteChildren` command.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         pub struct EntityDeleteChildren {