add missing doc

2025-01-17 14:18:13 +01:00 · 2019-06-17 10:02:25 +08:00 · 2019-06-17 10:02:25 +08:00 · 340847cd19
commit 340847cd19
parent ab99a24352
1 changed files with 23 additions and 0 deletions
--- a/docs/lib-m_mirror.md
+++ b/docs/lib-m_mirror.md
@ -0,0 +1,23 @@
+# m_mirror
+
+Generate a 4x4 transformation matrix which can pass into `multmatrix` to mirror the child element on a plane through the origin. 
+
+**Since:** 1.1
+
+## Parameters
+
+- `v` : The normal vector of a plane intersecting the origin through which to mirror the object.
+
+## Examples
+
+	include <m_mirror.scad>;
+
+	rotate([0, 0, 10]) 
+		cube([3, 2, 1]);
+		
+	multmatrix(m_mirror([1, 1, 0]))
+		rotate([0, 0, 10]) 
+			cube([3, 2, 1]);
+
+![m_mirror](images/lib-m_mirror-1.JPG)
+