GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-04 19:20:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

bug #1123: add missing documentation of angle() and axis()

Browse Source 
(grafted from c5b86893e7cca7d870b928ad8cc109ccc131b456
)
This commit is contained in:
Gael Guennebaud 2015-12-01 14:45:08 +01:00
parent 0d807dce07
commit 092681132c
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Eigen/src/Geometry/AngleAxis.h
View File

@ -83,10 +83,17 @@ public:
template<typename Derived> template<typename Derived>
inline explicit AngleAxis(const MatrixBase<Derived>& m) { *this = m; } inline explicit AngleAxis(const MatrixBase<Derived>& m) { *this = m; }
/** \returns the value of the rotation angle in radian */
Scalar angle() const { return m_angle; } Scalar angle() const { return m_angle; }
/** \returns a read-write reference to the stored angle in radian */
Scalar& angle() { return m_angle; } Scalar& angle() { return m_angle; }
/** \returns the rotation axis */
const Vector3& axis() const { return m_axis; } const Vector3& axis() const { return m_axis; }
/** \returns a read-write reference to the stored rotation axis.
*
* \warning The rotation axis must remain a \b unit vector.
*/
Vector3& axis() { return m_axis; } Vector3& axis() { return m_axis; }
/** Concatenates two rotations */ /** Concatenates two rotations */