aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Geometry/AngleAxis.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2015-12-01 14:45:08 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2015-12-01 14:45:08 +0100
commitc5b86893e7cca7d870b928ad8cc109ccc131b456 (patch)
tree97d12531cbc1f8e5149478123f5daa7b264dba6d /Eigen/src/Geometry/AngleAxis.h
parent0bb12fa61437e55ce563d076938593bebff7f0fc (diff)
bug #1123: add missing documentation of angle() and axis()
Diffstat (limited to 'Eigen/src/Geometry/AngleAxis.h')
-rw-r--r--Eigen/src/Geometry/AngleAxis.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/Eigen/src/Geometry/AngleAxis.h b/Eigen/src/Geometry/AngleAxis.h
index a5484ba77..7fdb8ae83 100644
--- a/Eigen/src/Geometry/AngleAxis.h
+++ b/Eigen/src/Geometry/AngleAxis.h
@@ -85,10 +85,17 @@ public:
template<typename Derived>
inline explicit AngleAxis(const MatrixBase<Derived>& m) { *this = m; }
+ /** \returns the value of the rotation angle in radian */
Scalar angle() const { return m_angle; }
+ /** \returns a read-write reference to the stored angle in radian */
Scalar& angle() { return m_angle; }
+ /** \returns the rotation 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; }
/** Concatenates two rotations */