From 7e8aa63bb7083c1f465be0b42460f49559ee6b7a Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Sun, 31 Aug 2008 13:32:29 +0000 Subject: * Add Hyperplane::transform(Matrix/Transform) * Fix compilations with gcc 3.4, ICC and doxygen * Fix krazy directives (hopefully) --- doc/QuickStartGuide.dox | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) (limited to 'doc/QuickStartGuide.dox') 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. - - - -
\b procedurale \b API \b natural \b API
Applies a translation\code -t.translate(Vector3(tx, ty, ...)); -t.pretranslate(Vector3(tx, ty, ...)); +
Translation\code +t.translate(Vector_(tx, ty, ...)); + +t.pretranslate(Vector_(tx, ty, ...)); \endcode\code -t *= Translation(tx, ty, ...); -t = Translation(tx, ty, ...) * t; +t *= Translation_(tx, ty, ...); +t2 = t1 * Translation_(vec); +t = Translation_(tx, ty, ...) * t; \endcode
Applies a rotation \n In 2D, any_rotation can also be \n an angle in radian\code +
Rotation \n In 2D, any_rotation can also \n be an angle in radian\code t.rotate(any_rotation); + t.prerotate(any_rotation); \endcode\code t *= any_rotation; +t2 = t1 * any_rotation; t = any_rotation * t; \endcode
Applies a scaling\code -t.scale(Vector(sx, sy, ...)); -t.scale(Vector::Constant(s)); -t.prescale(Vector3f(sx, sy, ...)); +
Scaling\code +t.scale(Vector_(sx, sy, ...)); + +t.scale(s); +t.prescale(Vector_(sx, sy, ...)); +t.prescale(s); \endcode\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
Applies a shear transformation \n ( \b 2D \b only ! )\code +
Shear transformation \n ( \b 2D \b only ! )\code t.shear(sx,sy); t.preshear(sx,sy); \endcode
-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:
\code t.pretranslate(..).rotate(..).translate(..).scale(..); \endcode
\code -t = Translation(..) * t * RotationType(..) * Translation(..) * Scaling(..); +t = Translation_(..) * t * RotationType(..) * Translation_(..) * Scaling_(..); \endcode
-- cgit v1.2.3