add m_mirror doc

2025-01-17 14:18:13 +01:00 · 2019-05-02 09:47:04 +08:00 · 2019-05-02 09:47:04 +08:00 · f6c03d239f
commit f6c03d239f
parent 3e285fc1e8
2 changed files with 21 additions and 0 deletions
--- a/docs/images/lib-m_mirror-1.JPG
+++ b/docs/images/lib-m_mirror-1.JPG
--- a/docs/lib-m_mirror.md
+++ b/docs/lib-m_mirror.md
@ -0,0 +1,21 @@
+# m_mirror
+
+Generate a 4x4 transformation matrix which can pass into `multmatrix` to mirror the child element on a plane through the origin. 
+
+## 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)
+