Merge pull request #804 from timoore/mat4-docs

Improve documentation of plane-matrix multiplication
vsg-dev · May 8, 2023 · f02eba6 · f02eba6
2 parents 22f9087 + bd2586d
commit f02eba6
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/include/vsg/maths/mat4.h b/include/vsg/maths/mat4.h
@@ -198,8 +198,9 @@ namespace vsg
                          lhs[0] * rhs[3][0] + lhs[1] * rhs[3][1] + lhs[2] * rhs[3][2] + lhs[3] * rhs[3][3]);
     }
 
-    /* Left multiplication of a plane and a matrix. This can be used directly to transform a plane
-       from a coordinate system's local coordinates to world coordinates. */
+    /* Left multiplication of a plane and a matrix. If the matrix is the inverse of the
+       local-to-world transform i.e., the world-to-local transform, then this can be used directly
+       to transform a plane from a coordinate system's local coordinates to world coordinates. */
     template<typename T, typename R>
     t_plane<T> operator*(const t_plane<T>& lhs, const t_mat4<R>& rhs)
     {