Added commands for object transforming (translate, rotate and scale) (#441)

benjamaan476 · adamchalmers · web-flow · commit d316d5d0811d · 2025-01-08T16:25:13.000Z
* Added commands for object transforming (translate, rotate and scale)

* Change transform commands into one command containing arguments for each transform type

* forgot pub on fields

* Move TransformBy into shared

* update modeling api

* Specify if the transform is to be applied locally or globally

* fix lint issue

* Rename struct to remove generic

* Update modeling-cmds/src/def_enum.rs

Co-authored-by: Adam Chalmers &lt;adam.chalmers@zoo.dev&gt;

---------

Co-authored-by: Adam Chalmers &lt;adam.chalmers@zoo.dev&gt;
diff --git a/modeling-cmds/src/def_enum.rs b/modeling-cmds/src/def_enum.rs
@@ -22,6 +22,7 @@ define_modeling_cmd_enum! {
             length_unit::LengthUnit,
             shared::{
                 Angle,
+                ComponentTransform,
                 CutType,
                 CameraMovement,
                 ExtrudedFaceInfo,
@@ -1418,6 +1419,19 @@ define_modeling_cmd_enum! {
         #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
         pub struct GetNumObjects {}
 
+        ///Set the transform of an object.
+        #[derive(
+            Clone, Debug, Deserialize, PartialEq, JsonSchema, Serialize, ModelingCmdVariant,
+        )]
+        #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+        #[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+        pub struct SetObjectTransform
+        {
+            /// Id of the object whose transform is to be set.
+            pub object_id: Uuid,
+            /// List of transforms to be applied to the object.
+            pub transforms: Vec<ComponentTransform>,
+        }
         /// Make a new path by offsetting an object by a given distance.
         /// The new path's ID will be the ID of this command.
         #[derive(Clone, Debug, PartialEq, Deserialize, JsonSchema, Serialize, ModelingCmdVariant)]
diff --git a/modeling-cmds/src/format/fbx.rs b/modeling-cmds/src/format/fbx.rs
@@ -8,20 +8,7 @@ use serde::{Deserialize, Serialize};
 pub mod import {
     use super::*;
     /// Options for importing FBX.
-    #[derive(
-        Clone,
-        Debug,
-        Default,
-        Eq,
-        Hash,
-        PartialEq,
-        Serialize,
-        Deserialize,
-        JsonSchema,
-        Display,
-        FromStr,
-       
-    )]
+    #[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("")]
     #[serde(rename = "FbxImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
@@ -68,19 +55,7 @@ pub mod export {
 
     /// Describes the storage format of an FBX file.
     #[derive(
-        Default,
-        Clone,
-        Copy,
-        Debug,
-        Eq,
-        Hash,
-        PartialEq,
-        Serialize,
-        Deserialize,
-        JsonSchema,
-        Display,
-        FromStr,
-       
+        Default, Clone, Copy, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr,
     )]
     #[display(style = "snake_case")]
     #[serde(rename = "FbxStorage", rename_all = "snake_case")]
diff --git a/modeling-cmds/src/format/gltf.rs b/modeling-cmds/src/format/gltf.rs
@@ -1,4 +1,3 @@
-
 use parse_display::{Display, FromStr};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -8,20 +7,7 @@ pub mod import {
     use super::*;
 
     /// Options for importing glTF 2.0.
-    #[derive(
-        Clone,
-        Debug,
-        Default,
-        Eq,
-        Hash,
-        PartialEq,
-        Serialize,
-        Deserialize,
-        JsonSchema,
-        Display,
-        FromStr,
-       
-    )]
+    #[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("")]
     #[serde(rename = "GltfImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/format/obj.rs b/modeling-cmds/src/format/obj.rs
@@ -1,4 +1,3 @@
-
 use parse_display::{Display, FromStr};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -10,9 +9,7 @@ pub mod import {
     use super::*;
 
     /// Options for importing OBJ.
-    #[derive(
-        Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr,
-    )]
+    #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("coords: {coords}, units: {units}")]
     #[serde(rename = "ObjImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/format/ply.rs b/modeling-cmds/src/format/ply.rs
@@ -1,4 +1,3 @@
-
 use parse_display::{Display, FromStr};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -10,9 +9,7 @@ pub mod import {
     use super::*;
 
     /// Options for importing PLY.
-    #[derive(
-        Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr,
-    )]
+    #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("coords: {coords}, units: {units}")]
     #[serde(rename = "PlyImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/format/sldprt.rs b/modeling-cmds/src/format/sldprt.rs
@@ -1,25 +1,12 @@
 /// Import functionality.
 pub mod import {
-    
+
     use parse_display::{Display, FromStr};
     use schemars::JsonSchema;
     use serde::{Deserialize, Serialize};
 
     /// Options for importing SolidWorks parts.
-    #[derive(
-        Clone,
-        Debug,
-        Default,
-        Eq,
-        Hash,
-        PartialEq,
-        Serialize,
-        Deserialize,
-        JsonSchema,
-        Display,
-        FromStr,
-       
-    )]
+    #[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("split_closed_faces: {split_closed_faces}")]
     #[serde(default, rename = "SldprtImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/format/step.rs b/modeling-cmds/src/format/step.rs
@@ -1,4 +1,3 @@
-
 use parse_display::{Display, FromStr};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -10,19 +9,7 @@ pub mod import {
     use super::*;
 
     /// Options for importing STEP format.
-    #[derive(
-        Clone,
-        Debug,
-        Default,
-        Eq,
-        Hash,
-        PartialEq,
-        Serialize,
-        Deserialize,
-        JsonSchema,
-        Display,
-        FromStr,
-    )]
+    #[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("split_closed_faces: {split_closed_faces}")]
     #[serde(default, rename = "StepImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/format/stl.rs b/modeling-cmds/src/format/stl.rs
@@ -1,4 +1,3 @@
-
 use parse_display::{Display, FromStr};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -10,9 +9,7 @@ pub mod import {
     use super::*;
 
     /// Options for importing STL.
-    #[derive(
-        Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr,
-    )]
+    #[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, JsonSchema, Display, FromStr)]
     #[display("coords: {coords}, units: {units}")]
     #[serde(rename = "StlImportOptions")]
     #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
diff --git a/modeling-cmds/src/ok_response.rs b/modeling-cmds/src/ok_response.rs
@@ -420,6 +420,10 @@ define_ok_modeling_cmd_response_enum! {
             pub entity_ids: Vec<Uuid>,
         }
 
+        /// The response from the `SetObjectTransform` command.
+        #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
+        pub struct SetObjectTransform {}
+
         /// The response from the `AddHoleFromOffset` command.
         #[derive(Debug, Serialize, Deserialize, Clone, JsonSchema, ModelingCmdOutput)]
         pub struct AddHoleFromOffset {
diff --git a/modeling-cmds/src/shared.rs b/modeling-cmds/src/shared.rs
@@ -964,3 +964,57 @@ mod tests {
         assert!(c >= a);
     }
 }
+
+/// How a property of an object should be transformed.
+#[derive(Clone, Debug, PartialEq, Deserialize, JsonSchema, Serialize)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+pub struct TransformByPoint3d {
+    /// The scale, or rotation, or translation.
+    pub property: Point3d,
+    /// If true, overwrite the previous value with this.
+    /// If false, the previous value will be modified.
+    /// E.g. when translating, `set=true` will set a new location,
+    /// and `set=false` will translate the current location by the given X/Y/Z.
+    pub set: bool,
+    /// If true, the transform is applied in local space.
+    /// If false, the transform is applied in global space.
+    pub is_local: bool,
+}
+
+/// How a property of an object should be transformed.
+/// This is a 4D version of the `TransformByPoint3d` (Used when wanting to specify a rotation with
+/// an angle and axis instead of roll pitch yaw).
+#[derive(Clone, Debug, PartialEq, Deserialize, JsonSchema, Serialize)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+pub struct TransformByPoint4d {
+    /// The scale, or rotation, or translation.
+    pub property: Point4d,
+    /// If true, overwrite the previous value with this.
+    /// If false, the previous value will be modified.
+    /// E.g. when translating, `set=true` will set a new location,
+    /// and `set=false` will translate the current location by the given X/Y/Z.
+    pub set: bool,
+    /// If true, the transform is applied in local space.
+    /// If false, the transform is applied in global space.
+    pub is_local: bool,
+}
+
+/// Container that holds a translate, rotate and scale.
+#[derive(Clone, Debug, PartialEq, Deserialize, JsonSchema, Serialize)]
+#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts-rs", ts(export_to = "ModelingCmd.ts"))]
+pub struct ComponentTransform {
+    /// Translate component of the transform.
+    pub translate: Option<TransformByPoint3d>,
+    /// Rotate component of the transform.
+    /// The rotation is specified as a roll, pitch, yaw.
+    pub rotate_rpy: Option<TransformByPoint3d>,
+    /// Rotate component of the transform.
+    /// The rotation is specified as an axis and an angle (xyz are the components of the axis, w is
+    /// the angle in degrees).
+    pub rotate_angle_axis: Option<TransformByPoint4d>,
+    /// Scale component of the transform.
+    pub scale: Option<TransformByPoint3d>,
+}
