aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/QuickStartGuide.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-08-29 16:17:06 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-08-29 16:17:06 +0000
commit063d1bb811f5e51fa47e89b43ee230499f5a8fe3 (patch)
treef44250ae8746245815d120eac121dfdb60bb9df9 /doc/QuickStartGuide.dox
parent68fbd6f53184b20798d2351b2f6fdccdfd6107aa (diff)
tweak root/Mainpage.dox to make it compatible with kde's doxygen.sh script
plus some hacks to compile the examples from doxygen... Hopefully, api.kde.org/eigen2 will be beautiful by tomorrow....
Diffstat (limited to 'doc/QuickStartGuide.dox')
-rw-r--r--doc/QuickStartGuide.dox14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox
index d8a58b208..74ff8780e 100644
--- a/doc/QuickStartGuide.dox
+++ b/doc/QuickStartGuide.dox
@@ -590,8 +590,14 @@ Vector3f v1, v2;
v2 = t.linear() * v1;\endcode</td><td>\code
Vector2f v1, v2;
v2 = t.linear() * v1;\endcode</td></tr>
-<tr><td>Concatenate two transformations</td><td>\code
-t3 = t1 * t2;\endcode</td><td>\code
+<tr><td>Apply a \em general transformation \n to a \b normal \b vector
+(<a href="http://www.cgafaq.info/wiki/Transforming_normals">explanations</a>)</td><td colspan="2">\code
+Matrix{3,2}f normalMatrix = t.linear().inverse().transpose();
+n2 = (normalMatrix * n1).normalize();\endcode</td></tr>
+<tr><td>Apply a transformation with \em pure \em rotation \n to a \b normal \b vector
+(no scaling, no shear)</td><td colspan="2">\code
+n2 = t.linear() * n1;\endcode</td></tr>
+<tr><td>Concatenate two transformations</td><td colspan="2">\code
t3 = t1 * t2;\endcode</td></tr>
<tr><td>OpenGL compatibility</td><td>\code
glLoadMatrixf(t.data());\endcode</td><td>\code
@@ -634,9 +640,9 @@ t.scale(Vector3f(sx, sy, sz));
t.scale(Vector3f::Constant(s));
t.prescale(Vector3f(sx, sy, sz));
\endcode</td><td>\code
-t.scale(Vector2f(tx, ty));
+t.scale(Vector2f(sx, sy));
t.scale(Vector2f::Constant(s));
-t.prescale(Vector2f(tx, ty));
+t.prescale(Vector2f(sx, sy));
\endcode</td></tr>
<tr><td>Applies a shear transformation \n(2D only)</td><td></td><td>\code
t.shear(sx,sy);