mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
Added an automatically generated list of selected examples in the documentation.
Added the custom gemetry_module tag, and use it.
This commit is contained in:
@@ -25,9 +25,11 @@
|
||||
#ifndef EIGEN_ANGLEAXIS_H
|
||||
#define EIGEN_ANGLEAXIS_H
|
||||
|
||||
/** \class AngleAxis
|
||||
/** \geometry_module \ingroup Geometry
|
||||
*
|
||||
* \brief Represents a rotation in a 3 dimensional space as a rotation angle around a 3D axis
|
||||
* \class AngleAxis
|
||||
*
|
||||
* \brief Represents a 3D rotation as a rotation angle around an arbitray 3D axis
|
||||
*
|
||||
* \param _Scalar the scalar type, i.e., the type of the coefficients.
|
||||
*
|
||||
@@ -35,7 +37,7 @@
|
||||
* \li \c AngleAxisf for \c float
|
||||
* \li \c AngleAxisd for \c double
|
||||
*
|
||||
* \sa class Quaternion, class EulerAngles, class Transform
|
||||
* \sa class Quaternion, class Transform
|
||||
*/
|
||||
template<typename _Scalar>
|
||||
class AngleAxis
|
||||
|
||||
@@ -25,7 +25,8 @@
|
||||
#ifndef EIGEN_CROSS_H
|
||||
#define EIGEN_CROSS_H
|
||||
|
||||
/** \returns the cross product of \c *this and \a other */
|
||||
/** \geometry_module
|
||||
* \returns the cross product of \c *this and \a other */
|
||||
template<typename Derived>
|
||||
template<typename OtherDerived>
|
||||
inline typename ei_eval<Derived>::type
|
||||
|
||||
@@ -30,7 +30,9 @@ template<typename Other,
|
||||
int OtherCols=Other::ColsAtCompileTime>
|
||||
struct ei_quaternion_assign_impl;
|
||||
|
||||
/** \class Quaternion
|
||||
/** \geometry_module \ingroup Geometry
|
||||
*
|
||||
* \class Quaternion
|
||||
*
|
||||
* \brief The quaternion class used to represent 3D orientations and rotations
|
||||
*
|
||||
@@ -48,7 +50,7 @@ struct ei_quaternion_assign_impl;
|
||||
* \li \c Quaternionf for \c float
|
||||
* \li \c Quaterniond for \c double
|
||||
*
|
||||
* \sa class AngleAxis, class EulerAngles, class Transform
|
||||
* \sa class AngleAxis, class Transform
|
||||
*/
|
||||
template<typename _Scalar>
|
||||
class Quaternion
|
||||
|
||||
@@ -28,7 +28,9 @@
|
||||
// this file aims to contains the various representations of rotation/orientation
|
||||
// in 2D and 3D space excepted Matrix and Quaternion.
|
||||
|
||||
/** \class ToRotationMatrix
|
||||
/** \geometry_module
|
||||
*
|
||||
* \class ToRotationMatrix
|
||||
*
|
||||
* \brief Template static struct to convert any rotation representation to a matrix form
|
||||
*
|
||||
@@ -101,7 +103,9 @@ struct ToRotationMatrix<Scalar, Dim, MatrixBase<OtherDerived> >
|
||||
}
|
||||
};
|
||||
|
||||
/** \class Rotation2D
|
||||
/** \geometry_module
|
||||
*
|
||||
* \class Rotation2D
|
||||
*
|
||||
* \brief Represents a rotation/orientation in a 2 dimensional space.
|
||||
*
|
||||
|
||||
@@ -35,7 +35,9 @@ template< typename Other,
|
||||
int OtherCols=Other::ColsAtCompileTime>
|
||||
struct ei_transform_product_impl;
|
||||
|
||||
/** \class Transform
|
||||
/** \geometry_module \ingroup Geometry
|
||||
*
|
||||
* \class Transform
|
||||
*
|
||||
* \brief Represents an homogeneous transformation in a N dimensional space
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user