use enum to define axis in mirror_matrix

follow naming guidelines for parameters
cg-tuwien · May 10, 2021 · 321d016 · johannesugb · May 11, 2021 · johannesugb
1 parent 54cd2c9
commit 321d016
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/framework/include/math_utils.hpp b/framework/include/math_utils.hpp
@@ -12,9 +12,11 @@ namespace gvk
 	/// extract the translation part out of a matrix
 	extern glm::vec3 get_translation_from_matrix(const glm::mat4& m);
 
-	glm::mat4 cancel_translation_from_matrix(const glm::mat4& m);
+	glm::mat4 cancel_translation_from_matrix(const glm::mat4& aMatrix);
 
-	glm::mat4 mirror_matrix(const glm::mat4& m, const glm::length_t axis = 0);
+	enum principal_axis : uint32_t { x = 0u, y, z };
+
+	glm::mat4 mirror_matrix(const glm::mat4& aMatrix, const glm::length_t aAxis = principal_axis::x);
 
 	/// <summary>
 	/// Solve a system of equations with 3 unknowns.

diff --git a/framework/src/math_utils.cpp b/framework/src/math_utils.cpp
@@ -25,16 +25,16 @@ namespace gvk
 		return glm::vec3(m[3][0], m[3][1], m[3][2]);
 	}
 
-	glm::mat4 cancel_translation_from_matrix(const glm::mat4& m)
+	glm::mat4 cancel_translation_from_matrix(const glm::mat4& aMatrix)
 	{
-		return glm::mat4(m[0], m[1], m[2], glm::vec4(0.0f, 0.0f, 0.0f, 1.0f));
+		return glm::mat4(aMatrix[0], aMatrix[1], aMatrix[2], glm::vec4(0.0f, 0.0f, 0.0f, 1.0f));
 	}
 
-	glm::mat4 mirror_matrix(const glm::mat4& m, const glm::length_t axis)
+	glm::mat4 mirror_matrix(const glm::mat4& aMatrix, const glm::length_t aAxis)
 	{
-		assert(0 <= axis && axis <= 2);
+		auto axis = static_cast<std::underlying_type<principal_axis>::type>(aAxis);
 
-		auto result(m);
+		auto result(aMatrix);
 		result[axis] *= -1.0f;
 		return result;
 	}