aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/QuickStartGuide.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-08-31 13:32:29 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-08-31 13:32:29 +0000
commit7e8aa63bb7083c1f465be0b42460f49559ee6b7a (patch)
treeed1c2db0373330f1d05b9e2f554dedbfc0cd307e /doc/QuickStartGuide.dox
parent5c34d8e20a4263bb387e19da4209137bfe519a54 (diff)
* Add Hyperplane::transform(Matrix/Transform)
* Fix compilations with gcc 3.4, ICC and doxygen * Fix krazy directives (hopefully)
Diffstat (limited to 'doc/QuickStartGuide.dox')
-rw-r--r--doc/QuickStartGuide.dox40
1 files changed, 24 insertions, 16 deletions
diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox
index cf37f02be..b7cbf3046 100644
--- a/doc/QuickStartGuide.dox
+++ b/doc/QuickStartGuide.dox
@@ -637,42 +637,50 @@ mat2x2 = t.linear();
Eigen's geometry module offer two different ways to build and update transformation objects.
<table class="tutorial_code">
<tr><td></td><td>\b procedurale \b API </td><td>\b natural \b API </td></tr>
-<tr><td>Applies a translation</td><td>\code
-t.translate(Vector3(tx, ty, ...));
-t.pretranslate(Vector3(tx, ty, ...));
+<tr><td>Translation</td><td>\code
+t.translate(Vector_(tx, ty, ...));
+
+t.pretranslate(Vector_(tx, ty, ...));
\endcode</td><td>\code
-t *= Translation(tx, ty, ...);
-t = Translation(tx, ty, ...) * t;
+t *= Translation_(tx, ty, ...);
+t2 = t1 * Translation_(vec);
+t = Translation_(tx, ty, ...) * t;
\endcode</td></tr>
-<tr><td>Applies a rotation \n <span class="note">In 2D, any_rotation can also be \n an angle in radian</span></td><td>\code
+<tr><td>Rotation \n <span class="note">In 2D, any_rotation can also \n be an angle in radian</span></td><td>\code
t.rotate(any_rotation);
+
t.prerotate(any_rotation);
\endcode</td><td>\code
t *= any_rotation;
+t2 = t1 * any_rotation;
t = any_rotation * t;
\endcode</td></tr>
-<tr><td>Applies a scaling</td><td>\code
-t.scale(Vector(sx, sy, ...));
-t.scale(Vector::Constant(s));
-t.prescale(Vector3f(sx, sy, ...));
+<tr><td>Scaling</td><td>\code
+t.scale(Vector_(sx, sy, ...));
+
+t.scale(s);
+t.prescale(Vector_(sx, sy, ...));
+t.prescale(s);
\endcode</td><td>\code
-t *= Scaling(sx, sy, ...);
-t *= Scaling(s);
-t = Scaling(sx, sy, ...) * t;
+t *= Scaling_(sx, sy, ...);
+t2 = t1 * Scaling_(vec);
+t *= Scaling_(s);
+t = Scaling_(sx, sy, ...) * t;
+t = Scaling_(s) * t;
\endcode</td></tr>
-<tr><td>Applies a shear transformation \n ( \b 2D \b only ! )</td><td>\code
+<tr><td>Shear transformation \n ( \b 2D \b only ! )</td><td>\code
t.shear(sx,sy);
t.preshear(sx,sy);
\endcode</td><td></td></tr>
</table>
-Note that in both API, any many transformations can be concatenated in a single lines as shown in the two following equivalent examples:
+Note that in both API, any many transformations can be concatenated in a single expression as shown in the two following equivalent examples:
<table class="tutorial_code">
<tr><td>\code
t.pretranslate(..).rotate(..).translate(..).scale(..);
\endcode</td></tr>
<tr><td>\code
-t = Translation(..) * t * RotationType(..) * Translation(..) * Scaling(..);
+t = Translation_(..) * t * RotationType(..) * Translation_(..) * Scaling_(..);
\endcode</td></tr>
</table>