Fixed editor rotation errors, updated entity to use Vec3 rotation

jonjondev · jonjondev · commit e121f011cde2 · 2023-07-29T16:36:06.000+10:00
diff --git a/engine/core/ResourceSystem.cpp b/engine/core/ResourceSystem.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2022-2023 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+// Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
 //
 // This code is released under an unmodified zlib license.
 // For conditions of distribution and use, please see:
diff --git a/engine/core/entity/Entity.cpp b/engine/core/entity/Entity.cpp
@@ -61,6 +61,11 @@ const Xform& Entity::GetTransform() const
     return transform;
 }
 
+Xform& Entity::GetTransform()
+{
+    return transform;
+}
+
 int Entity::GetZIndex() const
 {
     return zIndex;
@@ -71,25 +76,29 @@ const Vec3& Entity::GetPosition() const
     return transform.GetPosition();
 }
 
-float Entity::GetRotation() const
+const Vec3& Entity::GetRotation() const
 {
-    return transform.GetRotation().y;
+    return transform.GetRotation();
 }
 
 const Vec3& Entity::GetScale() const
 {
     return transform.GetScale();
 }
 
+void Entity::SetTransform(const Xform& xform)
+{
+    transform = xform;
+}
+
 void Entity::SetPosition(const Vec3& position)
 {
     transform.SetPosition(position);
 }
 
-void Entity::SetRotation(float rotation)
+void Entity::SetRotation(const Vec3& rotation)
 {
-    transform.SetRotation(
-        {transform.GetRotation().x, fmod(rotation, 360.f), transform.GetRotation().z});
+    transform.SetRotation(rotation);
 }
 
 void Entity::SetScale(const Vec3& scale)
diff --git a/engine/core/entity/Entity.h b/engine/core/entity/Entity.h
@@ -142,9 +142,9 @@ class Entity
 
     /**
      * Getter method for the entity's rotation attribute
-     * @return the entity's rotation as a float
+     * @return the entity's rotation as a Vec3
      */
-    float GetRotation() const;
+    const Vec3& GetRotation() const;
 
     /**
      * Getter method for the entity's scale attribute
@@ -159,6 +159,13 @@ class Entity
      */
     const Xform& GetTransform() const;
 
+    /**
+     * Getter method for the entity's transform
+     * @return a reference to the entity's
+     *         transform values
+     */
+    Xform& GetTransform();
+
     /**
      * Getter method for the entity's z-index attribute
      * @return the entity's z-index as an int
@@ -176,26 +183,32 @@ class Entity
      */
     void SetIndex(GenerationalIndex idx);
 
+    /**
+     * Setter method for the entity's transform
+     * @param xform - a transform to set to the entity
+     */
+    void SetTransform(const Xform& xform);
+
     /**
      * Setter method for the entity's position attribute
-     * @param position - a Vector3 to set as the entity's
+     * @param position - a Vec3 to set as the entity's
      *                   position
      */
     void SetPosition(const Vec3& position);
 
     /**
      * Setter method for the entity's rotation attribute
-     * @param rotation - a float to set as the entity's
+     * @param rotation - a Vec3 to set as the entity's
      *                   rotation
      * @note While negative rotations are accepted,
      *       rotations beyond 360 degrees are
      *       automatically wrapped
      */
-    void SetRotation(float rotation);
+    void SetRotation(const Vec3& rotation);
 
     /**
      * Setter method for the entity's scale attribute
-     * @param scale - a Vector3 to set as the entity's
+     * @param scale - a Vec3 to set as the entity's
      *                scale
      */
     void SetScale(const Vec3& scale);
diff --git a/engine/core/scene/SceneFile.cpp b/engine/core/scene/SceneFile.cpp
@@ -44,7 +44,7 @@ String SceneFile::SerialiseToString(const std::vector<Entity*>& entities)
         // Serialise the general entity information
         fileData += (entity->GetName() + SEP);
         fileData += DefineField("POSITION", ToString(entity->GetPosition()));
-        fileData += DefineField("ROTATION", String::FromFloat(entity->GetRotation()));
+        fileData += DefineField("ROTATION", String::FromFloat(entity->GetRotation().y));
         fileData += DefineField("Z-INDEX", String::FromInt(entity->GetZIndex()));
 
         // Apply its serialiser if it
diff --git a/engine/utils/math/Xform.h b/engine/utils/math/Xform.h
@@ -36,7 +36,7 @@ struct Xform
         return position;
     }
 
-    Vec3 GetRotation() const
+    const Vec3& GetRotation() const
     {
         return rotation;
     }
@@ -74,21 +74,27 @@ struct Xform
     void SetRotation(const Vec3& newRotation)
     {
         rotation = newRotation;
+        rotation.x = fmod(rotation.x, 360.f);
+        rotation.y = fmod(rotation.y, 360.f);
+        rotation.z = fmod(rotation.z, 360.f);
     }
 
     void SetRotationX(const float& newRotation)
     {
         rotation.x = newRotation;
+        rotation.x = fmod(rotation.x, 360.f);
     }
 
     void SetRotationY(const float& newRotation)
     {
         rotation.y = newRotation;
+        rotation.y = fmod(rotation.y, 360.f);
     }
 
     void SetRotationZ(const float& newRotation)
     {
         rotation.z = newRotation;
+        rotation.z = fmod(rotation.z, 360.f);
     }
 
     void SetScale(const Vec3& newScale)
diff --git a/examples/game/src/tools/EditorController.cpp b/examples/game/src/tools/EditorController.cpp
@@ -157,7 +157,8 @@ void EditorController::OnUpdate()
                 float rotation =
                     precision * (float) (Siege::Input::IsKeyDown(Siege::Key::KEY_LEFT) +
                                          -Siege::Input::IsKeyDown(Siege::Key::KEY_RIGHT));
-                selectedEntity->SetRotation(selectedEntity->GetRotation() + rotation);
+                Siege::Xform& xform = selectedEntity->GetTransform();
+                xform.SetRotationY(selectedEntity->GetRotation().y + rotation);
                 break;
             }
         }
@@ -181,7 +182,7 @@ void EditorController::OnDraw2D()
                                             selectedEntity->GetPosition().y,
                                             selectedEntity->GetPosition().z);
     Siege::String rotLabel =
-        Siege::String("Rotation: %.2f").Formatted(selectedEntity->GetRotation());
+        Siege::String("Rotation: %.2f").Formatted(selectedEntity->GetRotation().y);
 
     // Draw display text just above the entity in world-space
     auto& pixel = ServiceLocator::GetRenderResources()->GetFont();
@@ -292,7 +293,9 @@ bool EditorController::TrySetPos(Siege::Vec3 position)
 bool EditorController::TrySetRot(float rotation)
 {
     if (!selectedEntity) return false;
-    selectedEntity->SetRotation(rotation);
+    Siege::Xform xform = selectedEntity->GetTransform();
+    xform.SetRotationY(rotation);
+    selectedEntity->SetTransform(xform);
     return true;
 }
 
diff --git a/tests/core/test_SceneFile.cpp b/tests/core/test_SceneFile.cpp
@@ -111,7 +111,7 @@ UTEST_F(test_SceneFile, SerialiseSingleEntity)
 
     // Modifying its fields should result in the same transforms being applied
     e1.SetPosition({1, 2, 3});
-    e1.SetRotation(25.f);
+    e1.SetRotation({0.f, 25.f, 0.f});
     e1.SetZIndex(-3);
     sceneData = SceneFile::SerialiseToString({&e1});
     ASSERT_STREQ("TestEntity1|"
@@ -244,7 +244,7 @@ UTEST_F(test_SceneFile, DeserialiseSingleEntity)
     ASSERT_EQ(1.f, pos.x);
     ASSERT_EQ(2.f, pos.y);
     ASSERT_EQ(3.f, pos.z);
-    ASSERT_EQ(25.f, entities[0]->GetRotation());
+    ASSERT_EQ(25.f, entities[0]->GetRotation().y);
     ASSERT_EQ(-3, entities[0]->GetZIndex());
 
     // It should retain its custom data

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,11 @@ const Xform& Entity::GetTransform() const`
`61`	`61`	`return transform;`
`62`	`62`	`}`
`63`	`63`
	`64`	`+Xform& Entity::GetTransform()`
	`65`	`+{`
	`66`	`+ return transform;`
	`67`	`+}`
	`68`	`+`
`64`	`69`	`int Entity::GetZIndex() const`
`65`	`70`	`{`
`66`	`71`	`return zIndex;`
`@@ -71,25 +76,29 @@ const Vec3& Entity::GetPosition() const`
`71`	`76`	`return transform.GetPosition();`
`72`	`77`	`}`
`73`	`78`
`74`		`-float Entity::GetRotation() const`
	`79`	`+const Vec3& Entity::GetRotation() const`
`75`	`80`	`{`
`76`		`- return transform.GetRotation().y;`
	`81`	`+ return transform.GetRotation();`
`77`	`82`	`}`
`78`	`83`
`79`	`84`	`const Vec3& Entity::GetScale() const`
`80`	`85`	`{`
`81`	`86`	`return transform.GetScale();`
`82`	`87`	`}`
`83`	`88`
	`89`	`+void Entity::SetTransform(const Xform& xform)`
	`90`	`+{`
	`91`	`+ transform = xform;`
	`92`	`+}`
	`93`	`+`
`84`	`94`	`void Entity::SetPosition(const Vec3& position)`
`85`	`95`	`{`
`86`	`96`	`transform.SetPosition(position);`
`87`	`97`	`}`
`88`	`98`
`89`		`-void Entity::SetRotation(float rotation)`
	`99`	`+void Entity::SetRotation(const Vec3& rotation)`
`90`	`100`	`{`
`91`		`- transform.SetRotation(`
`92`		`- {transform.GetRotation().x, fmod(rotation, 360.f), transform.GetRotation().z});`
	`101`	`+ transform.SetRotation(rotation);`
`93`	`102`	`}`
`94`	`103`
`95`	`104`	`void Entity::SetScale(const Vec3& scale)`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ struct Xform`
`36`	`36`	`return position;`
`37`	`37`	`}`
`38`	`38`
`39`		`- Vec3 GetRotation() const`
	`39`	`+ const Vec3& GetRotation() const`
`40`	`40`	`{`
`41`	`41`	`return rotation;`
`42`	`42`	`}`
`@@ -74,21 +74,27 @@ struct Xform`
`74`	`74`	`void SetRotation(const Vec3& newRotation)`
`75`	`75`	`{`
`76`	`76`	`rotation = newRotation;`
	`77`	`+ rotation.x = fmod(rotation.x, 360.f);`
	`78`	`+ rotation.y = fmod(rotation.y, 360.f);`
	`79`	`+ rotation.z = fmod(rotation.z, 360.f);`
`77`	`80`	`}`
`78`	`81`
`79`	`82`	`void SetRotationX(const float& newRotation)`
`80`	`83`	`{`
`81`	`84`	`rotation.x = newRotation;`
	`85`	`+ rotation.x = fmod(rotation.x, 360.f);`
`82`	`86`	`}`
`83`	`87`
`84`	`88`	`void SetRotationY(const float& newRotation)`
`85`	`89`	`{`
`86`	`90`	`rotation.y = newRotation;`
	`91`	`+ rotation.y = fmod(rotation.y, 360.f);`
`87`	`92`	`}`
`88`	`93`
`89`	`94`	`void SetRotationZ(const float& newRotation)`
`90`	`95`	`{`
`91`	`96`	`rotation.z = newRotation;`
	`97`	`+ rotation.z = fmod(rotation.z, 360.f);`
`92`	`98`	`}`
`93`	`99`
`94`	`100`	`void SetScale(const Vec3& newScale)`