diff options
author | Gael Guennebaud <g.gael@free.fr> | 2009-07-06 09:17:25 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2009-07-06 09:17:25 +0200 |
commit | ecc4f07af51f84959b8930c633f6e447a1d316f5 (patch) | |
tree | db9f85cd1136be9f04e35555d375e568503f85b5 /Eigen | |
parent | c6f610093bff10c5a6e4fac94bfed422ba54b39a (diff) |
fix doc of Quaternion::setFromTwoVectors
Diffstat (limited to 'Eigen')
-rw-r--r-- | Eigen/src/Geometry/Quaternion.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Eigen/src/Geometry/Quaternion.h b/Eigen/src/Geometry/Quaternion.h index d7480bf9c..f2ebece9a 100644 --- a/Eigen/src/Geometry/Quaternion.h +++ b/Eigen/src/Geometry/Quaternion.h @@ -342,11 +342,15 @@ Quaternion<Scalar>::toRotationMatrix(void) const return res; } -/** Sets *this to be a quaternion representing a rotation sending the vector \a a to the vector \a b. +/** Sets \c *this to be a quaternion representing a rotation between + * the two arbitrary vectors \a a and \a b. In other words, the built + * rotation represent a rotation sending the line of direction \a a + * to the line of direction \a b, both lines passing through the origin. * - * \returns a reference to *this. + * \returns a reference to \c *this. * - * Note that the two input vectors do \b not have to be normalized. + * Note that the two input vectors do \b not have to be normalized, and + * do not need to have the same norm. */ template<typename Scalar> template<typename Derived1, typename Derived2> |